Package org.wildfly.security.http

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.wildfly.security.http.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

Enumeration of the available scopes during HTTP request handling.

Author:

Darran Lofthouse

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION	The scope applicable to the application (or deployment) being accessed.
CONNECTION	The scope applicable to the connection handling the incoming request.
EXCHANGE	The scope applicable to the current request/response exchange.
GLOBAL	The scope applicable to the whole JVM / Process.
SESSION	The scope applicable to any underlying session.
SSL_SESSION	The scope applicable to any underlying SSL Session.

Method Summary

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

APPLICATION

public static final Scope APPLICATION

The scope applicable to the application (or deployment) being accessed.

CONNECTION

public static final Scope CONNECTION

The scope applicable to the connection handling the incoming request.

EXCHANGE

public static final Scope EXCHANGE

The scope applicable to the current request/response exchange.

GLOBAL

public static final Scope GLOBAL

The scope applicable to the whole JVM / Process.

SESSION

public static final Scope SESSION

The scope applicable to any underlying session.

SSL_SESSION

public static final Scope SSL_SESSION

The scope applicable to any underlying SSL Session.

Method Detail

values

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

Returns:

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

valueOf

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