org.springframework.session

Enum FlushMode

java.lang.Object

java.lang.Enum<FlushMode>

org.springframework.session.FlushMode

All Implemented Interfaces:

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

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

Supported modes of writing the session to session store.

Since:

2.2.0

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static FlushMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FlushMode[]	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_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 Detail

values

public static FlushMode[] 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 (FlushMode c : FlushMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static FlushMode 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