Package org.springframework.session

Enum Class FlushMode

java.lang.Object

java.lang.Enum<FlushMode>

org.springframework.session.FlushMode

All Implemented Interfaces:

Serializable, Comparable<FlushMode>, Constable

public enum FlushMode
extends Enum<FlushMode>

Supported modes of writing the session to session store.

Since:

2.2.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMMEDIATE	Writes to session store as soon as possible.
ON_SAVE	Only writes to session store when SessionRepository.save(Session) is invoked.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ON_SAVE

public static final FlushMode ON_SAVE

Only writes to session store when SessionRepository.save(Session) is invoked. In a web environment this is typically done as soon as the HTTP response is committed.

IMMEDIATE

public static final FlushMode IMMEDIATE

Writes to session store as soon as possible. For example SessionRepository.createSession() will write the session to session store. Another example is that setting an attribute using Session.setAttribute(String, Object) will also write to session store immediately.

Method Details

values

public static FlushMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FlushMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null