Package org.forgerock.am.cts.api.tokens

Enum Class TokenType

java.lang.Object
java.lang.Enum<TokenType>
org.forgerock.am.cts.api.tokens.TokenType
All Implemented Interfaces:
Serializable, Comparable<TokenType>, java.lang.constant.Constable
public enum TokenType extends Enum<TokenType>
Responsible for defining the available token types in the Core Token Service. If new tokens are added, this enum must be updated via APPENDING to the end of the enum list. Existing operations MUST STAY in the order they are defined. This is validated by TokenTypeTest.

  • Enum Constant Details

    • SESSION

      public static final TokenType SESSION
      Session token type.

    • SAML2

      public static final TokenType SAML2
      SAML2 token type.

    • OAUTH

      public static final TokenType OAUTH
      OAuth token type.

    • REST

      public static final TokenType REST
      REST token type.

    • GENERIC

      public static final TokenType GENERIC
      Generatic token type.

    • RESOURCE_SET

      public static final TokenType RESOURCE_SET
      OAuth Resource set token type.

    • PERMISSION_TICKET

      public static final TokenType PERMISSION_TICKET
      UMA Permission ticket token type.

    • REQUESTING_PARTY

      public static final TokenType REQUESTING_PARTY
      UMA Requesting party token type.

    • UMA_AUDIT_ENTRY

      public static final TokenType UMA_AUDIT_ENTRY
      UMA Audit entry token type.

    • SESSION_BLACKLIST

      public static final TokenType SESSION_BLACKLIST
      Session blacklist token type.

    • UMA_PENDING_REQUEST

      public static final TokenType UMA_PENDING_REQUEST
      UMA Pending request token type.

    • STS

      public static final TokenType STS
      STS token type.

    • OAUTH_BLACKLIST

      public static final TokenType OAUTH_BLACKLIST
      OAuth blacklist token type.

    • OAUTH_STATELESS

      public static final TokenType OAUTH_STATELESS
      Legacy stateless OAuth2 metadata token type.

    • PUSH

      public static final TokenType PUSH
      Push Notification System token type.

    • NOTIFICATION

      public static final TokenType NOTIFICATION
      Token type for cluster-wide notification system.

    • OAUTH2_STATELESS_GRANT

      public static final TokenType OAUTH2_STATELESS_GRANT
      Stateless OAuth2 token to represent an authorization.

    • TRANSACTION

      public static final TokenType TRANSACTION
      Token type for authentication transactions.

    • AUTHENTICATION_WHITELIST

      public static final TokenType AUTHENTICATION_WHITELIST
      Authentication session whitelist.

    • OAUTH2_GRANT_SET

      public static final TokenType OAUTH2_GRANT_SET
      OAuth2 GrantSet token type.

    • BACK_CHANNEL_AUTHENTICATION_STATE

      public static final TokenType BACK_CHANNEL_AUTHENTICATION_STATE
      Back Channel Authentication state.

    • SUSPENDED_AUTHENTICATION_SESSION

      public static final TokenType SUSPENDED_AUTHENTICATION_SESSION
      Suspended authentication session token type.

    • LOGOUT_USER

      public static final TokenType LOGOUT_USER
      Logout User token type.

    • REQUEST_URI_OBJECT

      public static final TokenType REQUEST_URI_OBJECT
      A reference to a request object. This is used by the OAuth2 Push Authorisation Request flow and also by AM's request_uri endpoint when acting as a Relying Party to an OIDC provider.

  • Method Details

    • values

      public static TokenType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TokenType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMetricName

      public String getMetricName()
      The name to use when referring to this token type in monitoring metrics.
      Returns:
      Non-null, token type identifier.