public class DefaultSessionAttributeStore extends Object implements SessionAttributeStore
SessionAttributeStore
interface,
storing the attributes in the WebRequest session (i.e. HttpSession
or PortletSession).Constructor and Description |
---|
DefaultSessionAttributeStore() |
Modifier and Type | Method and Description |
---|---|
void |
cleanupAttribute(WebRequest request,
String attributeName)
Clean up the specified attribute in the backend session.
|
protected String |
getAttributeNameInSession(WebRequest request,
String attributeName)
Calculate the attribute name in the backend session.
|
Object |
retrieveAttribute(WebRequest request,
String attributeName)
Retrieve the specified attribute from the backend session.
|
void |
setAttributeNamePrefix(String attributeNamePrefix)
Specify a prefix to use for the attribute names in the backend session.
|
void |
storeAttribute(WebRequest request,
String attributeName,
Object attributeValue)
Store the supplied attribute in the backend session.
|
public void setAttributeNamePrefix(String attributeNamePrefix)
Default is to use no prefix, storing the session attributes with the same name as in the model.
public void storeAttribute(WebRequest request, String attributeName, Object attributeValue)
SessionAttributeStore
Can be called for new attributes as well as for existing attributes. In the latter case, this signals that the attribute value may have been modified.
storeAttribute
in interface SessionAttributeStore
request
- the current requestattributeName
- the name of the attributeattributeValue
- the attribute value to storepublic Object retrieveAttribute(WebRequest request, String attributeName)
SessionAttributeStore
This will typically be called with the expectation that the
attribute is already present, with an exception to be thrown
if this method returns null
.
retrieveAttribute
in interface SessionAttributeStore
request
- the current requestattributeName
- the name of the attributenull
if nonepublic void cleanupAttribute(WebRequest request, String attributeName)
SessionAttributeStore
Indicates that the attribute name will not be used anymore.
cleanupAttribute
in interface SessionAttributeStore
request
- the current requestattributeName
- the name of the attributeprotected String getAttributeNameInSession(WebRequest request, String attributeName)
The default implementation simply prepends the configured
"attributeNamePrefix"
, if any.
request
- the current requestattributeName
- the name of the attribute