org.hippoecm.hst.core.sitemapitemhandler

Interface HstSiteMapItemHandler

All Known Subinterfaces:

FilterChainAwareHstSiteMapItemHandler

All Known Implementing Classes:

AbstractFilterChainAwareHstSiteMapItemHandler, AbstractHstSiteMapHandler, AbstractHstSiteMapItemHandler

public interface HstSiteMapItemHandler

A HstSiteMapItemHandler can be invoked by HstFilter when the resolved sitemap item is configured with custom sitemap item handler IDs in the HST configurations. HstSiteMapItemHandler is provided to enable custom request processing for the resolved sitemap item.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Allows the sitemap handler to destroy itself
javax.servlet.ServletContext	getServletContext() Deprecated. this method is deprecated since 2.25.02
SiteMapItemHandlerConfiguration	getSiteMapItemHandlerConfiguration() Deprecated. this method is deprecated since 2.25.02 as it should not be needed. The SiteMapItemHandlerConfiguration can be accessed by storing the SiteMapItemHandlerConfiguration during the init(javax.servlet.ServletContext, org.hippoecm.hst.core.request.SiteMapItemHandlerConfiguration)
void	init(javax.servlet.ServletContext servletContext, SiteMapItemHandlerConfiguration handlerConfig) Allows the HstSiteMapItemHandler to initialize itself
ResolvedSiteMapItem	process(ResolvedSiteMapItem resolvedSiteMapItem, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Does custom request processing.

Method Detail

init

void init(javax.servlet.ServletContext servletContext,
        SiteMapItemHandlerConfiguration handlerConfig)
          throws HstSiteMapItemHandlerException

Allows the HstSiteMapItemHandler to initialize itself

Parameters:

servletContext - the servletContext of the HST container servlet

handlerConfig - the componentConfigBean configuration

Throws:

HstSiteMapItemHandlerException

process

ResolvedSiteMapItem process(ResolvedSiteMapItem resolvedSiteMapItem,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                            throws HstSiteMapItemHandlerException

Does custom request processing.

This method can return the original resolvedSiteMapItem or a new resolved sitemap item to serve a different one. Or it can return null when it completes the custom request processing by itself so HstFilter needs to stop the request processing.

Parameters:

resolvedSiteMapItem -

request -

response -

Returns:

a new or the original ResolvedSiteMapItem, or null when the handler did for example already write the entire response and request processing can be stopped

Throws:

HstSiteMapItemHandlerException

getSiteMapItemHandlerConfiguration

@Deprecated
SiteMapItemHandlerConfiguration getSiteMapItemHandlerConfiguration()

Deprecated. this method is deprecated since 2.25.02 as it should not be needed. The SiteMapItemHandlerConfiguration can be accessed by storing the SiteMapItemHandlerConfiguration during the init(javax.servlet.ServletContext, org.hippoecm.hst.core.request.SiteMapItemHandlerConfiguration)

Through the SiteMapItemHandlerConfiguration all (resolved) configuration properties can be accessed.

Returns:

the SiteMapItemHandlerConfiguration backing this HstSiteMapItemHandler

getServletContext

@Deprecated
javax.servlet.ServletContext getServletContext()

Deprecated. this method is deprecated since 2.25.02

Returns:

Retrieves the servletContext to which this HstSiteMapItemHandler is bound

destroy

void destroy()
             throws HstSiteMapItemHandlerException

Allows the sitemap handler to destroy itself

Throws:

HstSiteMapItemHandlerException