public class

DefaultSessionAttributeStore

extends Object
implements SessionAttributeStore
java.lang.Object
   ↳ org.springframework.web.bind.support.DefaultSessionAttributeStore

Class Overview

Default implementation of the SessionAttributeStore interface, storing the attributes in the WebRequest session (i.e. HttpSession or PortletSession).

See Also

Summary

Public Constructors
DefaultSessionAttributeStore()
Public Methods
void cleanupAttribute(WebRequest request, String attributeName)
Clean up the specified attribute 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.
Protected Methods
String getAttributeNameInSession(WebRequest request, String attributeName)
Calculate the attribute name in the backend session.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.web.bind.support.SessionAttributeStore

Public Constructors

public DefaultSessionAttributeStore ()

Public Methods

public void cleanupAttribute (WebRequest request, String attributeName)

Clean up the specified attribute in the backend session.

Indicates that the attribute name will not be used anymore.

Parameters
request the current request
attributeName the name of the attribute

public Object retrieveAttribute (WebRequest request, String attributeName)

Retrieve the specified attribute from the backend session.

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.

Parameters
request the current request
attributeName the name of the attribute
Returns
  • the current attribute value, or null if none

public void setAttributeNamePrefix (String attributeNamePrefix)

Specify a prefix to use for the attribute names in the backend session.

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)

Store the supplied attribute in the backend session.

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.

Parameters
request the current request
attributeName the name of the attribute
attributeValue the attribute value to store

Protected Methods

protected String getAttributeNameInSession (WebRequest request, String attributeName)

Calculate the attribute name in the backend session.

The default implementation simply prepends the configured "attributeNamePrefix", if any.

Parameters
request the current request
attributeName the name of the attribute
Returns
  • the attribute name in the backend session