Class AbstractHstSiteMapItemHandler
java.lang.Object
org.hippoecm.hst.core.sitemapitemhandler.AbstractHstSiteMapItemHandler
- All Implemented Interfaces:
HstSiteMapItemHandler
- Direct Known Subclasses:
AbstractFilterChainAwareHstSiteMapItemHandler
AbstractHstSiteMapItemHandler
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Allows the sitemap handler to destroy itselfvoid
init
(jakarta.servlet.ServletContext servletContext, SiteMapItemHandlerConfiguration handlerConfig) Allows the HstSiteMapItemHandler to initialize itselfabstract ResolvedSiteMapItem
process
(ResolvedSiteMapItem resolvedSiteMapItem, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Does custom request processing.
-
Constructor Details
-
AbstractHstSiteMapItemHandler
public AbstractHstSiteMapItemHandler()
-
-
Method Details
-
init
public void init(jakarta.servlet.ServletContext servletContext, SiteMapItemHandlerConfiguration handlerConfig) throws HstSiteMapItemHandlerException Description copied from interface:HstSiteMapItemHandler
Allows the HstSiteMapItemHandler to initialize itself- Specified by:
init
in interfaceHstSiteMapItemHandler
- Parameters:
servletContext
- the servletContext of the HST container servlethandlerConfig
- the componentConfigBean configuration- Throws:
HstSiteMapItemHandlerException
-
process
public abstract ResolvedSiteMapItem process(ResolvedSiteMapItem resolvedSiteMapItem, jakarta.servlet.http.HttpServletRequest request, jakarta.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 interfaceHstSiteMapItemHandler
- Returns:
- a new or the original
ResolvedSiteMapItem
, ornull
when the handler did for example already write the entireresponse
and request processing can be stopped - Throws:
HstSiteMapItemHandlerException
-
destroy
Description copied from interface:HstSiteMapItemHandler
Allows the sitemap handler to destroy itself- Specified by:
destroy
in interfaceHstSiteMapItemHandler
- Throws:
HstSiteMapItemHandlerException
-