Package com.ibm.security.access.extension.authn

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

com.ibm.security.access.extension.authn.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, java.lang.constant.Constable

public enum Scope
extends Enum<Scope>

This enum represents scope of context attribute. There are two possible scopes: REQUEST and SESSION. Context attribute stored in REQUEST scope exists only in the current user interaction. Context attribute stored in SESSION scope exists across user interactions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
REQUEST
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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUEST

public static final Scope REQUEST

SESSION

public static final Scope SESSION

Method Details

values

public static Scope[] values()

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

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