| org.springframework.web.context.request.RequestAttributes
All known Subclasses: org.springframework.web.context.request.AbstractRequestAttributes,
| RequestAttributes | | public interface RequestAttributes (Code) | | Abstraction for accessing attribute objects associated with a request.
Supports access to request-scoped attributes as well as to session-scoped
attributes, with the optional notion of a "global session".
Can be implemented for any kind of request/session mechanism,
in particular for servlet requests and portlet requests.
author:
Juergen Hoeller
since:
2.0
See Also: ServletRequestAttributes
See Also: org.springframework.web.portlet.context.PortletRequestAttributes |
| Method Summary | |
| Object | getAttribute(String name, int scope)
Return the value for the scoped attribute of the given name, if any. | | String | getSessionId()
Return an id for the current underlying session. | | Object | getSessionMutex()
Expose the best available mutex for the underlying session:
that is, an object to synchronize on for the underlying session. | | void | registerDestructionCallback(String name, Runnable callback, int scope)
Register a callback to be executed on destruction of the
specified attribute in the given scope.
Implementations should do their best to execute the callback
at the appropriate time: that is, at request completion or session
termination, respectively. | | void | removeAttribute(String name, int scope)
Remove the scoped attribute of the given name, if it exists.
Note that an implementation should also remove a registered destruction
callback for the specified attribute, if any. | | void | setAttribute(String name, Object value, int scope)
Set the value for the scoped attribute of the given name,
replacing an existing value (if any). |
| SCOPE_GLOBAL_SESSION | | int SCOPE_GLOBAL_SESSION(Code) | | Constant that indicates global session scope.
This explicitly refers to a globally shared session, if such
a distinction is available (for example, in a Portlet environment).
Else, it simply refers to the common session.
|
| SCOPE_REQUEST | | int SCOPE_REQUEST(Code) | | Constant that indicates request scope.
|
| SCOPE_SESSION | | int SCOPE_SESSION(Code) | | Constant that indicates session scope.
This preferably refers to a locally isolated session, if such
a distinction is available (for example, in a Portlet environment).
Else, it simply refers to the common session.
|
| getAttribute | | Object getAttribute(String name, int scope)(Code) | | Return the value for the scoped attribute of the given name, if any.
Parameters:
name - the name of the attribute
Parameters:
scope - the scope identifier the current attribute value, or null if not found |
| getSessionId | | String getSessionId()(Code) | | Return an id for the current underlying session.
the session id as String (never null |
| getSessionMutex | | Object getSessionMutex()(Code) | | Expose the best available mutex for the underlying session:
that is, an object to synchronize on for the underlying session.
the session mutex to use (never null |
| registerDestructionCallback | | void registerDestructionCallback(String name, Runnable callback, int scope)(Code) | | Register a callback to be executed on destruction of the
specified attribute in the given scope.
Implementations should do their best to execute the callback
at the appropriate time: that is, at request completion or session
termination, respectively. If such a callback is not supported by the
underlying runtime environment, the callback must be ignored
and a corresponding warning should be logged.
Note that 'destruction' usually corresponds to destruction of the
entire scope, not to the individual attribute having been explicitly
removed by the application. If an attribute gets removed via this
facade's
RequestAttributes.removeAttribute(String,int) method, any registered
destruction callback should be disabled as well, assuming that the
removed object will be reused or manually destroyed.
Parameters:
name - the name of the attribute to register the callback for
Parameters:
callback - the destruction callback to be executed
Parameters:
scope - the scope identifier |
| removeAttribute | | void removeAttribute(String name, int scope)(Code) | | Remove the scoped attribute of the given name, if it exists.
Note that an implementation should also remove a registered destruction
callback for the specified attribute, if any. It does, however, not
need to execute a registered destruction callback in this case,
since the object will be destroyed by the caller (if appropriate).
Parameters:
name - the name of the attribute
Parameters:
scope - the scope identifier |
| setAttribute | | void setAttribute(String name, Object value, int scope)(Code) | | Set the value for the scoped attribute of the given name,
replacing an existing value (if any).
Parameters:
name - the name of the attribute
Parameters:
scope - the scope identifier
Parameters:
value - the value for the attribute |
|
|