io.jsonwebtoken

Interface Claims

All Superinterfaces:

Identifiable, Map<String,Object>

public interface Claims
extends Map<String,Object>, Identifiable

A JWT Claims set.

This is an immutable JSON map with convenient type-safe getters for JWT standard claim names.

Additionally, this interface also extends Map<String, Object>, so you can use standard Map accessor/iterator methods as desired, for example:

 claims.get("someKey");

However, because Claims instances are immutable, calling any of the map mutation methods (such as Map.put, etc) will result in a runtime exception. The Map interface is implemented specifically for the convenience of working with existing Map-based utilities and APIs.

Since:

0.1

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(String claimName, Class<T> requiredType) Returns the JWTs claim (claimName) value as a requiredType instance, or null if not present.
Set<String>	getAudience() Returns the JWT aud (audience) value or null if not present.
Date	getExpiration() Returns the JWT exp (expiration) timestamp or null if not present.
String	getId() Returns the JWTs jti (JWT ID) value or null if not present.
Date	getIssuedAt() Returns the JWT iat (issued at) timestamp or null if not present.
String	getIssuer() Returns the JWT iss (issuer) value or null if not present.
Date	getNotBefore() Returns the JWT nbf (not before) timestamp or null if not present.
String	getSubject() Returns the JWT sub (subject) value or null if not present.

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 String ISSUER

JWT Issuer claims parameter name: "iss"

See Also:

Constant Field Values

SUBJECT

static final String SUBJECT

JWT Subject claims parameter name: "sub"

See Also:

Constant Field Values

AUDIENCE

static final String AUDIENCE

JWT Audience claims parameter name: "aud"

See Also:

Constant Field Values

EXPIRATION

static final String EXPIRATION

JWT Expiration claims parameter name: "exp"

See Also:

Constant Field Values

NOT_BEFORE

static final String NOT_BEFORE

JWT Not Before claims parameter name: "nbf"

See Also:

Constant Field Values

ISSUED_AT

static final String ISSUED_AT

JWT Issued At claims parameter name: "iat"

See Also:

Constant Field Values

ID

static final String ID

JWT JWT ID claims parameter name: "jti"

See Also:

Constant Field Values

Method Detail

getIssuer

String getIssuer()

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

Returns:

the JWT iss value or null if not present.

getSubject

String getSubject()

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

Returns:

the JWT sub value or null if not present.

getAudience

Set<String> getAudience()

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

Returns:

the JWT aud value or null if not present.

getExpiration

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.

getNotBefore

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.

getIssuedAt

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.

getId

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.

Specified by:

getId in interface Identifiable

Returns:

the JWT jti value or null if not present.

get

<T> T get(String claimName,
        Class<T> requiredType)

Returns the JWTs claim (claimName) value as a requiredType instance, 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 parser. You may specify a custom JSON processor using the JwtParserBuilder's json(Deserializer) method. See the JJWT documentation on custom JSON processors 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

See Also:

JJWT JSON Support