public interface

SessionAttributeStore

org.springframework.web.bind.support.SessionAttributeStore
Known Indirect Subclasses

Class Overview

Strategy interface for storing model attributes in a backend session.

Summary

Public Methods
abstract void cleanupAttribute(WebRequest request, String attributeName)
Clean up the specified attribute in the backend session.
abstract Object retrieveAttribute(WebRequest request, String attributeName)
Retrieve the specified attribute from the backend session.
abstract void storeAttribute(WebRequest request, String attributeName, Object attributeValue)
Store the supplied attribute in the backend session.

Public Methods

public abstract 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 abstract 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 abstract 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