org.hippoecm.hst.configuration.model

Interface HstManager

public interface HstManager

Method Summary

Modifier and Type	Method and Description
String	getContextPath()
List<HstConfigurationAugmenter>	getHstConfigurationAugmenters()
String	getPathSuffixDelimiter() Returns the request path suffix delimiter.
HstSiteMapItemHandlerFactory	getSiteMapItemHandlerFactory() Deprecated. Since CMS 10.0, HST 2.30.00. No use case any more. If required, the HstSiteMapItemHandlerFactory can be fetched through the HST Spring Component Manager
HstSiteMapMatcher	getSiteMapMatcher() a HstSitesManager must contain a reference to the HstSiteMapMatcher that is being used.
HstURLFactory	getUrlFactory() Deprecated. Since CMS 10.0, HST 2.30.00. No use case any more. If required, the HstSiteMapItemHandlerFactory can be fetched through the HST Spring Component Manager
VirtualHosts	getVirtualHosts()
VirtualHosts	getVirtualHosts(boolean allowStale) When allowStale is true a stale VirtualHosts might be returned.
boolean	isExcludedByHstFilterInitParameter(String pathInfo) Deprecated. since CMS 10.0, HST 2.30.00. Use isHstFilterExcludedPath(String) instead
boolean	isHstFilterExcludedPath(String pathInfo) Some paths should not be handled by the hst framework request processing, eg /ping/ When a path must be excluded, this method return true.
void	markStale() marks that the hst model is dirty

Method Detail

getVirtualHosts

VirtualHosts getVirtualHosts()
                      throws ContainerException

Returns:

the VirtualHosts, aka the HST model.

Throws:

ContainerException

getVirtualHosts

VirtualHosts getVirtualHosts(boolean allowStale)
                      throws ContainerException

When allowStale is true a stale VirtualHosts might be returned. This might be favoured over getVirtualHosts() when the model is very large and thus might take longer to reload.

Returns:

the VirtualHosts object and possibly a stale version of it when allowStale is true

Throws:

ContainerException

getUrlFactory

@Deprecated
HstURLFactory getUrlFactory()

Deprecated. Since CMS 10.0, HST 2.30.00. No use case any more. If required, the HstSiteMapItemHandlerFactory can be fetched through the HST Spring Component Manager

Returns:

the HstURLFactory

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

getSiteMapItemHandlerFactory

@Deprecated
HstSiteMapItemHandlerFactory getSiteMapItemHandlerFactory()

Deprecated. Since CMS 10.0, HST 2.30.00. No use case any more. If required, the HstSiteMapItemHandlerFactory can be fetched through the HST Spring Component Manager

Returns:

the siteMapItemHandler factory which can create HstSiteMapItemHandler instances

isExcludedByHstFilterInitParameter

@Deprecated
boolean isExcludedByHstFilterInitParameter(String pathInfo)

Deprecated. since CMS 10.0, HST 2.30.00. Use isHstFilterExcludedPath(String) instead

isHstFilterExcludedPath

boolean isHstFilterExcludedPath(String pathInfo)

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

getContextPath

String getContextPath()

Returns:

the contextPath of the current webapp

getHstConfigurationAugmenters

List<HstConfigurationAugmenter> getHstConfigurationAugmenters()

Returns:

the List of HstConfigurationAugmenters and empty list if no providers available.

markStale

void markStale()

marks that the hst model is dirty