Package com.ibm.websphere.security.jwt

Interface Claims

All Superinterfaces:

Map<String,Object>

public interface Claims
extends Map<String,Object>

The Claims interface represents JSON Web Token (JWT) payload claims and offers convenient get methods for some of the well known JWT claims such as "iss", "exp", and "iat".

Since:

1.0

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUDIENCE	The AUDIENCE is used to represent the "aud" claim
static final String	AZP	The AZP is used to represent the "azp" claim
static final String	EXPIRATION	The EXPIRATION is used to represent the "exp" claim
static final String	ID	The ID is used to represent the "jti" claim
static final String	ISSUED_AT	The ISSUED_AT is used to represent the "iat" claim
static final String	ISSUER	The ISSUER is used to represent the "iss" claim
static final String	NOT_BEFORE	The NOT_BEFORE is used to represent the "nbf" claim
static final String	SUBJECT	The SUBJECT is used to represent the "sub" claim
static final String	TOKEN_TYPE	The TOKEN_TYPE is used to represent the "token_type" claim

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAllClaims()
List<String>	getAudience()
String	getAuthorizedParty()
<T> T	getClaim(String claimName, Class<T> requiredType)
long	getExpiration()
long	getIssuedAt()
String	getIssuer()
String	getJwtId()
long	getNotBefore()
String	getSubject()
String	toJsonString()

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Details

ISSUER

static final String ISSUER

The ISSUER is used to represent the "iss" claim

See Also:

• Constant Field Values

SUBJECT

static final String SUBJECT

The SUBJECT is used to represent the "sub" claim

See Also:

• Constant Field Values

AUDIENCE

static final String AUDIENCE

The AUDIENCE is used to represent the "aud" claim

See Also:

• Constant Field Values

EXPIRATION

static final String EXPIRATION

The EXPIRATION is used to represent the "exp" claim

See Also:

• Constant Field Values

NOT_BEFORE

static final String NOT_BEFORE

The NOT_BEFORE is used to represent the "nbf" claim

See Also:

• Constant Field Values

ISSUED_AT

static final String ISSUED_AT

The ISSUED_AT is used to represent the "iat" claim

See Also:

• Constant Field Values

ID

static final String ID

The ID is used to represent the "jti" claim

See Also:

• Constant Field Values

AZP

static final String AZP

The AZP is used to represent the "azp" claim

See Also:

• Constant Field Values

TOKEN_TYPE

static final String TOKEN_TYPE

The TOKEN_TYPE is used to represent the "token_type" claim

See Also:

• Constant Field Values

Method Details

getIssuer

String getIssuer()

Returns:

The "iss" claim

getSubject

String getSubject()

Returns:

The "sub" claim

getAudience

List<String> getAudience()

Returns:

The "aud" claim

getExpiration

long getExpiration()

Returns:

The "exp" claim

getNotBefore

long getNotBefore()

Returns:

The "nbf" claim

getIssuedAt

long getIssuedAt()

Returns:

The "iat" claim

getJwtId

String getJwtId()

Returns:

The "jti" claim

getAuthorizedParty

String getAuthorizedParty()

Returns:

The "azp" claim

getClaim

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

Parameters:

claimName - claim name

requiredType - This is the required type of the claim value

Returns:

The claim value that matches the requiredType

getAllClaims

Map<String,Object> getAllClaims()

Returns:

All the claims

toJsonString

String toJsonString()

Returns:

All the claims in JSON string format