Interface Claims

All Known Subinterfaces:

OpenIdClaims

All Known Implementing Classes:

JwtClaimsSetAdapter, JWTOpenIdClaims, MapClaims

public interface Claims

Authentication claims.

Since:

1.1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	ALL_CLAIMS
static final String	AUDIENCE
static final String	EXPIRATION_TIME
static final String	ISSUED_AT
static final String	ISSUER
static final String	KEY_ID
static final String	NOT_BEFORE
static final String	SUBJECT
static final String	TOKEN_ID

Method Summary

Modifier and Type	Method	Description
boolean	contains(String name)
@Nullable Object	get(String name)	Retrieves a value from the claims for the given name.
@NonNull Set<String>	names()

Field Details

ISSUER

static final String ISSUER

See Also:

• Constant Field Values

SUBJECT

static final String SUBJECT

See Also:

• Constant Field Values

EXPIRATION_TIME

static final String EXPIRATION_TIME

See Also:

• Constant Field Values

NOT_BEFORE

static final String NOT_BEFORE

See Also:

• Constant Field Values

ISSUED_AT

static final String ISSUED_AT

See Also:

• Constant Field Values

TOKEN_ID

static final String TOKEN_ID

See Also:

• Constant Field Values

KEY_ID

static final String KEY_ID

See Also:

• Constant Field Values

AUDIENCE

static final String AUDIENCE

See Also:

• Constant Field Values

ALL_CLAIMS

static final List<String> ALL_CLAIMS

Method Details

get

@Nullable Object get(String name)

Retrieves a value from the claims for the given name.

Parameters:

name - the claim name

Returns:

null if the claim not exist or the claim value.

names

@NonNull Set<String> names()

Returns:

All claim names.

contains

boolean contains(String name)

Parameters:

name - the claim name

Returns:

false if the claim does not exist.