org.broadleafcommerce.common.web.filter

Class AbstractIgnorableOncePerRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

BroadleafRequestFilter, BroadleafThemeResolverFilter, CachingCompressedResponseFilter

public abstract class AbstractIgnorableOncePerRequestFilter
extends org.springframework.web.filter.OncePerRequestFilter
implements org.springframework.core.Ordered

Provides common logic for OncePerRequestFilter implementations to allow for ignoring behavior based on the presence (or absence) of a request param. Sublclasses should implement doFilterInternalUnlessIgnored(HttpServletRequest, HttpServletResponse, FilterChain), knowing that this method will faithfully be called unless the logic here determines the filter should pass the request through without processing.

Author:

Jeff Fischer

See Also:

SecurityBasedIgnoreFilter

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractIgnorableOncePerRequestFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilterInternal(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, javax.servlet.FilterChain filterChain)
protected abstract void	doFilterInternalUnlessIgnored(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
protected boolean	isIgnored(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Detail

AbstractIgnorableOncePerRequestFilter

public AbstractIgnorableOncePerRequestFilter()

Method Detail

doFilterInternal

public void doFilterInternal(javax.servlet.http.HttpServletRequest httpServletRequest,
                             javax.servlet.http.HttpServletResponse httpServletResponse,
                             javax.servlet.FilterChain filterChain)
                      throws javax.servlet.ServletException,
                             IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

IOException

isIgnored

protected boolean isIgnored(javax.servlet.http.HttpServletRequest httpServletRequest,
                            javax.servlet.http.HttpServletResponse httpServletResponse)

doFilterInternalUnlessIgnored

protected abstract void doFilterInternalUnlessIgnored(javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response,
                                                      javax.servlet.FilterChain chain)
                                               throws IOException,
                                                      javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException