Package org.hippoecm.hst.core.sitemapitemhandler

Class AbstractFilterChainAwareHstSiteMapItemHandler

java.lang.Object

org.hippoecm.hst.core.sitemapitemhandler.AbstractHstSiteMapItemHandler

org.hippoecm.hst.core.sitemapitemhandler.AbstractFilterChainAwareHstSiteMapItemHandler

All Implemented Interfaces:

FilterChainAwareHstSiteMapItemHandler, HstSiteMapItemHandler

public abstract class AbstractFilterChainAwareHstSiteMapItemHandler
extends AbstractHstSiteMapItemHandler
implements FilterChainAwareHstSiteMapItemHandler

AbstractFilterChainAwareHstSiteMapItemHandler

Constructor Summary

Constructors

Constructor	Description
AbstractFilterChainAwareHstSiteMapItemHandler()

Method Summary

Modifier and Type	Method	Description
ResolvedSiteMapItem	process(ResolvedSiteMapItem resolvedSiteMapItem, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Does custom request processing.
abstract ResolvedSiteMapItem	process(ResolvedSiteMapItem resolvedSiteMapItem, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)	Does custom request processing.

Methods inherited from class org.hippoecm.hst.core.sitemapitemhandler.AbstractHstSiteMapItemHandler

destroy, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hippoecm.hst.core.sitemapitemhandler.HstSiteMapItemHandler

destroy, init

Constructor Details

AbstractFilterChainAwareHstSiteMapItemHandler

public AbstractFilterChainAwareHstSiteMapItemHandler()

Method Details

process

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

Description copied from interface: FilterChainAwareHstSiteMapItemHandler

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.

This method also receives FilterChain instance so it can short circuit HST request processing and continue processing next Filters by invoking filterChain.doFilter(..). If you invoke filterChain.doFilter(..) you must return null from FilterChainAwareHstSiteMapItemHandler.process(org.hippoecm.hst.core.request.ResolvedSiteMapItem, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.FilterChain) because the HST rendering must be short-circuited

Specified by:

process in interface FilterChainAwareHstSiteMapItemHandler

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

process

public 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 interface HstSiteMapItemHandler

Specified by:

process in class AbstractHstSiteMapItemHandler

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