Class OAuth2TokenIntrospection

java.lang.Object

org.springframework.security.oauth2.server.authorization.OAuth2TokenIntrospection

All Implemented Interfaces:

Serializable, ClaimAccessor, OAuth2TokenIntrospectionClaimAccessor

public final class OAuth2TokenIntrospection
extends Object
implements OAuth2TokenIntrospectionClaimAccessor, Serializable

A representation of the claims returned in an OAuth 2.0 Token Introspection Response.

Since:

7.0

See Also:

• OAuth2TokenIntrospectionClaimAccessor
• Section 2.2 Introspection Response
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OAuth2TokenIntrospection.Builder	A builder for OAuth2TokenIntrospection.

Method Summary

Modifier and Type	Method	Description
static OAuth2TokenIntrospection.Builder	builder()	Constructs a new OAuth2TokenIntrospection.Builder initialized with the active claim to false.
static OAuth2TokenIntrospection.Builder	builder(boolean active)	Constructs a new OAuth2TokenIntrospection.Builder initialized with the provided active claim.
Map<String,Object>	getClaims()	Returns the claims in the Token Introspection Response.
static OAuth2TokenIntrospection.Builder	withClaims(Map<String,Object> claims)	Constructs a new OAuth2TokenIntrospection.Builder initialized with the provided claims.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ClaimAccessor

getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, hasClaim

Methods inherited from interface OAuth2TokenIntrospectionClaimAccessor

getAudience, getClientId, getExpiresAt, getId, getIssuedAt, getIssuer, getNotBefore, getScopes, getSubject, getTokenType, getUsername, isActive

Method Details

getClaims

public Map<String,Object> getClaims()

Returns the claims in the Token Introspection Response.

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of the claims

builder

public static OAuth2TokenIntrospection.Builder builder()

Constructs a new OAuth2TokenIntrospection.Builder initialized with the active claim to false.

Returns:

the OAuth2TokenIntrospection.Builder

builder

public static OAuth2TokenIntrospection.Builder builder(boolean active)

Constructs a new OAuth2TokenIntrospection.Builder initialized with the provided active claim.

Parameters:

active - true if the token is currently active, false otherwise

Returns:

the OAuth2TokenIntrospection.Builder

withClaims

public static OAuth2TokenIntrospection.Builder withClaims(Map<String,Object> claims)

Constructs a new OAuth2TokenIntrospection.Builder initialized with the provided claims.

Parameters:

claims - the claims to initialize the builder

Returns:

the OAuth2TokenIntrospection.Builder