Package com.giffing.bucket4j.spring.boot.starter.servlet

Class ServletRequestFilter

java.lang.Object
org.springframework.web.filter.GenericFilterBean
org.springframework.web.filter.OncePerRequestFilter
com.giffing.bucket4j.spring.boot.starter.servlet.ServletRequestFilter
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
public class ServletRequestFilter
extends org.springframework.web.filter.OncePerRequestFilter
implements org.springframework.core.Ordered
Servlet Filter class to configure Bucket4j on each request.

  • 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 Description
    ServletRequestFilter​(com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration<javax.servlet.http.HttpServletRequest> filterConfig)  

  • Method Summary

    Modifier and Type Method Description
    protected void doFilterInternal​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)  
    int getOrder()  
    protected boolean shouldNotFilter​(javax.servlet.http.HttpServletRequest request)  

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

    doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, 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

  • Constructor Details

    • ServletRequestFilter

      public ServletRequestFilter​(com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration<javax.servlet.http.HttpServletRequest> filterConfig)

  • Method Details

    • shouldNotFilter

      protected boolean shouldNotFilter​(javax.servlet.http.HttpServletRequest request) throws javax.servlet.ServletException
      Overrides:
      shouldNotFilter in class org.springframework.web.filter.OncePerRequestFilter
      Throws:
      javax.servlet.ServletException

    • doFilterInternal

      protected void doFilterInternal​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain) throws javax.servlet.ServletException, java.io.IOException
      Specified by:
      doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter
      Throws:
      javax.servlet.ServletException
      java.io.IOException

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface org.springframework.core.Ordered