org.keycloak.models

Enum UserSessionModel.SessionPersistenceState

java.lang.Object

java.lang.Enum<UserSessionModel.SessionPersistenceState>

org.keycloak.models.UserSessionModel.SessionPersistenceState

All Implemented Interfaces:

Serializable, Comparable<UserSessionModel.SessionPersistenceState>

Enclosing interface:

UserSessionModel

public static enum UserSessionModel.SessionPersistenceState
extends Enum<UserSessionModel.SessionPersistenceState>

Flag used when creating user session

Enum Constant Summary

Enum Constants

Enum Constant and Description
PERSISTENT Session will be marked as persistent when created and it will be saved into the persistent storage (EG.
TRANSIENT This userSession will be valid just for the single request.

Method Summary

Modifier and Type	Method and Description
static UserSessionModel.SessionPersistenceState	fromString(String sessionPersistenceString)
static UserSessionModel.SessionPersistenceState	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserSessionModel.SessionPersistenceState[]	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

PERSISTENT

public static final UserSessionModel.SessionPersistenceState PERSISTENT

Session will be marked as persistent when created and it will be saved into the persistent storage (EG. infinispan cache). This is the default behaviour

TRANSIENT

public static final UserSessionModel.SessionPersistenceState TRANSIENT

This userSession will be valid just for the single request. Hence there won't be real userSession created in the persistent store. Flag can be used for the protocols, which need just "dummy" userSession to be able to run protocolMappers SPI. Example is DockerProtocol or OAuth2 client credentials grant.

Method Detail

values

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

Returns:

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

valueOf

public static UserSessionModel.SessionPersistenceState valueOf(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:

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

NullPointerException - if the argument is null

fromString

public static UserSessionModel.SessionPersistenceState fromString(String sessionPersistenceString)