com.authlete.common.types

Enum StandardScope

java.lang.Object

java.lang.Enum<StandardScope>

com.authlete.common.types.StandardScope

All Implemented Interfaces:

Serializable, Comparable<StandardScope>

public enum StandardScope
extends Enum<StandardScope>

Scopes defined by related specifications.

Since:

1.5

Author:

Takahiko Kawasaki

See Also:

OpenID Connect Core 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDRESS "address", which requests "address" claim.
EMAIL "email", which requests "email" and "email_verified" claims.
OFFLINE_ACCESS "offline_access", which requests that an OAuth 2.0 Refresh Token be issued that can be used to obtain an Access Token that grants access to the End-User's UserInfo Endpoint even when the End-User is not present (not logged in).
OPENID "openid", which must be contained in every OpenID Connect Authentication Request.
PHONE "phone", which requests "phone_number" and "phone_number_verified" claims.
PROFILE "profile", which requests the following claims: "name", "family_name", "given_name", "middle_name", "nickname", "preferred_username", "profile", "picture", "website", "gender", "birthdate", "zoneinfo", "locale" and "updated_at".

Method Summary

Modifier and Type	Method and Description
static StandardScope	getByValue(short value) Find an instance of this enum by a value.
short	getValue() Get the integer representation of this enum instance.
static StandardScope	parse(String scope) Convert String to StandardScope.
static StandardScope[]	toArray(int bits)
static int	toBits(EnumSet<StandardScope> set)
static EnumSet<StandardScope>	toSet(int bits)
static EnumSet<StandardScope>	toSet(StandardScope[] array)
String	toString()
static StandardScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardScope[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADDRESS

public static final StandardScope ADDRESS

"address", which requests "address" claim.

See Also:

ClaimsScope.ADDRESS, OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values

EMAIL

public static final StandardScope EMAIL

"email", which requests "email" and "email_verified" claims.

See Also:

ClaimsScope.EMAIL, OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values

OPENID

public static final StandardScope OPENID

"openid", which must be contained in every OpenID Connect Authentication Request.

See Also:

OpenID Connect Core 1.0, 3.1.2.1. Authentication Request

OFFLINE_ACCESS

public static final StandardScope OFFLINE_ACCESS

"offline_access", which requests that an OAuth 2.0 Refresh Token be issued that can be used to obtain an Access Token that grants access to the End-User's UserInfo Endpoint even when the End-User is not present (not logged in).

See Also:

OpenID Connect Core 1.0, 11. Offline Access

PHONE

public static final StandardScope PHONE

"phone", which requests "phone_number" and "phone_number_verified" claims.

See Also:

ClaimsScope.PHONE, OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values

PROFILE

public static final StandardScope PROFILE

"profile", which requests the following claims: "name", "family_name", "given_name", "middle_name", "nickname", "preferred_username", "profile", "picture", "website", "gender", "birthdate", "zoneinfo", "locale" and "updated_at".

See Also:

ClaimsScope.PROFILE, OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public short getValue()

Get the integer representation of this enum instance.

toString

public String toString()

Overrides:

toString in class Enum<StandardScope>

getByValue

public static StandardScope getByValue(short value)

Find an instance of this enum by a value.

Parameters:

value - The integer representation of the instance to find.

Returns:

An instance of this enum, or null if not found.

parse

public static StandardScope parse(String scope)

Convert String to StandardScope.

Parameters:

scope - A standard scope name. For example, "openid".

Returns:

StandardScope instance, or null.

toBits

public static int toBits(EnumSet<StandardScope> set)

toArray

public static StandardScope[] toArray(int bits)

toSet

public static EnumSet<StandardScope> toSet(int bits)

toSet

public static EnumSet<StandardScope> toSet(StandardScope[] array)