dev.paseto.jpaseto

Interface Claims

All Superinterfaces:

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

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

A map representing a the body of a paseto token. Along with get arbitrary values using the Map interface, methods to access registered claims.

Since:

0.1.0

See Also:

get(String, Class)

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 Paseto Audience claims parameter name: "aud".
static java.lang.String	EXPIRATION Paseto Expiration claims parameter name: "exp".
static java.lang.String	ISSUED_AT Paseto Issued At claims parameter name: "iat".
static java.lang.String	ISSUER Paseto Issuer claims parameter name: "iss".
static java.lang.String	NOT_BEFORE Paseto Not Before claims parameter name: "nbf".
static java.lang.String	SUBJECT Paseto Subject claims parameter name: "sub".
static java.lang.String	TOKEN_ID Paseto Token ID claims parameter name: "jti".

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.String claimName, java.lang.Class<T> requiredType)
default java.lang.String	getAudience()
default java.time.Instant	getExpiration()
default java.time.Instant	getIssuedAt()
default java.lang.String	getIssuer()
default java.time.Instant	getNotBefore()
default java.lang.String	getSubject()
default java.lang.String	getTokenId()

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 Detail

ISSUER

static final java.lang.String ISSUER

Paseto Issuer claims parameter name: "iss".

See Also:

Constant Field Values

SUBJECT

static final java.lang.String SUBJECT

Paseto Subject claims parameter name: "sub".

See Also:

Constant Field Values

AUDIENCE

static final java.lang.String AUDIENCE

Paseto Audience claims parameter name: "aud".

See Also:

Constant Field Values

EXPIRATION

static final java.lang.String EXPIRATION

Paseto Expiration claims parameter name: "exp".

See Also:

Constant Field Values

NOT_BEFORE

static final java.lang.String NOT_BEFORE

Paseto Not Before claims parameter name: "nbf".

See Also:

Constant Field Values

ISSUED_AT

static final java.lang.String ISSUED_AT

Paseto Issued At claims parameter name: "iat".

See Also:

Constant Field Values

TOKEN_ID

static final java.lang.String TOKEN_ID

Paseto Token ID claims parameter name: "jti".

See Also:

Constant Field Values

Method Detail

get

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

getIssuer

default java.lang.String getIssuer()

getSubject

default java.lang.String getSubject()

getAudience

default java.lang.String getAudience()

getExpiration

default java.time.Instant getExpiration()

getNotBefore

default java.time.Instant getNotBefore()

getIssuedAt

default java.time.Instant getIssuedAt()

getTokenId

default java.lang.String getTokenId()