org.hippoecm.hst.configuration.model

Interface HstManager

public interface HstManager

Method Summary

Modifier and Type	Method and Description
String	getContextPath()
String[]	getHstFilterPrefixExclusions()
String[]	getHstFilterSuffixExclusions()
String	getPathSuffixDelimiter() Returns the request path suffix delimiter.
HstSiteMapMatcher	getSiteMapMatcher() a HstSitesManager must contain a reference to the HstSiteMapMatcher that is being used.
VirtualHosts	getVirtualHosts()
boolean	isHstFilterExcludedPath(String pathInfo) Deprecated. since 13.0.0 : use VirtualHosts.isHstFilterExcludedPath(String)

Method Detail

getVirtualHosts

VirtualHosts getVirtualHosts()
                      throws ContainerException

Returns:

the VirtualHosts, aka the HST model.

Throws:

ContainerException

getSiteMapMatcher

HstSiteMapMatcher getSiteMapMatcher()

a HstSitesManager must contain a reference to the HstSiteMapMatcher that is being used. You can inject your own HstSiteMapMatcher implementation if needed

Returns:

the global HstSiteMapMatcher implementation used for all the hosts & sites

isHstFilterExcludedPath

@Deprecated
boolean isHstFilterExcludedPath(String pathInfo)

Deprecated. since 13.0.0 : use VirtualHosts.isHstFilterExcludedPath(String)

Some paths should not be handled by the hst framework request processing, eg /ping/ When a path must be excluded, this method return true.

Parameters:

pathInfo -

Returns:

true when the path must be excluded for matching to a host.

getPathSuffixDelimiter

String getPathSuffixDelimiter()

Returns the request path suffix delimiter. c

getHstFilterPrefixExclusions

String[] getHstFilterPrefixExclusions()

getHstFilterSuffixExclusions

String[] getHstFilterSuffixExclusions()

getContextPath

String getContextPath()

Returns:

the contextPath of the current webapp