org.springframework.web.filter

Class ForwardedHeaderFilter

    • Constructor Detail

      • ForwardedHeaderFilter

        public ForwardedHeaderFilter()
    • Method Detail

      • setRemoveOnly

        public void setRemoveOnly(boolean removeOnly)
        Enables mode in which any "Forwarded" or "X-Forwarded-*" headers are removed only and the information in them ignored.
        Parameters:
        removeOnly - whether to discard and ignore forwarded headers
        Since:
        4.3.9
      • setRelativeRedirects

        public void setRelativeRedirects(boolean relativeRedirects)
        Use this property to enable relative redirects as explained in RelativeRedirectFilter, and also using the same response wrapper as that filter does, or if both are configured, only one will wrap.

        By default, if this property is set to false, in which case calls to HttpServletResponse.sendRedirect(String) are overridden in order to turn relative into absolute URLs, also taking into account forwarded headers.

        Parameters:
        relativeRedirects - whether to use relative redirects
        Since:
        4.3.10
      • shouldNotFilter

        protected boolean shouldNotFilter(HttpServletRequest request)
        Description copied from class: OncePerRequestFilter
        Can be overridden in subclasses for custom filtering control, returning true to avoid filtering of the given request.

        The default implementation always returns false.

        Overrides:
        shouldNotFilter in class OncePerRequestFilter
        Parameters:
        request - current HTTP request
        Returns:
        whether the given request should not be filtered
      • shouldNotFilterAsyncDispatch

        protected boolean shouldNotFilterAsyncDispatch()
        Description copied from class: OncePerRequestFilter
        The dispatcher type javax.servlet.DispatcherType.ASYNC introduced in Servlet 3.0 means a filter can be invoked in more than one thread over the course of a single request. Some filters only need to filter the initial thread (e.g. request wrapping) while others may need to be invoked at least once in each additional thread for example for setting up thread locals or to perform final processing at the very end.

        Note that although a filter can be mapped to handle specific dispatcher types via web.xml or in Java through the ServletContext, servlet containers may enforce different defaults with regards to dispatcher types. This flag enforces the design intent of the filter.

        The default return value is "true", which means the filter will not be invoked during subsequent async dispatches. If "false", the filter will be invoked during async dispatches with the same guarantees of being invoked only once during a request within a single thread.

        Overrides:
        shouldNotFilterAsyncDispatch in class OncePerRequestFilter
      • shouldNotFilterErrorDispatch

        protected boolean shouldNotFilterErrorDispatch()
        Description copied from class: OncePerRequestFilter
        Whether to filter error dispatches such as when the servlet container processes and error mapped in web.xml. The default return value is "true", which means the filter will not be invoked in case of an error dispatch.
        Overrides:
        shouldNotFilterErrorDispatch in class OncePerRequestFilter