org.broadleafcommerce.common.web.filter

Class AbstractIgnorableFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.broadleafcommerce.common.web.filter.AbstractIgnorableFilter

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:

EstablishSessionFilter, StatelessSessionFilter, TranslationFilter

public abstract class AbstractIgnorableFilter
extends org.springframework.web.filter.GenericFilterBean
implements org.springframework.core.Ordered

Provides common logic for GenericFilterBean implementations to allow for ignoring behavior based on the presence (or absence) of a request param. Sublclasses should implement doFilterUnlessIgnored(ServletRequest, ServletResponse, 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.GenericFilterBean

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractIgnorableFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
abstract void	doFilterUnlessIgnored(javax.servlet.ServletRequest request, javax.servlet.ServletResponse 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.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

AbstractIgnorableFilter

public AbstractIgnorableFilter()

Method Detail

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

isIgnored

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

doFilterUnlessIgnored

public abstract void doFilterUnlessIgnored(javax.servlet.ServletRequest request,
                                           javax.servlet.ServletResponse response,
                                           javax.servlet.FilterChain chain)
                                    throws IOException,
                                           javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException