Uses of Interface
io.jsonwebtoken.Claims

Packages that use Claims

Package	Description
io.jsonwebtoken

Uses of Claims in io.jsonwebtoken

Fields in io.jsonwebtoken with type parameters of type Claims

Modifier and Type	Field and Description
static JwtVisitor<Jws<Claims>>	Jws.CLAIMS Visitor implementation that ensures the visited JWT is a JSON Web Signature ('JWS') message with a cryptographically authenticated/verified Claims payload, and rejects all others with an UnsupportedJwtException.
static JwtVisitor<Jwe<Claims>>	Jwe.CLAIMS Visitor implementation that ensures the visited JWT is a JSON Web Encryption ('JWE') message with an authenticated and decrypted Claims payload, and rejects all others with an UnsupportedJwtException.
static JwtVisitor<Jwt<Header,Claims>>	Jwt.UNSECURED_CLAIMS Visitor implementation that ensures the visited JWT is an unsecured Claims JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.

Methods in io.jsonwebtoken that return Claims

Modifier and Type	Method and Description
static Claims	Jwts.claims(Map<String,Object> claims) Deprecated. since 0.12.0 in favor of Jwts.Jwts.claims().putAll(map).build(). This method will be removed before 1.0.
Claims	ClaimJwtException.getClaims() Returns the Claims that failed validation.

Methods in io.jsonwebtoken that return types with arguments of type Claims

Modifier and Type	Method and Description
Jws<Claims>	JwtParser.parseClaimsJws(CharSequence jws) Deprecated. since 0.12.0 in favor of JwtParser.parseSignedClaims(CharSequence).
Jwt<Header,Claims>	JwtParser.parseClaimsJwt(CharSequence jwt) Deprecated. since 0.12.0 in favor of JwtParser.parseUnsecuredClaims(CharSequence).
Jwe<Claims>	JwtParser.parseEncryptedClaims(CharSequence jwe) Parses the jwe argument, expected to be an encrypted Claims JWE.
Jws<Claims>	JwtParser.parseSignedClaims(CharSequence jws) Parses the jws argument, expected to be a cryptographically-signed Claims JWS.
Jws<Claims>	JwtParser.parseSignedClaims(CharSequence jws, byte[] unencodedPayload) Parses a JWS known to use the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option, using the specified unencodedPayload for signature verification.
Jws<Claims>	JwtParser.parseSignedClaims(CharSequence jws, InputStream unencodedPayload) Parses a JWS known to use the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option, using the bytes from the specified unencodedPayload stream for signature verification and Claims creation.
Jwt<Header,Claims>	JwtParser.parseUnsecuredClaims(CharSequence jwt) Parses the jwt argument, expected to be an unsecured Claims JWT.

Methods in io.jsonwebtoken with parameters of type Claims

Modifier and Type	Method and Description
Key	SigningKeyResolverAdapter.resolveSigningKey(JwsHeader header, Claims claims) Deprecated.
Key	SigningKeyResolver.resolveSigningKey(JwsHeader header, Claims claims) Deprecated. Returns the signing key that should be used to validate a digital signature for the Claims JWS with the specified header and claims.
byte[]	SigningKeyResolverAdapter.resolveSigningKeyBytes(JwsHeader header, Claims claims) Deprecated. Convenience method invoked by SigningKeyResolverAdapter.resolveSigningKey(JwsHeader, Claims) that obtains the necessary signing key bytes.

Method parameters in io.jsonwebtoken with type arguments of type Claims

Modifier and Type	Method and Description
T	JwtHandler.onClaimsJwe(Jwe<Claims> jwe) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWE.
T	JwtHandlerAdapter.onClaimsJwe(Jwe<Claims> jwe)
T	JwtHandler.onClaimsJws(Jws<Claims> jws) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWS.
T	JwtHandlerAdapter.onClaimsJws(Jws<Claims> jws)
T	JwtHandler.onClaimsJwt(Jwt<Header,Claims> jwt) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT.
T	JwtHandlerAdapter.onClaimsJwt(Jwt<Header,Claims> jwt)
T	JwtHandlerAdapter.onDecryptedClaims(Jwe<Claims> jwe)
T	SupportedJwtVisitor.onDecryptedClaims(Jwe<Claims> jwe) Handles an encountered JWE message that has been authenticated and decrypted, and has a Claims payload.
T	JwtHandlerAdapter.onUnsecuredClaims(Jwt<Header,Claims> jwt)
T	SupportedJwtVisitor.onUnsecuredClaims(Jwt<Header,Claims> jwt) Handles an encountered unsecured Claims JWT - one that is not cryptographically signed nor encrypted, and has a Claims payload.
T	JwtHandlerAdapter.onVerifiedClaims(Jws<Claims> jws)
T	SupportedJwtVisitor.onVerifiedClaims(Jws<Claims> jws) Handles an encountered JWS message that has been cryptographically verified/authenticated and has a Claims payload.

Constructors in io.jsonwebtoken with parameters of type Claims

Constructor and Description
ClaimJwtException(Header header, Claims claims, String message) Creates a new instance with the specified header, claims and exception message.
ClaimJwtException(Header header, Claims claims, String message, Throwable cause) Creates a new instance with the specified header, claims and exception message as a result of encountering the specified cause.
ExpiredJwtException(Header header, Claims claims, String message) Creates a new instance with the specified header, claims, and explanation message.
ExpiredJwtException(Header header, Claims claims, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.
IncorrectClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified header, claims and explanation message.
IncorrectClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.
InvalidClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified header, claims and explanation message.
InvalidClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.
MissingClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified explanation message.
MissingClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Deprecated. since 0.12.0 since it is not used in JJWT's codebase
PrematureJwtException(Header header, Claims claims, String message) Creates a new instance with the specified explanation message.
PrematureJwtException(Header header, Claims claims, String message, Throwable cause) Deprecated. since 0.12.0 since it is not used in JJWT's codebase