org.springframework.web.filter

Class ForwardedHeaderFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.web.filter.ForwardedHeaderFilter

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, ServletContextAware

public class ForwardedHeaderFilter
extends OncePerRequestFilter

Filter that wraps the request and response in order to override its getServerName(), getServerPort(), getScheme(), isSecure(), sendRedirect(String), methods with values derived from "Forwarded" or "X-Forwarded-*" headers. In effect the wrapped request and response reflects the client-originated protocol and address.

Since:

4.3

Author:

Rossen Stoyanchev, Eddú Meléndez, Rob Winch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ForwardedHeaderFilter.ForwardedHeaderRequestWrapper
private static class	ForwardedHeaderFilter.ForwardedHeaderResponseWrapper

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Set<java.lang.String>	FORWARDED_HEADER_NAMES
private UrlPathHelper	pathHelper

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 and Description
ForwardedHeaderFilter()

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread.
protected boolean	shouldNotFilter(HttpServletRequest request) Can be overridden in subclasses for custom filtering control, returning true to avoid filtering of the given request.
protected boolean	shouldNotFilterAsyncDispatch() 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.
protected boolean	shouldNotFilterErrorDispatch() Whether to filter error dispatches such as when the servlet container processes and error mapped in web.xml.

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

doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted

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

addRequiredProperty, afterPropertiesSet, destroy, 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 Detail

FORWARDED_HEADER_NAMES

private static final java.util.Set<java.lang.String> FORWARDED_HEADER_NAMES

pathHelper

private final UrlPathHelper pathHelper

Constructor Detail

ForwardedHeaderFilter

public ForwardedHeaderFilter()

Method Detail

shouldNotFilter

protected boolean shouldNotFilter(HttpServletRequest request)
                           throws ServletException

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

Throws:

ServletException - in case of errors

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

doFilterInternal

protected void doFilterInternal(HttpServletRequest request,
                                HttpServletResponse response,
                                FilterChain filterChain)
                         throws ServletException,
                                java.io.IOException

Description copied from class: OncePerRequestFilter

Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread. See OncePerRequestFilter.shouldNotFilterAsyncDispatch() for details.

Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.

Specified by:

doFilterInternal in class OncePerRequestFilter

Throws:

ServletException

java.io.IOException