public abstract class

RequestContextHolder

extends Object
java.lang.Object
   ↳ org.springframework.web.context.request.RequestContextHolder

Class Overview

Holder class to expose the web request in the form of a thread-bound RequestAttributes object. The request will be inherited by any child threads spawned by the current thread if the inheritable flag is set to true.

Use RequestContextListener or RequestContextFilter to expose the current web request. Note that DispatcherServlet and DispatcherPortlet already expose the current request by default.

Summary

Public Constructors
RequestContextHolder()
Public Methods
static RequestAttributes currentRequestAttributes()
Return the RequestAttributes currently bound to the thread.
static RequestAttributes getRequestAttributes()
Return the RequestAttributes currently bound to the thread.
static void resetRequestAttributes()
Reset the RequestAttributes for the current thread.
static void setRequestAttributes(RequestAttributes attributes, boolean inheritable)
Bind the given RequestAttributes to the current thread.
static void setRequestAttributes(RequestAttributes attributes)
Bind the given RequestAttributes to the current thread, not exposing it as inheritable for child threads.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RequestContextHolder ()

Public Methods

public static RequestAttributes currentRequestAttributes ()

Return the RequestAttributes currently bound to the thread.

Exposes the previously bound RequestAttributes instance, if any. Falls back to the current JSF FacesContext, if any.

Returns
  • the RequestAttributes currently bound to the thread
Throws
IllegalStateException if no RequestAttributes object is bound to the current thread
See Also

public static RequestAttributes getRequestAttributes ()

Return the RequestAttributes currently bound to the thread.

Returns
  • the RequestAttributes currently bound to the thread, or null if none bound

public static void resetRequestAttributes ()

Reset the RequestAttributes for the current thread.

public static void setRequestAttributes (RequestAttributes attributes, boolean inheritable)

Bind the given RequestAttributes to the current thread.

Parameters
attributes the RequestAttributes to expose, or null to reset the thread-bound context
inheritable whether to expose the RequestAttributes as inheritable for child threads (using an InheritableThreadLocal)

public static void setRequestAttributes (RequestAttributes attributes)

Bind the given RequestAttributes to the current thread, not exposing it as inheritable for child threads.

Parameters
attributes the RequestAttributes to expose