org.springframework.web.reactive.result.method.annotation

Class SessionAttributesHandler

java.lang.Object

org.springframework.web.reactive.result.method.annotation.SessionAttributesHandler

class SessionAttributesHandler
extends java.lang.Object

Package-private class to assist ModelInitializer with managing model attributes in the WebSession based on model attribute names and types declared va @SessionAttributes.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.String>	attributeNames
private java.util.Set<java.lang.Class<?>>	attributeTypes
private java.util.Set<java.lang.String>	knownAttributeNames

Constructor Summary

Constructors

Constructor and Description
SessionAttributesHandler(java.lang.Class<?> handlerType) Create a new session attributes handler.

Method Summary

Modifier and Type	Method and Description
void	cleanupAttributes(WebSession session) Remove "known" attributes from the session, i.e.
boolean	hasSessionAttributes() Whether the controller represented by this instance has declared any session attributes through an SessionAttributes annotation.
boolean	isHandlerSessionAttribute(java.lang.String attributeName, java.lang.Class<?> attributeType) Whether the attribute name or type match the names and types specified via @SessionAttributes on the underlying controller.
java.util.Map<java.lang.String,java.lang.Object>	retrieveAttributes(WebSession session) Retrieve "known" attributes from the session, i.e.
void	storeAttributes(WebSession session, java.util.Map<java.lang.String,?> attributes) Store a subset of the given attributes in the session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attributeNames

private final java.util.Set<java.lang.String> attributeNames

attributeTypes

private final java.util.Set<java.lang.Class<?>> attributeTypes

knownAttributeNames

private final java.util.Set<java.lang.String> knownAttributeNames

Constructor Detail

SessionAttributesHandler

public SessionAttributesHandler(java.lang.Class<?> handlerType)

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 - the controller type

Method Detail

hasSessionAttributes

public boolean hasSessionAttributes()

Whether the controller represented by this instance has declared any session attributes through an SessionAttributes annotation.

isHandlerSessionAttribute

public boolean isHandlerSessionAttribute(java.lang.String attributeName,
                                         java.lang.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(WebSession) and also cleanupAttributes(WebSession).

Parameters:

attributeName - the attribute name to check

attributeType - the type for the attribute

retrieveAttributes

public java.util.Map<java.lang.String,java.lang.Object> retrieveAttributes(WebSession session)

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:

session - the current session

Returns:

a map with handler session attributes, possibly empty

storeAttributes

public void storeAttributes(WebSession session,
                            java.util.Map<java.lang.String,?> attributes)

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

Parameters:

session - the current session

attributes - candidate attributes for session storage

cleanupAttributes

public void cleanupAttributes(WebSession session)

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:

session - the current session