Interface OAuth2TokenIntrospectionClaimAccessor

All Superinterfaces:
ClaimAccessor
All Known Implementing Classes:
OAuth2IntrospectionAuthenticatedPrincipal, OAuth2TokenIntrospection
public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor
A ClaimAccessor for the "claims" that may be contained in the Introspection Response.
Since:
5.6
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable List<String>
    getAudience()
    Returns the intended audience (aud) for the token, or null if it does not exist.
    default @Nullable String
    getClientId()
    Returns the client identifier (client_id) for the token, or null if it does not exist.
    default @Nullable Instant
    getExpiresAt()
    Returns a timestamp (exp) indicating when the token expires, or null if it does not exist.
    default @Nullable String
    getId()
    Returns the identifier (jti) for the token, or null if it does not exist.
    default @Nullable Instant
    getIssuedAt()
    Returns a timestamp (iat) indicating when the token was issued, or null if it does not exist.
    default @Nullable URL
    getIssuer()
    Returns the issuer (iss) of the token, or null if it does not exist.
    default @Nullable Instant
    getNotBefore()
    Returns a timestamp (nbf) indicating when the token is not to be used before, or null if it does not exist.
    default @Nullable List<String>
    getScopes()
    Returns the scopes (scope) associated with the token, or null if it does not exist.
    default @Nullable String
    getSubject()
    Returns usually a machine-readable identifier (sub) of the resource owner who authorized the token, or null if it does not exist.
    default @Nullable String
    getTokenType()
    Returns the type of the token (token_type), for example bearer, or null if it does not exist.
    default @Nullable String
    getUsername()
    Returns a human-readable identifier (username) for the resource owner that authorized the token, or null if it does not exist.
    default boolean
    isActive()
    Returns the indicator (active) whether or not the token is currently active.

    Methods inherited from interface ClaimAccessor

    getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims, hasClaim

  • Method Details

    • isActive

      default boolean isActive()
      Returns the indicator (active) whether or not the token is currently active.
      Returns:
      the indicator whether or not the token is currently active

    • getUsername

      default @Nullable String getUsername()
      Returns a human-readable identifier (username) for the resource owner that authorized the token, or null if it does not exist.
      Returns:
      a human-readable identifier for the resource owner that authorized the token, or null if it does not exist

    • getClientId

      default @Nullable String getClientId()
      Returns the client identifier (client_id) for the token, or null if it does not exist.
      Returns:
      the client identifier for the token, or null if it does not exist.

    • getScopes

      default @Nullable List<String> getScopes()
      Returns the scopes (scope) associated with the token, or null if it does not exist.
      Returns:
      the scopes associated with the token, or null if it does not exist.

    • getTokenType

      default @Nullable String getTokenType()
      Returns the type of the token (token_type), for example bearer, or null if it does not exist.
      Returns:
      the type of the token, for example bearer, or null if it does not exist

    • getExpiresAt

      default @Nullable Instant getExpiresAt()
      Returns a timestamp (exp) indicating when the token expires, or null if it does not exist.
      Returns:
      a timestamp indicating when the token expires, or null if it does not exist.

    • getIssuedAt

      default @Nullable Instant getIssuedAt()
      Returns a timestamp (iat) indicating when the token was issued, or null if it does not exist.
      Returns:
      a timestamp indicating when the token was issued, or null if it does not exist.

    • getNotBefore

      default @Nullable Instant getNotBefore()
      Returns a timestamp (nbf) indicating when the token is not to be used before, or null if it does not exist.
      Returns:
      a timestamp indicating when the token is not to be used before, or null if it does not exist.

    • getSubject

      default @Nullable String getSubject()
      Returns usually a machine-readable identifier (sub) of the resource owner who authorized the token, or null if it does not exist.
      Returns:
      usually a machine-readable identifier of the resource owner who authorized the token, or null if it does not exist

    • getAudience

      default @Nullable List<String> getAudience()
      Returns the intended audience (aud) for the token, or null if it does not exist.
      Returns:
      the intended audience for the token, or null if it does not exist.

    • getIssuer

      default @Nullable URL getIssuer()
      Returns the issuer (iss) of the token, or null if it does not exist.
      Returns:
      the issuer of the token, or null if it does not exist.

    • getId

      default @Nullable String getId()
      Returns the identifier (jti) for the token, or null if it does not exist.
      Returns:
      the identifier for the token, or null if it does not exist.