org.hippoecm.hst.configuration.model

Interface HstManager

All Known Subinterfaces:

MutableHstManager

public interface HstManager

Method Summary

Methods

Modifier and Type	Method and Description
List<HstConfigurationAugmenter>	getHstConfigurationAugmenters()
String	getPathSuffixDelimiter() Returns the request path suffix delimiter.
HstSiteMapItemHandlerFactory	getSiteMapItemHandlerFactory()
HstSiteMapMatcher	getSiteMapMatcher() a HstSitesManager must contain a reference to the HstSiteMapMatcher that is being used.
HstURLFactory	getUrlFactory()
VirtualHosts	getVirtualHosts()
VirtualHosts	getVirtualHosts(boolean allowStale) When allowStale is true a stale VirtualHosts might be returned.
void	invalidate(javax.jcr.observation.EventIterator events) Invalidates this HstSitesManager with EventIterator events.
void	invalidate(String... absEventPaths) Invalidates this HstSitesManager with all the varargs absEventPaths.
void	invalidateAll() Invalidates this HstSitesManager completely.
void	invalidatePendingHstConfigChanges(javax.jcr.Session session) Deprecated. deprecated since 7.8.4. Use invalidate(String...) instead
boolean	isExcludedByHstFilterInitParameter(String pathInfo) Typically, some paths we do not want to be handle by the hst framework request processing.
boolean	isFineGrainedLocking() Deprecated. temporary method on in the 7.8.x range. Will be removed in 7.9.x

Method Detail

getVirtualHosts

VirtualHosts getVirtualHosts()
                             throws ContainerException

Returns:

the VirtualHosts

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

HstURLFactory getUrlFactory()

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

HstSiteMapItemHandlerFactory getSiteMapItemHandlerFactory()

Returns:

the siteMapItemHandler factory which can create HstSiteMapItemHandler instances

invalidate

void invalidate(javax.jcr.observation.EventIterator events)

Invalidates this HstSitesManager with EventIterator events. Typically this invalidate is called after a received event indicating that for example the backing hosts configuration has been changed.

Parameters:

events -

invalidatePendingHstConfigChanges

@Deprecated
void invalidatePendingHstConfigChanges(javax.jcr.Session session)

Deprecated. deprecated since 7.8.4. Use invalidate(String...) instead

Invalidate the HstManager for all pending hst config of this JCR Session directly. This is very useful when the changes must be reflected directly upon next reload. The invalidate(javax.jcr.observation.EventIterator) is asynchronous by jcr event listeners.

Parameters:

session - the jcr Session to fire the events for

invalidate

void invalidate(String... absEventPaths)

Invalidates this HstSitesManager with all the varargs absEventPaths. This is useful in cases where you directly want to invalidate the hst model and cannot wait for asynchronous jcr events to be dispatched.

Parameters:

absEventPaths - the varargs abs paths of the event that should be invalidated

invalidateAll

void invalidateAll()

Invalidates this HstSitesManager completely. For example useful after a repository reconnection where you do not know whether some events might have been missed

isExcludedByHstFilterInitParameter

boolean isExcludedByHstFilterInitParameter(String pathInfo)

Typically, some paths we do not want to be handle by the hst framework request processing. Typically, this would be for example paths starting with /binaries/, or paths ending with some extension, like .pdf 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.

Returns:

getHstConfigurationAugmenters

List<HstConfigurationAugmenter> getHstConfigurationAugmenters()

Returns:

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

isFineGrainedLocking

@Deprecated
boolean isFineGrainedLocking()

Deprecated. temporary method on in the 7.8.x range. Will be removed in 7.9.x