org.hippoecm.hst.core.sitemapitemhandler
Interface HstSiteMapItemHandler

All Known Implementing Classes:

AbstractHstSiteMapHandler

public interface HstSiteMapItemHandler

TODO A HstSiteMapItemHandler can be invoked by ....

Method Summary

void	destroy() Allows the sitemap handler to destroy itself
javax.servlet.ServletContext	getServletContext()
SiteMapItemHandlerConfiguration	getSiteMapItemHandlerConfiguration() Through the SiteMapItemHandlerConfiguration all (resolved) configuration properties can be accessed.
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)

Method Detail

init

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

Allows the HstSiteMapItemHandler to initialize itself

Parameters:

servletConfig - the servletConfig 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

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

SiteMapItemHandlerConfiguration getSiteMapItemHandlerConfiguration()

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

Returns:

the SiteMapItemHandlerConfiguration backing this HstSiteMapItemHandler

getServletContext

javax.servlet.ServletContext getServletContext()

Returns:

Retrieves the servletContext to which this HstSiteMapItemHandler is bound

destroy

void destroy()
             throws HstSiteMapItemHandlerException

Allows the sitemap handler to destroy itself

Throws:

HstSiteMapItemHandlerException