org.springframework.security.config.http

Enum SessionCreationPolicy

java.lang.Object

java.lang.Enum<SessionCreationPolicy>

org.springframework.security.config.http.SessionCreationPolicy

All Implemented Interfaces:

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

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

Specifies the various session creation policies for Spring Security.

Since:

3.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always create an HttpSession
IF_REQUIRED Spring Security will only create an HttpSession if required
NEVER Spring Security will never create an HttpSession, but will use the HttpSession if it already exists
STATELESS Spring Security will never create an HttpSession and it will never use it to obtain the SecurityContext

Method Summary

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

ALWAYS

public static final SessionCreationPolicy ALWAYS

Always create an HttpSession

NEVER

public static final SessionCreationPolicy NEVER

Spring Security will never create an HttpSession, but will use the HttpSession if it already exists

IF_REQUIRED

public static final SessionCreationPolicy IF_REQUIRED

Spring Security will only create an HttpSession if required

STATELESS

public static final SessionCreationPolicy STATELESS

Spring Security will never create an HttpSession and it will never use it to obtain the SecurityContext

Method Detail

values

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

Returns:

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

valueOf

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