com.authlete.common.types

Enum Prompt

java.lang.Object

java.lang.Enum<Prompt>

com.authlete.common.types.Prompt

All Implemented Interfaces:

Serializable, Comparable<Prompt>

public enum Prompt
extends Enum<Prompt>

Values for prompt.

Author:

Takahiko Kawasaki

See Also:

OpenID Connect Core 1.0, 3.1.2.1. Authentication Request

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSENT "consent" (2).
LOGIN "login" (1).
NONE "none" (0).
SELECT_ACCOUNT "select_account" (3).

Method Summary

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

NONE

public static final Prompt NONE

"none" (0).

The Authorization Server MUST NOT display any authentication or consent user interface pages. An error is returned if an End-User is not already authenticated or the Client does not have pre-configured consent for the requested Claims or does not fulfill other conditions for processing the request. The error code will typically be login_required, interaction_required, or another code defined in Section 3.1.2.6. This can be used as a method to check for existing authentication and/or consent.

LOGIN

public static final Prompt LOGIN

"login" (1).

The Authorization Server SHOULD prompt the End-User for reauthentication. If it cannot reauthenticate the End-User, it MUST return an error, typically login_required.

CONSENT

public static final Prompt CONSENT

"consent" (2).

The Authorization Server SHOULD prompt the End-User for consent before returning information to the Client. If it cannot obtain consent, it MUST return an error, typically consent_required.

SELECT_ACCOUNT

public static final Prompt SELECT_ACCOUNT

"select_account" (3).

The Authorization Server SHOULD prompt the End-User to select a user account. This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for. If it cannot obtain an account selection choice made by the End-User, it MUST return an error, typically account_selection_required.

Method Detail

values

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

Returns:

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

valueOf

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

getByValue

public static Prompt 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 Prompt parse(String prompt)

Convert String to Prompt.

Parameters:

prompt - A value of prompt parameter. For example, "login".

Returns:

Prompt instance, or null.

toBits

public static int toBits(EnumSet<Prompt> set)

toArray

public static Prompt[] toArray(int bits)

toSet

public static EnumSet<Prompt> toSet(int bits)

toSet

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