Class Jwt

java.lang.Object

org.springframework.security.oauth2.core.AbstractOAuth2Token

org.springframework.security.oauth2.jwt.Jwt

All Implemented Interfaces:

Serializable, ClaimAccessor, OAuth2Token, JwtClaimAccessor

public class Jwt
extends AbstractOAuth2Token
implements JwtClaimAccessor

An implementation of an AbstractOAuth2Token representing a JSON Web Token (JWT).

JWTs represent a set of "claims" as a JSON object that may be encoded in a JSON Web Signature (JWS) and/or JSON Web Encryption (JWE) structure. The JSON object, also known as the JWT Claims Set, consists of one or more claim name/value pairs. The claim name is a String and the claim value is an arbitrary JSON object.

Since:

5.0

See Also:

• AbstractOAuth2Token
• JwtClaimAccessor
• JSON Web Token (JWT)
• JSON Web Signature (JWS)
• JSON Web Encryption (JWE)
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Jwt.Builder	Helps configure a Jwt

Constructor Summary

Constructors

Constructor	Description
Jwt(String tokenValue, Instant issuedAt, Instant expiresAt, Map<String,Object> headers, Map<String,Object> claims)	Constructs a Jwt using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getClaims()	Returns the JWT Claims Set.
Map<String,Object>	getHeaders()	Returns the JOSE header(s).
static Jwt.Builder	withTokenValue(String tokenValue)	Return a Jwt.Builder

Methods inherited from class AbstractOAuth2Token

equals, getExpiresAt, getIssuedAt, getTokenValue, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ClaimAccessor

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

Methods inherited from interface JwtClaimAccessor

getAudience, getExpiresAt, getId, getIssuedAt, getIssuer, getNotBefore, getSubject

Constructor Details

Jwt

public Jwt(String tokenValue,
 Instant issuedAt,
 Instant expiresAt,
 Map<String,Object> headers,
 Map<String,Object> claims)

Constructs a Jwt using the provided parameters.

Parameters:

tokenValue - the token value

issuedAt - the time at which the JWT was issued

expiresAt - the expiration time on or after which the JWT MUST NOT be accepted

headers - the JOSE header(s)

claims - the JWT Claims Set

Method Details

getHeaders

public Map<String,Object> getHeaders()

Returns the JOSE header(s).

Returns:

a Map of the JOSE header(s)

getClaims

public Map<String,Object> getClaims()

Returns the JWT Claims Set.

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of the JWT Claims Set

withTokenValue

public static Jwt.Builder withTokenValue(String tokenValue)

Return a Jwt.Builder

Returns:

A Jwt.Builder