Package 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:
Serializable
,Comparable<Prompt.Type>
- Enclosing class:
- Prompt
public static enum Prompt.Type extends Enum<Prompt.Type>
Enumeration of the prompt types.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CONSENT
The authorisation server must prompt the end-user for consent before returning information to the client.CREATE
The client desires the OpenID provider to present the end-user with an account creation user interface instead of the normal login flow.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Prompt.Type
parse(String s)
Parses a prompt type.String
toString()
Returns the string identifier of this prompt type.static Prompt.Type
valueOf(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.
-
-
-
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 requestedscope
. 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.
-
CREATE
public static final Prompt.Type CREATE
The client desires the OpenID provider to present the end-user with an account creation user interface instead of the normal login flow. Care must be taken if combining this value with other prompt values. Mutually exclusive conditions can arise so it is RECOMMENDED that create not be present with any other values.
-
-
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(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 nameNullPointerException
- if the argument is null
-
toString
public String toString()
Returns the string identifier of this prompt type.- Overrides:
toString
in classEnum<Prompt.Type>
- Returns:
- The string identifier.
-
parse
public static Prompt.Type parse(String s) throws ParseException
Parses a prompt type.- Parameters:
s
- The string to parse.- Returns:
- The prompt type.
- Throws:
ParseException
- If the parsed string isnull
or doesn't match a prompt type.
-
-