org.springframework.session.data.redis

Enum RedisFlushMode

java.lang.Object

java.lang.Enum<RedisFlushMode>

org.springframework.session.data.redis.RedisFlushMode

All Implemented Interfaces:

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

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

Specifies when to write to the backing Redis instance.

Since:

1.1

Author:

Rob Winch

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static RedisFlushMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RedisFlushMode[]	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 RedisFlushMode ON_SAVE

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

IMMEDIATE

public static final RedisFlushMode IMMEDIATE

Writes to Redis as soon as possible. For example SessionRepository.createSession() will write the session to Redis. Another example is that setting an attribute on the session will also write to Redis immediately.

Method Detail

values

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

Returns:

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

valueOf

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