Package org.springframework.security.oauth2.server.authorization.token

Interface OAuth2TokenClaimAccessor

All Superinterfaces:
org.springframework.security.oauth2.core.ClaimAccessor
All Known Implementing Classes:
OAuth2TokenClaimsSet
public interface OAuth2TokenClaimAccessor extends org.springframework.security.oauth2.core.ClaimAccessor
A ClaimAccessor for the "claims" that may be contained in an OAuth2TokenClaimsSet.
Since:
0.2.3
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<String>
    getAudience()
    Returns the Audience (aud) claim which identifies the recipient(s) that the OAuth 2.0 Token is intended for.
    default Instant
    getExpiresAt()
    Returns the Expiration time (exp) claim which identifies the expiration time on or after which the OAuth 2.0 Token MUST NOT be accepted for processing.
    default String
    getId()
    Returns the ID (jti) claim which provides a unique identifier for the OAuth 2.0 Token.
    default Instant
    getIssuedAt()
    Returns the Issued at (iat) claim which identifies the time at which the OAuth 2.0 Token was issued.
    default URL
    getIssuer()
    Returns the Issuer (iss) claim which identifies the principal that issued the OAuth 2.0 Token.
    default Instant
    getNotBefore()
    Returns the Not Before (nbf) claim which identifies the time before which the OAuth 2.0 Token MUST NOT be accepted for processing.
    default String
    getSubject()
    Returns the Subject (sub) claim which identifies the principal that is the subject of the OAuth 2.0 Token.

    Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor

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

  • Method Details

    • getIssuer

      default URL getIssuer()
      Returns the Issuer (iss) claim which identifies the principal that issued the OAuth 2.0 Token.
      Returns:
      the Issuer identifier

    • getSubject

      default String getSubject()
      Returns the Subject (sub) claim which identifies the principal that is the subject of the OAuth 2.0 Token.
      Returns:
      the Subject identifier

    • getAudience

      default List<String> getAudience()
      Returns the Audience (aud) claim which identifies the recipient(s) that the OAuth 2.0 Token is intended for.
      Returns:
      the Audience(s) that this OAuth 2.0 Token is intended for

    • getExpiresAt

      default Instant getExpiresAt()
      Returns the Expiration time (exp) claim which identifies the expiration time on or after which the OAuth 2.0 Token MUST NOT be accepted for processing.
      Returns:
      the Expiration time on or after which the OAuth 2.0 Token MUST NOT be accepted for processing

    • getNotBefore

      default Instant getNotBefore()
      Returns the Not Before (nbf) claim which identifies the time before which the OAuth 2.0 Token MUST NOT be accepted for processing.
      Returns:
      the Not Before time before which the OAuth 2.0 Token MUST NOT be accepted for processing

    • getIssuedAt

      default Instant getIssuedAt()
      Returns the Issued at (iat) claim which identifies the time at which the OAuth 2.0 Token was issued.
      Returns:
      the Issued at claim which identifies the time at which the OAuth 2.0 Token was issued

    • getId

      default String getId()
      Returns the ID (jti) claim which provides a unique identifier for the OAuth 2.0 Token.
      Returns:
      the ID claim which provides a unique identifier for the OAuth 2.0 Token