Enum Prompt

  • All Implemented Interfaces:
    HasParamName, Serializable, Comparable<Prompt>

    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
    • Enum Constant Detail

      • 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
      • CONSENT

        public static final Prompt CONSENT
        The Authorization Server MUST prompt the End-User for consent before returning information to the Client.
      • 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.
    • 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
      • 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.
      • 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>