Top Description Methods
org.springframework.web.bind.annotation

public @Interface SessionAttributes

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
@Inherited
@Documented
Imports
java.lang.annotation.Documented, .ElementType, .Inherited, .Retention, .RetentionPolicy, .Target, org.springframework.core.annotation.AliasFor

Annotation that indicates the session attributes that a specific handler uses.

This will typically list the names of model attributes which should be transparently stored in the session or some conversational storage, serving as form-backing beans. Declared at the type level, applying to the model attributes that the annotated handler class operates on.

Note

Session attributes as indicated using this annotation correspond to a specific handler's model attributes, getting transparently stored in a conversational session. Those attributes will be removed once the handler indicates completion of its conversational session. Therefore, use this facility for such conversational attributes which are supposed to be stored in the session temporarily during the course of a specific handler's conversation.

For permanent session attributes, e.g. a user authentication object, use the traditional session.setAttribute method instead. Alternatively, consider using the attribute management capabilities of the generic org.springframework.web.context.request.WebRequest interface.

Note

When using controller interfaces (e.g. for AOP proxying), make sure to consistently put all your mapping annotations — such as @RequestMapping and @SessionAttributes — on the controller interface rather than on the implementation class.

Authors
Juergen Hoeller, Sam Brannen
Since
2.5

Method Summary

Modifier and TypeMethod and Description
public String[]
names()

The names of session attributes in the model that should be stored in the session or some conversational storage.

public Class<?>[]
types()

The types of session attributes in the model that should be stored in the session or some conversational storage.

public String[]
value()

Alias for names.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

namesback to summary
public String[] names()

The names of session attributes in the model that should be stored in the session or some conversational storage.

Note

This indicates the model attribute names. The session attribute names may or may not match the model attribute names. Applications should therefore not rely on the session attribute names but rather operate on the model only.

Annotations
@AliasFor:value
Since
4.2
typesback to summary
public Class<?>[] types()

The types of session attributes in the model that should be stored in the session or some conversational storage.

All model attributes of these types will be stored in the session, regardless of attribute name.

valueback to summary
public String[] value()

Alias for names.

Annotations
@AliasFor:names