Class OidcLogoutToken

java.lang.Object

org.springframework.security.oauth2.core.AbstractOAuth2Token

org.springframework.security.oauth2.client.oidc.authentication.logout.OidcLogoutToken

All Implemented Interfaces:

Serializable, LogoutTokenClaimAccessor, ClaimAccessor, OAuth2Token

public class OidcLogoutToken
extends AbstractOAuth2Token
implements LogoutTokenClaimAccessor

An implementation of an AbstractOAuth2Token representing an OpenID Backchannel Logout Token.

The OidcLogoutToken is a security token that contains "claims" about terminating sessions for a given OIDC Provider session id or End User.

Since:

6.2

See Also:

• AbstractOAuth2Token
• LogoutTokenClaimAccessor
• Logout Token
• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getClaims()	Returns a set of claims that may be used for assertions.
static OidcLogoutToken.Builder	withTokenValue(String tokenValue)	Create a OidcLogoutToken.Builder based on the given token value.

Methods inherited from class AbstractOAuth2Token

equals, getExpiresAt, getIssuedAt, getTokenValue, hashCode

Methods inherited from class Object

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

Methods inherited from interface ClaimAccessor

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

Methods inherited from interface LogoutTokenClaimAccessor

getAudience, getEvents, getId, getIssuedAt, getIssuer, getSessionId, getSubject

Method Details

getClaims

public Map<String,Object> getClaims()

Description copied from interface: ClaimAccessor

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

Specified by:

getClaims in interface ClaimAccessor

Returns:

a Map of claims

withTokenValue

public static OidcLogoutToken.Builder withTokenValue(String tokenValue)

Create a OidcLogoutToken.Builder based on the given token value.

Parameters:

tokenValue - the token value to use

Returns:

the OidcLogoutToken.Builder for further configuration