EE4J 10.0.0 · jakarta.security.enterprise.identitystore.openid.JwtClaims

Modifier and Type	Field and Description
public static final JwtClaims	NONE Singleton instance representing no claims

Method Summary

Modifier and Type	Method and Description
public default List<String>	Returns: non-null set representing the values of `aud` claim getAudience() The recipients that the JWT is intended for.
public default Optional<Instant>	Returns: value of `exp` claim getExpirationTime() Expiration time on or after which the JWT MUST NOT be accepted for processing.
public default Optional<Instant>	Returns: value of `exp` claim getIssuedAt() The time at which the JWT was issued.
public default Optional<String>	Returns: value of `iss` claim getIssuer() The principal that issued the JWT
public default Optional<String>	Returns: value of `jti` claim getJwtId() Unique identifier for the JWT
public default Optional<Instant>	getNotBeforeTime() The time before which the JWT MUST NOT be accepted for processing.
public default Optional<String>	Returns: value of `sub` claim getSubject() The principal that is the subject of the JWT.
public default boolean	isBeforeValidity(Clock Clock representing reference time of checking clock, boolean indication, whether the claim is required, i. e. whether token without nbf is considered before validity required, Duration allowed clock skew to account for drift between provider and us skew) Check if JWT is before its defined validity
public default boolean	Returns: true when current time is past expiration time, or `exp` claim is not present and `required` is `true` isExpired(Clock Clock representing reference time of checking clock, boolean indication whether the claim is required, i. e. whether token with claim is considered expired required, Duration allowed clock skew to account for drift between provider and us skew) Check if JWT is expired
public default boolean	Returns: true if exp token is present and within limits and nbf is within limits when present isValid() Check JWT validity against current time with 1MIN clock skew.

Inherited from jakarta.security.enterprise.identitystore.openid.Claims:: getArrayStringClaim getDoubleClaim getIntClaim getLongClaim getNested getNumericDateClaim getStringClaim

NONE	back to summary
public static final JwtClaims NONE Singleton instance representing no claims

Method Detail

getAudience back to summary

getAudience	back to summary
public default List<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:List<String> non-null set representing the values of `aud` claim

public default List<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:List<String>: non-null set representing the values of aud claim

getExpirationTime back to summary

getExpirationTime	back to summary
public default Optional<Instant> getExpirationTime() Expiration time on or after which the JWT MUST NOT be accepted for processing. Returns:Optional<Instant> value of `exp` claim

public default Optional<Instant> getExpirationTime()

Expiration time on or after which the JWT MUST NOT be accepted for processing.

Returns:Optional<Instant>: value of exp claim

getIssuedAt back to summary

getIssuedAt	back to summary
public default Optional<Instant> getIssuedAt() The time at which the JWT was issued. Returns:Optional<Instant> value of `exp` claim

public default Optional<Instant> getIssuedAt()

The time at which the JWT was issued.

Returns:Optional<Instant>: value of exp claim

getIssuer back to summary

getIssuer	back to summary
public default Optional<String> getIssuer() The principal that issued the JWT Returns:Optional<String> value of `iss` claim

public default Optional<String> getIssuer()

The principal that issued the JWT

Returns:Optional<String>: value of iss claim

getJwtId back to summary

getJwtId	back to summary
public default Optional<String> getJwtId() Unique identifier for the JWT Returns:Optional<String> value of `jti` claim

public default Optional<String> getJwtId()

Unique identifier for the JWT

Returns:Optional<String>: value of jti claim

getNotBeforeTime	back to summary
public default Optional<Instant> getNotBeforeTime() The time before which the JWT MUST NOT be accepted for processing.

getSubject back to summary

getSubject	back to summary
public default Optional<String> getSubject() The principal that is the subject of the JWT. The claims in a JWT are normally statements about the subject. Returns:Optional<String> value of `sub` claim

public default Optional<String> getSubject()

The principal that is the subject of the JWT. The claims in a JWT are normally statements about the subject.

Returns:Optional<String>: value of sub claim

isBeforeValidity	back to summary
public default boolean isBeforeValidity(Clock clock, boolean required, Duration skew) Check if JWT is before its defined validity Parameters clock:Clock Clock representing reference time of checking required:boolean indication, whether the claim is required, i. e. whether token without nbf is considered before validity skew:Duration allowed clock skew to account for drift between provider and us

isBeforeValidity

back to summary

public default boolean isBeforeValidity(Clock clock, boolean required, Duration skew)

Check if JWT is before its defined validity

Parameters

clock:Clock: Clock representing reference time of checking
required:boolean: indication, whether the claim is required, i. e. whether token without nbf is considered before validity
skew:Duration: allowed clock skew to account for drift between provider and us

isExpired back to summary

isExpired	back to summary
public default boolean isExpired(Clock clock, boolean required, Duration skew) Check if JWT is expired Parameters clock:Clock Clock representing reference time of checking required:boolean indication whether the claim is required, i. e. whether token with claim is considered expired skew:Duration allowed clock skew to account for drift between provider and us Returns:boolean true when current time is past expiration time, or `exp` claim is not present and `required` is `true`

public default boolean isExpired(Clock clock, boolean required, Duration skew)

Check if JWT is expired

Parameters

clock:Clock: Clock representing reference time of checking
required:boolean: indication whether the claim is required, i. e. whether token with claim is considered expired
skew:Duration: allowed clock skew to account for drift between provider and us

Returns:boolean

true when current time is past expiration time, or exp claim is not present and required is true

isValid	back to summary
public default boolean isValid() Check JWT validity against current time with 1MIN clock skew. Returns:boolean true if exp token is present and within limits and nbf is within limits when present

isValid

back to summary

public default boolean isValid()

Check JWT validity against current time with 1MIN clock skew.

Returns:boolean: true if exp token is present and within limits and nbf is within limits when present

public Interface JwtClaims

Field Summary

Method Summary

Field Detail

Method Detail