Enum Class LogoutScope

java.lang.Object

java.lang.Enum<LogoutScope>

com.svenruppert.jsentinel.logout.LogoutScope

All Implemented Interfaces:

Serializable, Comparable<LogoutScope>, Constable

public enum LogoutScope
extends Enum<LogoutScope>

Scope of a logout request.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AllSessionsOfSubject	Log the subject out of every active session for that subject.
CurrentSession	Log the subject out of the session associated with the current thread / request.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CurrentSession

public static final LogoutScope CurrentSession

Log the subject out of the session associated with the current thread / request. The most common user-initiated logout — a sign-out button.

AllSessionsOfSubject

public static final LogoutScope AllSessionsOfSubject

Log the subject out of every active session for that subject. Used for administrative "force-sign-out everywhere" actions or when a session-fixation / password-change event invalidates all existing sessions.

Method Details

values

public static LogoutScope[] 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 LogoutScope 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