Package org.broadleafcommerce.common.web.filter

Class AbstractIgnorableFilter

java.lang.Object
org.springframework.web.filter.GenericFilterBean
org.broadleafcommerce.common.web.filter.AbstractIgnorableFilter
All Implemented Interfaces:
jakarta.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:

  • 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
    Description
    AbstractIgnorableFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
     
    abstract void
    doFilterUnlessIgnored(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
     
    protected boolean
    isIgnored(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.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 Details

    • AbstractIgnorableFilter

      public AbstractIgnorableFilter()

  • Method Details

    • doFilter

      public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException
      Specified by:
      doFilter in interface jakarta.servlet.Filter
      Throws:
      IOException
      jakarta.servlet.ServletException

    • isIgnored

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

    • doFilterUnlessIgnored

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