Package org.craftercms.commons.web

Class CloudfrontForwardedHeaderFilter

java.lang.Object
org.springframework.web.filter.GenericFilterBean
org.springframework.web.filter.OncePerRequestFilter
org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
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.web.context.ServletContextAware
public class CloudfrontForwardedHeaderFilter extends org.springframework.web.filter.OncePerRequestFilter
Filter to provide support for AWS Cloudfront specific request headers. This class will copy the value of the headers using the standard name to integrate with all Spring classes.
Since:
3.1.9
Author:
joseross

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLOUDFRONT_PROTO_HEADER_NAME
     
    protected boolean
    enabled
     
    static final String
    STANDARD_PROTO_HEADER_NAME
     

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

    ALREADY_FILTERED_SUFFIX

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

    logger

  • Constructor Summary

    Constructors
    Constructor
    Description
    CloudfrontForwardedHeaderFilter(boolean enabled)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
     
    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

  • Field Details

    • CLOUDFRONT_PROTO_HEADER_NAME

      public static final String CLOUDFRONT_PROTO_HEADER_NAME
      See Also:

    • STANDARD_PROTO_HEADER_NAME

      public static final String STANDARD_PROTO_HEADER_NAME
      See Also:

    • enabled

      protected boolean enabled

  • Constructor Details

    • CloudfrontForwardedHeaderFilter

      @ConstructorProperties("enabled") public CloudfrontForwardedHeaderFilter(boolean enabled)

  • Method Details

    • shouldNotFilter

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

    • doFilterInternal

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