org.springframework.security.oauth2.core

Interface ClaimAccessor

All Known Subinterfaces:

IdTokenClaimAccessor, OidcUser, StandardClaimAccessor

All Known Implementing Classes:

DefaultOidcUser, OidcIdToken, OidcUserInfo

public interface ClaimAccessor

An "accessor" for a set of claims that may be used for assertions.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
default java.lang.Boolean	containsClaim(java.lang.String claim) Returns true if the claim exists in getClaims(), otherwise false.
default <T> T	getClaim(java.lang.String claim) Returns the claim value as a T type.
default java.lang.Boolean	getClaimAsBoolean(java.lang.String claim) Returns the claim value as a Boolean or null if it does not exist.
default java.time.Instant	getClaimAsInstant(java.lang.String claim) Returns the claim value as an Instant or null if it does not exist.
default java.util.Map<java.lang.String,java.lang.Object>	getClaimAsMap(java.lang.String claim) Returns the claim value as a Map<String, Object> or null if it does not exist or cannot be assigned to a Map.
default java.lang.String	getClaimAsString(java.lang.String claim) Returns the claim value as a String or null if it does not exist or is equal to null.
default java.util.List<java.lang.String>	getClaimAsStringList(java.lang.String claim) Returns the claim value as a List<String> or null if it does not exist or cannot be assigned to a List.
default java.net.URL	getClaimAsURL(java.lang.String claim) Returns the claim value as an URL or null if it does not exist.
java.util.Map<java.lang.String,java.lang.Object>	getClaims() Returns a set of claims that may be used for assertions.

Method Detail

getClaims

java.util.Map<java.lang.String,java.lang.Object> getClaims()

Returns a set of claims that may be used for assertions.

Returns:

a Map of claims

getClaim

default <T> T getClaim(java.lang.String claim)

Returns the claim value as a T type. The claim value is expected to be of type T.

Type Parameters:

T - the type of the claim value

Parameters:

claim - the name of the claim

Returns:

the claim value

Since:

5.2

containsClaim

default java.lang.Boolean containsClaim(java.lang.String claim)

Returns true if the claim exists in getClaims(), otherwise false.

Parameters:

claim - the name of the claim

Returns:

true if the claim exists, otherwise false

getClaimAsString

default java.lang.String getClaimAsString(java.lang.String claim)

Returns the claim value as a String or null if it does not exist or is equal to null.

Parameters:

claim - the name of the claim

Returns:

the claim value or null if it does not exist or is equal to null

getClaimAsBoolean

default java.lang.Boolean getClaimAsBoolean(java.lang.String claim)

Returns the claim value as a Boolean or null if it does not exist.

Parameters:

claim - the name of the claim

Returns:

the claim value or null if it does not exist

getClaimAsInstant

default java.time.Instant getClaimAsInstant(java.lang.String claim)

Returns the claim value as an Instant or null if it does not exist.

Parameters:

claim - the name of the claim

Returns:

the claim value or null if it does not exist

getClaimAsURL

default java.net.URL getClaimAsURL(java.lang.String claim)

Returns the claim value as an URL or null if it does not exist.

Parameters:

claim - the name of the claim

Returns:

the claim value or null if it does not exist

getClaimAsMap

default java.util.Map<java.lang.String,java.lang.Object> getClaimAsMap(java.lang.String claim)

Returns the claim value as a Map<String, Object> or null if it does not exist or cannot be assigned to a Map.

Parameters:

claim - the name of the claim

Returns:

the claim value or null if it does not exist or cannot be assigned to a Map

getClaimAsStringList

default java.util.List<java.lang.String> getClaimAsStringList(java.lang.String claim)

Returns the claim value as a List<String> or null if it does not exist or cannot be assigned to a List.

Parameters:

claim - the name of the claim

Returns:

the claim value or null if it does not exist or cannot be assigned to a List