Class RequestContextFilter

All Implemented Interfaces:
Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware

public class RequestContextFilter extends OncePerRequestFilter
Servlet Filter that exposes the request to the current thread, through both 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.

Juergen Hoeller, Rod Johnson, Rossen Stoyanchev
See Also:
  • 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 an InheritableThreadLocal).

      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.
      shouldNotFilterAsyncDispatch in class OncePerRequestFilter
    • shouldNotFilterErrorDispatch

      protected boolean shouldNotFilterErrorDispatch()
      Returns "false" so that the filter may set up the request context in an error dispatch.
      shouldNotFilterErrorDispatch in class OncePerRequestFilter
    • doFilterInternal

      protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, 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