Spring Web 6.1.4 · org.springframework.web.method.annotation.SessionAttributesHandler

Manages controller-specific session attributes declared via @SessionAttributes. Actual storage is delegated to a SessionAttributeStore instance.

When a controller annotated with @SessionAttributes adds attributes to its model, those attributes are checked against names and types specified via @SessionAttributes. Matching model attributes are saved in the HTTP session and remain there until the controller calls SessionStatus#setComplete().

Field Summary

Modifier and Type	Field and Description
private final Set<String>	attributeNames
private final Set<Class<?>>	attributeTypes
private final Set<String>	knownAttributeNames
public static final String	SESSION_KNOWN_ATTRIBUTE Key for known-attribute-names storage (a String array) as a session attribute.
private final SessionAttributeStore	sessionAttributeStore

Constructor Summary

Access	Constructor and Description
public	SessionAttributesHandler(Class<?> the controller type handlerType, SessionAttributeStore used for session access sessionAttributeStore) Create a new session attributes handler.

Method Summary

Modifier and Type	Method and Description
public void	cleanupAttributes(WebRequest the current request request) Remove "known" attributes from the session, i.e. attributes listed by name in `@SessionAttributes` or attributes previously stored in the model that matched by type.
public boolean	hasSessionAttributes() Whether the controller represented by this instance has declared any session attributes through an `SessionAttributes` annotation.
public boolean	isHandlerSessionAttribute(String the attribute name to check attributeName, Class<?> the type for the attribute attributeType) Whether the attribute name or type match the names and types specified via `@SessionAttributes` on the underlying controller.
pack-priv Object	Returns: the attribute value, or `null` if none retrieveAttribute(WebRequest the current request request, String the name of the attribute of interest attributeName) A pass-through call to the underlying `SessionAttributeStore`.
public Map<String, Object>	Returns: a map with handler session attributes, possibly empty retrieveAttributes(WebRequest the current request request) Retrieve "known" attributes from the session, i.e. attributes listed by name in `@SessionAttributes` or attributes previously stored in the model that matched by type.
public void	storeAttributes(WebRequest the current request request, Map<String, ?> candidate attributes for session storage attributes) Store a subset of the given attributes in the session.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributeNames	back to summary
private final Set<String> attributeNames

attributeTypes	back to summary
private final Set<Class<?>> attributeTypes

knownAttributeNames	back to summary
private final Set<String> knownAttributeNames

SESSION_KNOWN_ATTRIBUTE	back to summary
public static final String SESSION_KNOWN_ATTRIBUTE Key for known-attribute-names storage (a String array) as a session attribute. This is necessary for consistent handling of type-based session attributes in distributed session scenarios where handler methods from the same class may get invoked on different servers. Since 6.1.4

SESSION_KNOWN_ATTRIBUTE

back to summary

public static final String SESSION_KNOWN_ATTRIBUTE

Key for known-attribute-names storage (a String array) as a session attribute.

This is necessary for consistent handling of type-based session attributes in distributed session scenarios where handler methods from the same class may get invoked on different servers.

Since: 6.1.4

sessionAttributeStore	back to summary
private final SessionAttributeStore sessionAttributeStore

Constructor Detail

SessionAttributesHandler back to summary

SessionAttributesHandler	back to summary
public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore) Create a new session attributes handler. Session attribute names and types are extracted from the `@SessionAttributes` annotation, if present, on the given type. Parameters handlerType:Class<?> the controller type sessionAttributeStore:SessionAttributeStore used for session access

public SessionAttributesHandler(Class<?> handlerType, SessionAttributeStore sessionAttributeStore)

Create a new session attributes handler. Session attribute names and types are extracted from the @SessionAttributes annotation, if present, on the given type.

Parameters

handlerType:Class<?>: the controller type
sessionAttributeStore:SessionAttributeStore: used for session access

Method Detail

cleanupAttributes back to summary

cleanupAttributes	back to summary
public void cleanupAttributes(WebRequest request) Remove "known" attributes from the session, i.e. attributes listed by name in `@SessionAttributes` or attributes previously stored in the model that matched by type. Parameters request:WebRequest the current request

public void cleanupAttributes(WebRequest request)

Remove "known" attributes from the session, i.e. attributes listed by name in @SessionAttributes or attributes previously stored in the model that matched by type.

Parameters

request:WebRequest: the current request

hasSessionAttributes	back to summary
public boolean hasSessionAttributes() Whether the controller represented by this instance has declared any session attributes through an `SessionAttributes` annotation.

isHandlerSessionAttribute back to summary

isHandlerSessionAttribute	back to summary
public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType) Whether the attribute name or type match the names and types specified via `@SessionAttributes` on the underlying controller. Attributes successfully resolved through this method are "remembered" and subsequently used in `retrieveAttributes(WebRequest)` and `cleanupAttributes(WebRequest)`. Parameters attributeName:String the attribute name to check attributeType:Class<?> the type for the attribute

public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType)

Whether the attribute name or type match the names and types specified via @SessionAttributes on the underlying controller.

Attributes successfully resolved through this method are "remembered" and subsequently used in retrieveAttributes(WebRequest) and cleanupAttributes(WebRequest).

Parameters

attributeName:String: the attribute name to check
attributeType:Class<?>: the type for the attribute

retrieveAttribute back to summary

retrieveAttribute	back to summary
pack-priv Object retrieveAttribute(WebRequest request, String attributeName) A pass-through call to the underlying `SessionAttributeStore`. Parameters request:WebRequest the current request attributeName:String the name of the attribute of interest Returns:Object the attribute value, or `null` if none Annotations @Nullable

pack-priv Object retrieveAttribute(WebRequest request, String attributeName)

A pass-through call to the underlying SessionAttributeStore.

Parameters

request:WebRequest: the current request
attributeName:String: the name of the attribute of interest

Returns:Object

the attribute value, or null if none

Annotations

@Nullable

retrieveAttributes back to summary

retrieveAttributes	back to summary
public Map<String, Object> retrieveAttributes(WebRequest request) Retrieve "known" attributes from the session, i.e. attributes listed by name in `@SessionAttributes` or attributes previously stored in the model that matched by type. Parameters request:WebRequest the current request Returns:Map<String, Object> a map with handler session attributes, possibly empty

public Map<String, Object> retrieveAttributes(WebRequest request)

Retrieve "known" attributes from the session, i.e. attributes listed by name in @SessionAttributes or attributes previously stored in the model that matched by type.

Parameters

request:WebRequest: the current request

Returns:Map<String, Object>

a map with handler session attributes, possibly empty

storeAttributes back to summary

storeAttributes	back to summary
public void storeAttributes(WebRequest request, Map<String, ?> attributes) Store a subset of the given attributes in the session. Attributes not declared as session attributes via `@SessionAttributes` are ignored. Parameters request:WebRequest the current request attributes:Map<String, ?> candidate attributes for session storage

public void storeAttributes(WebRequest request, Map<String, ?> attributes)

Store a subset of the given attributes in the session. Attributes not declared as session attributes via @SessionAttributes are ignored.

Parameters

request:WebRequest: the current request
attributes:Map<String, ?>: candidate attributes for session storage

public Class SessionAttributesHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail