JwtClaims

All Superinterfaces:

Claims
```
public interface JwtClaims
extends Claims
```
Standard JWT claims. A token typically.

Field Summary

Fields
Modifier and Type Field and Description

static JwtClaims NONE
Singleton instance representing no claims

Fields
Modifier and Type	Field and Description
`static JwtClaims`	`NONE` Singleton instance representing no claims

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default java.util.List<java.lang.String>`	`getAudience()` The recipients that the JWT is intended for.
`default java.util.Optional<java.time.Instant>`	`getExpirationTime()` Expiration time on or after which the JWT MUST NOT be accepted for processing.
`default java.util.Optional<java.time.Instant>`	`getIssuedAt()` The time at which the JWT was issued.
`default java.util.Optional<java.lang.String>`	`getIssuer()` The principal that issued the JWT
`default java.util.Optional<java.lang.String>`	`getJwtId()` Unique identifier for the JWT
`default java.util.Optional<java.time.Instant>`	`getNotBeforeTime()` The time before which the JWT MUST NOT be accepted for processing.
`default java.util.Optional<java.lang.String>`	`getSubject()` The principal that is the subject of the JWT.
`default boolean`	`isBeforeValidity(java.time.Clock clock, boolean required, java.time.Duration skew)` Check if JWT is before its defined validity
`default boolean`	`isExpired(java.time.Clock clock, boolean required, java.time.Duration skew)` Check if JWT is expired
`default boolean`	`isValid()` Check JWT validity against current time with 1MIN clock skew.

Methods inherited from interface jakarta.security.enterprise.identitystore.openid.Claims
getArrayStringClaim, getDoubleClaim, getIntClaim, getLongClaim, getNested, getNumericDateClaim, getStringClaim

- Field Detail
  - NONE
```
static final JwtClaims NONE
```
    Singleton instance representing no claims
- Method Detail
  - getIssuer
```
default java.util.Optional<java.lang.String> getIssuer()
```
    The principal that issued the JWT
    
    Returns:
    
    value of iss claim
  - getSubject
```
default java.util.Optional<java.lang.String> getSubject()
```
    The principal that is the subject of the JWT. The claims in a JWT are normally statements about the subject.
    
    Returns:
    
    value of sub claim
  - getAudience
```
default java.util.List<java.lang.String> getAudience()
```
    The recipients that the JWT is intended for. To ease work with the field, audience is always represented as list, also in special cases -- it is singleton list when it was a string in the token, and empty set if it was not present.
    
    Returns:
    
    non-null set representing the values of aud claim
  - getExpirationTime
```
default java.util.Optional<java.time.Instant> getExpirationTime()
```
    Expiration time on or after which the JWT MUST NOT be accepted for processing.
    
    Returns:
    
    value of exp claim
  - isExpired
```
default boolean isExpired(java.time.Clock clock,
                          boolean required,
                          java.time.Duration skew)
```
    Check if JWT is expired
    
    Parameters:
    
    clock - Clock representing reference time of checking
    
    required - indication whether the claim is required, i. e. whether token with claim is considered expired
    
    skew - allowed clock skew to account for drift between provider and us
    
    Returns:
    
    true when current time is past expiration time, or exp claim is not present and required is true
  - getNotBeforeTime
```
default java.util.Optional<java.time.Instant> getNotBeforeTime()
```
    The time before which the JWT MUST NOT be accepted for processing.
    
    Returns:
  - isBeforeValidity
```
default boolean isBeforeValidity(java.time.Clock clock,
                                 boolean required,
                                 java.time.Duration skew)
```
    Check if JWT is before its defined validity
    
    Parameters:
    
    clock - Clock representing reference time of checking
    
    required - indication, whether the claim is required, i. e. whether token without nbf is considered before validity
    
    skew - allowed clock skew to account for drift between provider and us
    
    Returns:
  - isValid
```
default boolean isValid()
```
    Check JWT validity against current time with 1MIN clock skew.
    
    Returns:
    
    true if exp token is present and within limits and nbf is within limits when present
  - getIssuedAt
```
default java.util.Optional<java.time.Instant> getIssuedAt()
```
    The time at which the JWT was issued.
    
    Returns:
    
    value of exp claim
  - getJwtId
```
default java.util.Optional<java.lang.String> getJwtId()
```
    Unique identifier for the JWT
    
    Returns:
    
    value of jti claim

Interface JwtClaims

Field Summary

Method Summary

Methods inherited from interface jakarta.security.enterprise.identitystore.openid.Claims

Field Detail

NONE

Method Detail

getIssuer

getSubject

getAudience

getExpirationTime

isExpired

getNotBeforeTime

isBeforeValidity

isValid

getIssuedAt

getJwtId