com.nimbusds.openid.connect.sdk

Enum Prompt.Type

java.lang.Object

java.lang.Enum<Prompt.Type>

com.nimbusds.openid.connect.sdk.Prompt.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Prompt.Type>

Enclosing class:

Prompt

public static enum Prompt.Type
extends java.lang.Enum<Prompt.Type>

Enumeration of the prompt types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSENT The authorisation server must prompt the end-user for consent before returning information to the client.
LOGIN The authorisation server must prompt the end-user for re-authentication.
NONE The authorisation server must not display any authentication or consent UI pages.
SELECT_ACCOUNT The authorisation server must prompt the end-user to select a user account.

Method Summary

Methods

Modifier and Type	Method and Description
static Prompt.Type	parse(java.lang.String s) Parses a prompt type.
java.lang.String	toString() Returns the string identifier of this prompt type.
static Prompt.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Prompt.Type[]	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.Type NONE

The authorisation server must not display any authentication or consent UI pages. An error is returned if the end user is not already authenticated or the client does not have pre-configured consent for the requested scope. This can be used as a method to check for existing authentication and / or consent.

LOGIN

public static final Prompt.Type LOGIN

The authorisation server must prompt the end-user for re-authentication.

CONSENT

public static final Prompt.Type CONSENT

The authorisation server must prompt the end-user for consent before returning information to the client.

SELECT_ACCOUNT

public static final Prompt.Type SELECT_ACCOUNT

The authorisation server must prompt the end-user to select a user account. This allows a user who has multiple accounts at the authorisation server to select amongst the multiple accounts that they may have current sessions for.

Method Detail

values

public static Prompt.Type[] 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.Type c : Prompt.Type.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.Type valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns the string identifier of this prompt type.

Overrides:

toString in class java.lang.Enum<Prompt.Type>

Returns:

The string identifier.

parse

public static Prompt.Type parse(java.lang.String s)
                         throws ParseException

Parses a prompt type.

Parameters:

s - The string to parse.

Returns:

The prompt type.

Throws:

ParseException - If the parsed string is null or doesn't match a prompt type.