Module jakarta.security
Package jakarta.security.enterprise.authentication.mechanism.http.openid

Enum PromptType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PromptType>
    public enum PromptType
extends java.lang.Enum<PromptType>
    Prompt specifies whether the Authorization Server prompts the End-User for re-authentication and consent.
    Author:
    Gaurav Gupta

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CONSENT
      The Authorization Server SHOULD prompt the End-User for consent before returning information to the Client.
      LOGIN
      The Authorization Server SHOULD prompt the End-User for reauthentication.
      NONE
      The Authorization Server must not display any authentication or consent user interface pages.
      SELECT_ACCOUNT
      The Authorization Server SHOULD prompt the End-User to select a user account.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PromptType fromString​(java.lang.String key)  
      static PromptType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PromptType[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NONE

        public static final PromptType NONE
        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. ErrorCode : login_required, interaction_required

      • LOGIN

        public static final PromptType LOGIN
        The Authorization Server SHOULD prompt the End-User for reauthentication. If it cannot reauthenticate the End-User, it MUST return an error. ErrorCode : login_required

      • CONSENT

        public static final PromptType CONSENT
        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. ErrorCode : consent_required

      • SELECT_ACCOUNT

        public static final PromptType SELECT_ACCOUNT
        The Authorization Server SHOULD prompt the End-User to select a user account. If it cannot obtain an account selection choice made by the end-user, it must return an error. ErrorCode : account_selection_required

    • Method Detail

      • values

        public static PromptType[] 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 (PromptType c : PromptType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • fromString

        public static PromptType fromString​(java.lang.String key)