Class RequestContextFilter
- All Implemented Interfaces:
Filter,Aware,BeanNameAware,DisposableBean,InitializingBean,EnvironmentAware,EnvironmentCapable,ServletContextAware
LocaleContextHolder and
RequestContextHolder. To be registered as filter in web.xml.
Alternatively, Spring's RequestContextListener
and Spring's DispatcherServlet also expose
the same request context to the current thread.
This filter is mainly for use with third-party servlets, e.g. the JSF FacesServlet. Within Spring's own web support, DispatcherServlet's processing is perfectly sufficient.
- Since:
- 2.0
- Author:
- Juergen Hoeller, Rod Johnson, Rossen Stoyanchev
- See Also:
-
Field Summary
Fields inherited from class org.springframework.web.filter.OncePerRequestFilter
ALREADY_FILTERED_SUFFIXFields inherited from class org.springframework.web.filter.GenericFilterBean
logger -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddoFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) Same contract as fordoFilter, but guaranteed to be just invoked once per request within a single request thread.voidsetThreadContextInheritable(boolean threadContextInheritable) Set whether to expose the LocaleContext and RequestAttributes as inheritable for child threads (using anInheritableThreadLocal).protected booleanReturns "false" so that the filter may set up the request context in each asynchronously dispatched thread.protected booleanReturns "false" so that the filter may set up the request context in an error dispatch.Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilterMethods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
-
Constructor Details
-
RequestContextFilter
public RequestContextFilter()
-
-
Method Details
-
setThreadContextInheritable
public void setThreadContextInheritable(boolean threadContextInheritable) Set whether to expose the LocaleContext and RequestAttributes as inheritable for child threads (using anInheritableThreadLocal).Default is "false", to avoid side effects on spawned background threads. Switch this to "true" to enable inheritance for custom child threads which are spawned during request processing and only used for this request (that is, ending after their initial task, without reuse of the thread).
WARNING: Do not use inheritance for child threads if you are accessing a thread pool which is configured to potentially add new threads on demand (e.g. a JDK
ThreadPoolExecutor), since this will expose the inherited context to such a pooled thread. -
shouldNotFilterAsyncDispatch
protected boolean shouldNotFilterAsyncDispatch()Returns "false" so that the filter may set up the request context in each asynchronously dispatched thread.- Overrides:
shouldNotFilterAsyncDispatchin classOncePerRequestFilter
-
shouldNotFilterErrorDispatch
protected boolean shouldNotFilterErrorDispatch()Returns "false" so that the filter may set up the request context in an error dispatch.- Overrides:
shouldNotFilterErrorDispatchin classOncePerRequestFilter
-
doFilterInternal
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException Description copied from class:OncePerRequestFilterSame contract as fordoFilter, but guaranteed to be just invoked once per request within a single request thread. SeeOncePerRequestFilter.shouldNotFilterAsyncDispatch()for details.Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.
- Specified by:
doFilterInternalin classOncePerRequestFilter- Throws:
ServletExceptionIOException
-