Interface JwtClaimAccessor

All Superinterfaces:
ClaimAccessor
All Known Implementing Classes:
Jwt, JwtClaimsSet
public interface JwtClaimAccessor extends ClaimAccessor
A ClaimAccessor for the "claims" that may be contained in the JSON object JWT Claims Set of a JSON Web Token (JWT).
Since:
5.0
See Also:

  • Method Summary

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

    Methods inherited from interface ClaimAccessor

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

  • Method Details

    • getIssuer

      default @Nullable URL getIssuer()
      Returns the Issuer (iss) claim which identifies the principal that issued the JWT.
      Returns:
      the Issuer identifier, or null if the claim is missing

    • getSubject

      default @Nullable String getSubject()
      Returns the Subject (sub) claim which identifies the principal that is the subject of the JWT.
      Returns:
      the Subject identifier, or null if the claim is missing

    • getAudience

      default @Nullable List<String> getAudience()
      Returns the Audience (aud) claim which identifies the recipient(s) that the JWT is intended for.
      Returns:
      the Audience(s) that this JWT intended for, or null if the claim is missing

    • getExpiresAt

      default @Nullable Instant getExpiresAt()
      Returns the Expiration time (exp) claim which identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.
      Returns:
      the Expiration time on or after which the JWT MUST NOT be accepted for processing, or null if the claim is missing

    • getNotBefore

      default @Nullable Instant getNotBefore()
      Returns the Not Before (nbf) claim which identifies the time before which the JWT MUST NOT be accepted for processing.
      Returns:
      the Not Before time before which the JWT MUST NOT be accepted for processing, or null if the claim is missing

    • getIssuedAt

      default @Nullable Instant getIssuedAt()
      Returns the Issued at (iat) claim which identifies the time at which the JWT was issued.
      Returns:
      the Issued at claim which identifies the time at which the JWT was issued, or null if the claim is missing

    • getId

      default @Nullable String getId()
      Returns the JWT ID (jti) claim which provides a unique identifier for the JWT.
      Returns:
      the JWT ID claim which provides a unique identifier for the JWT, or null if the claim is missing