org.springframework.session

Enum SaveMode

java.lang.Object

java.lang.Enum<SaveMode>

org.springframework.session.SaveMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SaveMode>

public enum SaveMode
extends java.lang.Enum<SaveMode>

Supported modes of tracking and saving session changes to session store.

Since:

2.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always save all session attributes, regardless of the interaction with the session.
ON_GET_ATTRIBUTE Same as ON_SET_ATTRIBUTE with addition of saving attributes that have been read using Session.getAttribute(String).
ON_SET_ATTRIBUTE Save only changes made to session, for instance using Session.setAttribute(String, Object).

Method Summary

Modifier and Type	Method and Description
static SaveMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SaveMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ON_SET_ATTRIBUTE

public static final SaveMode ON_SET_ATTRIBUTE

Save only changes made to session, for instance using Session.setAttribute(String, Object). In highly concurrent environments, this mode minimizes the risk of attributes being overwritten during processing of parallel requests.

ON_GET_ATTRIBUTE

public static final SaveMode ON_GET_ATTRIBUTE

Same as ON_SET_ATTRIBUTE with addition of saving attributes that have been read using Session.getAttribute(String).

ALWAYS

public static final SaveMode ALWAYS

Always save all session attributes, regardless of the interaction with the session. In highly concurrent environments, this mode increases the risk of attributes being overwritten during processing of parallel requests.

Method Detail

values

public static SaveMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SaveMode c : SaveMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SaveMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null