Package io.jans.as.model.common

Enum Prompt

java.lang.Object
java.lang.Enum<Prompt>
io.jans.as.model.common.Prompt
All Implemented Interfaces:
HasParamName, Serializable, Comparable<Prompt>, java.lang.constant.Constable
public enum Prompt extends Enum<Prompt> implements HasParamName
An ASCII string values that specifies whether the Authorization Server prompts the End-User for re-authentication and consent.
Author:
Javier Rojas Blum Date: 02.10.2012

  • 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
    CONSENT
    The Authorization Server MUST prompt the End-User for consent before returning information to the Client.
    CREATE
    A value of create indicates to the OpenID Provider that the client desires that the user be shown the account creation UX rather than the login flow.
    LOGIN
    The Authorization Server MUST prompt the End-User for re-authentication
    NONE
    The Authorization Server MUST NOT display any authentication or consent user interface pages.
    SELECT_ACCOUNT
    The Authorization Server MUST prompt the End-User to select a user account.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Prompt
    fromString(String param)
    Returns the corresponding Prompt for a parameter prompt of the authorization endpoint.
    static List<Prompt>
    fromString(String paramList, String separator)
    Returns a list of the corresponding Prompt from a space-separated list of prompt parameters.
    String
    getParamName()
    Gets param name.
    String
    toString()
    Returns a string representation of the object.
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final Prompt NONE
      The Authorization Server MUST NOT display any authentication or consent user interface 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 scopes. This can be used as a method to check for existing authentication and/or consent.

    • LOGIN

      public static final Prompt LOGIN
      The Authorization Server MUST prompt the End-User for re-authentication

    • SELECT_ACCOUNT

      public static final Prompt SELECT_ACCOUNT
      The Authorization Server MUST prompt the End-User to select a user account. This allows a user who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they may have current sessions for.

    • CREATE

      public static final Prompt CREATE
      A value of create indicates to the OpenID Provider that the client desires that the user be shown the account creation UX rather than the 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 combined with any other values.

  • Method Details

    • values

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

    • fromString

      public static Prompt fromString(String param)
      Returns the corresponding Prompt for a parameter prompt of the authorization endpoint.
      Parameters:
      param - The parameter.
      Returns:
      The corresponding response type if found, otherwise null.

    • getParamName

      public String getParamName()
      Gets param name.
      Specified by:
      getParamName in interface HasParamName
      Returns:
      param name

    • fromString

      public static List<Prompt> fromString(String paramList, String separator)
      Returns a list of the corresponding Prompt from a space-separated list of prompt parameters.
      Parameters:
      paramList - A space-separated list of prompt parameters.
      separator - The separator of the string list.
      Returns:
      A list of the recognized response types.

    • toString

      public String toString()
      Returns a string representation of the object. In this case the parameter name.
      Overrides:
      toString in class Enum<Prompt>