public class ForwardedHeaderFilter extends OncePerRequestFilter
This filter can also be used in a removeOnly mode
where "Forwarded" and "X-Forwarded-*" headers are eliminated, and not used.
ALREADY_FILTERED_SUFFIXlogger| Constructor and Description |
|---|
ForwardedHeaderFilter() |
| 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 void |
doFilterNestedErrorDispatch(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain)
Typically an ERROR dispatch happens after the REQUEST dispatch completes,
and the filter chain starts anew.
|
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. |
void |
setRemoveOnly(boolean removeOnly)
Enables mode in which any "Forwarded" or "X-Forwarded-*" headers are
removed only and the information in them ignored.
|
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. |
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStartedaddRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContextpublic void setRemoveOnly(boolean removeOnly)
removeOnly - whether to discard and ignore forwarded headerspublic void setRelativeRedirects(boolean relativeRedirects)
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.
relativeRedirects - whether to use relative redirectsprotected boolean shouldNotFilter(HttpServletRequest request)
OncePerRequestFiltertrue to avoid filtering of the given request.
The default implementation always returns false.
shouldNotFilter in class OncePerRequestFilterrequest - current HTTP requestprotected boolean shouldNotFilterAsyncDispatch()
OncePerRequestFilterjavax.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.
shouldNotFilterAsyncDispatch in class OncePerRequestFilterprotected boolean shouldNotFilterErrorDispatch()
OncePerRequestFilterweb.xml. The default return value
is "true", which means the filter will not be invoked in case of an error
dispatch.shouldNotFilterErrorDispatch in class OncePerRequestFilterprotected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
OncePerRequestFilterdoFilter, 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.
doFilterInternal in class OncePerRequestFilterServletExceptionIOExceptionprotected void doFilterNestedErrorDispatch(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
OncePerRequestFiltersendError on the response. In that case we are still in
the filter chain, on the same thread, but the request and response have
been switched to the original, unwrapped ones.
Sub-classes may use this method to filter such nested ERROR dispatches
and re-apply wrapping on the request or response. ThreadLocal
context, if any, should still be active as we are still nested within
the filter chain.
doFilterNestedErrorDispatch in class OncePerRequestFilterServletExceptionIOException