org.hippoecm.hst.core.sitemapitemhandler

Class AbstractHstSiteMapItemHandler

java.lang.Object

org.hippoecm.hst.core.sitemapitemhandler.AbstractHstSiteMapItemHandler

All Implemented Interfaces:

HstSiteMapItemHandler

Direct Known Subclasses:

AbstractFilterChainAwareHstSiteMapItemHandler

public abstract class AbstractHstSiteMapItemHandler
extends Object
implements HstSiteMapItemHandler

AbstractHstSiteMapItemHandler

Constructor Summary

Constructors

Constructor and Description
AbstractHstSiteMapItemHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Allows the sitemap handler to destroy itself
protected SiteMapItemHandlerConfiguration	getHandlerConfig()
protected javax.servlet.ServletContext	getHandlerServletContext()
javax.servlet.ServletContext	getServletContext() Deprecated.
SiteMapItemHandlerConfiguration	getSiteMapItemHandlerConfiguration() Deprecated.
void	init(javax.servlet.ServletContext servletContext, SiteMapItemHandlerConfiguration handlerConfig) Allows the HstSiteMapItemHandler to initialize itself
abstract ResolvedSiteMapItem	process(ResolvedSiteMapItem resolvedSiteMapItem, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Does custom request processing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractHstSiteMapItemHandler

public AbstractHstSiteMapItemHandler()

Method Detail

init

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

Description copied from interface: HstSiteMapItemHandler

Allows the HstSiteMapItemHandler to initialize itself

Specified by:

init in interface HstSiteMapItemHandler

Parameters:

servletContext - the servletContext of the HST container servlet

handlerConfig - the componentConfigBean configuration

Throws:

HstSiteMapItemHandlerException

process

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

Description copied from interface: HstSiteMapItemHandler

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.

Specified by:

process in interface HstSiteMapItemHandler

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

destroy

public void destroy()
             throws HstSiteMapItemHandlerException

Description copied from interface: HstSiteMapItemHandler

Allows the sitemap handler to destroy itself

Specified by:

destroy in interface HstSiteMapItemHandler

Throws:

HstSiteMapItemHandlerException

getHandlerConfig

protected SiteMapItemHandlerConfiguration getHandlerConfig()

getHandlerServletContext

protected javax.servlet.ServletContext getHandlerServletContext()

getSiteMapItemHandlerConfiguration

@Deprecated
public SiteMapItemHandlerConfiguration getSiteMapItemHandlerConfiguration()

Deprecated.

Description copied from interface: HstSiteMapItemHandler

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

Specified by:

getSiteMapItemHandlerConfiguration in interface HstSiteMapItemHandler

Returns:

the SiteMapItemHandlerConfiguration backing this HstSiteMapItemHandler

getServletContext

@Deprecated
public javax.servlet.ServletContext getServletContext()

Deprecated.

Specified by:

getServletContext in interface HstSiteMapItemHandler

Returns:

Retrieves the servletContext to which this HstSiteMapItemHandler is bound