io.jsonwebtoken

Interface Claims

All Superinterfaces:

ClaimsMutator<Claims>, java.util.Map<java.lang.String,java.lang.Object>

public interface Claims
extends java.util.Map<java.lang.String,java.lang.Object>, ClaimsMutator<Claims>

A JWT Claims set.

This is ultimately a JSON map and any values can be added to it, but JWT standard names are provided as type-safe getters and setters for convenience.

Because this interface extends Map<String, Object>, if you would like to add your own properties, you simply use map methods, for example:

 claims.put("someKey", "someValue");
 

Creation

It is easiest to create a Claims instance by calling one of the JWTs.claims() factory methods.

Since:

0.1

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUDIENCE JWT Audience claims parameter name: "aud"
static java.lang.String	EXPIRATION JWT Expiration claims parameter name: "exp"
static java.lang.String	ID JWT JWT ID claims parameter name: "jti"
static java.lang.String	ISSUED_AT JWT Issued At claims parameter name: "iat"
static java.lang.String	ISSUER JWT Issuer claims parameter name: "iss"
static java.lang.String	NOT_BEFORE JWT Not Before claims parameter name: "nbf"
static java.lang.String	SUBJECT JWT Subject claims parameter name: "sub"

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(java.lang.String claimName, java.lang.Class<T> requiredType) Returns the JWTs claim (claimName) value as a type requiredType, or null if not present.
java.lang.String	getAudience() Returns the JWT aud (audience) value or null if not present.
java.util.Date	getExpiration() Returns the JWT exp (expiration) timestamp or null if not present.
java.lang.String	getId() Returns the JWTs jti (JWT ID) value or null if not present.
java.util.Date	getIssuedAt() Returns the JWT iat (issued at) timestamp or null if not present.
java.lang.String	getIssuer() Returns the JWT iss (issuer) value or null if not present.
java.util.Date	getNotBefore() Returns the JWT nbf (not before) timestamp or null if not present.
java.lang.String	getSubject() Returns the JWT sub (subject) value or null if not present.
Claims	setAudience(java.lang.String aud) Sets the JWT aud (audience) value.
Claims	setExpiration(java.util.Date exp) Sets the JWT exp (expiration) timestamp.
Claims	setId(java.lang.String jti) Sets the JWT jti (JWT ID) value.
Claims	setIssuedAt(java.util.Date iat) Sets the JWT iat (issued at) timestamp.
Claims	setIssuer(java.lang.String iss) Sets the JWT iss (issuer) value.
Claims	setNotBefore(java.util.Date nbf) Sets the JWT nbf (not before) timestamp.
Claims	setSubject(java.lang.String sub) Sets the JWT sub (subject) value.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

ISSUER

static final java.lang.String ISSUER

JWT Issuer claims parameter name: "iss"

See Also:

Constant Field Values

SUBJECT

static final java.lang.String SUBJECT

JWT Subject claims parameter name: "sub"

See Also:

Constant Field Values

AUDIENCE

static final java.lang.String AUDIENCE

JWT Audience claims parameter name: "aud"

See Also:

Constant Field Values

EXPIRATION

static final java.lang.String EXPIRATION

JWT Expiration claims parameter name: "exp"

See Also:

Constant Field Values

NOT_BEFORE

static final java.lang.String NOT_BEFORE

JWT Not Before claims parameter name: "nbf"

See Also:

Constant Field Values

ISSUED_AT

static final java.lang.String ISSUED_AT

JWT Issued At claims parameter name: "iat"

See Also:

Constant Field Values

ID

static final java.lang.String ID

JWT JWT ID claims parameter name: "jti"

See Also:

Constant Field Values

Method Detail

getIssuer

java.lang.String getIssuer()

Returns the JWT iss (issuer) value or null if not present.

Returns:

the JWT iss value or null if not present.

setIssuer

Claims setIssuer(java.lang.String iss)

Sets the JWT iss (issuer) value. A null value will remove the property from the JSON map.

Specified by:

setIssuer in interface ClaimsMutator<Claims>

Parameters:

iss - the JWT iss value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

getSubject

java.lang.String getSubject()

Returns the JWT sub (subject) value or null if not present.

Returns:

the JWT sub value or null if not present.

setSubject

Claims setSubject(java.lang.String sub)

Sets the JWT sub (subject) value. A null value will remove the property from the JSON map.

Specified by:

setSubject in interface ClaimsMutator<Claims>

Parameters:

sub - the JWT sub value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

getAudience

java.lang.String getAudience()

Returns the JWT aud (audience) value or null if not present.

Returns:

the JWT aud value or null if not present.

setAudience

Claims setAudience(java.lang.String aud)

Sets the JWT aud (audience) value. A null value will remove the property from the JSON map.

Specified by:

setAudience in interface ClaimsMutator<Claims>

Parameters:

aud - the JWT aud value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

getExpiration

java.util.Date getExpiration()

Returns the JWT exp (expiration) timestamp or null if not present.

A JWT obtained after this timestamp should not be used.

Returns:

the JWT exp value or null if not present.

setExpiration

Claims setExpiration(java.util.Date exp)

Sets the JWT exp (expiration) timestamp. A null value will remove the property from the JSON map.

A JWT obtained after this timestamp should not be used.

Specified by:

setExpiration in interface ClaimsMutator<Claims>

Parameters:

exp - the JWT exp value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

getNotBefore

java.util.Date getNotBefore()

Returns the JWT nbf (not before) timestamp or null if not present.

A JWT obtained before this timestamp should not be used.

Returns:

the JWT nbf value or null if not present.

setNotBefore

Claims setNotBefore(java.util.Date nbf)

Sets the JWT nbf (not before) timestamp. A null value will remove the property from the JSON map.

A JWT obtained before this timestamp should not be used.

Specified by:

setNotBefore in interface ClaimsMutator<Claims>

Parameters:

nbf - the JWT nbf value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

getIssuedAt

java.util.Date getIssuedAt()

Returns the JWT iat (issued at) timestamp or null if not present.

If present, this value is the timestamp when the JWT was created.

Returns:

the JWT iat value or null if not present.

setIssuedAt

Claims setIssuedAt(java.util.Date iat)

Sets the JWT iat (issued at) timestamp. A null value will remove the property from the JSON map.

The value is the timestamp when the JWT was created.

Specified by:

setIssuedAt in interface ClaimsMutator<Claims>

Parameters:

iat - the JWT iat value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

getId

java.lang.String getId()

Returns the JWTs jti (JWT ID) value or null if not present.

This value is a CaSe-SenSiTiVe unique identifier for the JWT. If available, this value is expected to be assigned in a manner that ensures that there is a negligible probability that the same value will be accidentally assigned to a different data object. The ID can be used to prevent the JWT from being replayed.

Returns:

the JWT jti value or null if not present.

setId

Claims setId(java.lang.String jti)

Sets the JWT jti (JWT ID) value. A null value will remove the property from the JSON map.

This value is a CaSe-SenSiTiVe unique identifier for the JWT. If specified, this value MUST be assigned in a manner that ensures that there is a negligible probability that the same value will be accidentally assigned to a different data object. The ID can be used to prevent the JWT from being replayed.

Specified by:

setId in interface ClaimsMutator<Claims>

Parameters:

jti - the JWT jti value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.

get

<T> T get(java.lang.String claimName,
        java.lang.Class<T> requiredType)

Returns the JWTs claim (claimName) value as a type requiredType, or null if not present.

JJWT only converts simple String, Date, Long, Integer, Short and Byte types automatically. Anything more complex is expected to be already converted to your desired type by the JSON Deserializer implementation. You may specify a custom Deserializer for a JwtParser with the desired conversion configuration via the JwtParserBuilder.deserializeJsonWith(io.jsonwebtoken.io.Deserializer<java.util.Map<java.lang.String, ?>>) method. See custom JSON processor for more information. If using Jackson, you can specify custom claim POJO types as described in custom claim types.

Type Parameters:

T - the type of the value expected to be returned

Parameters:

claimName - name of claim

requiredType - the type of the value expected to be returned

Returns:

the JWT claimName value or null if not present.

Throws:

RequiredTypeException - throw if the claim value is not null and not of type requiredType