Package org.springframework.security.oauth2.server.authorization.oidc.authentication

Class OidcLogoutAuthenticationContext

java.lang.Object

org.springframework.security.oauth2.server.authorization.oidc.authentication.OidcLogoutAuthenticationContext

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OidcLogoutAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OidcLogoutAuthenticationToken and additional information and is used when validating the OpenID Connect RP-Initiated Logout Request parameters.

Since:

7.0

See Also:

• OAuth2AuthenticationContext
• OidcLogoutAuthenticationToken
• OidcLogoutAuthenticationProvider.setAuthenticationValidator(Consumer)

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthenticationContext

OAuth2AuthenticationContext.AbstractBuilder<T extends OAuth2AuthenticationContext,B extends OAuth2AuthenticationContext.AbstractBuilder<T,B>>

Method Summary

Modifier and Type	Method	Description
<V> V	get(Object key)	Returns the value of the attribute associated to the key.
RegisteredClient	getRegisteredClient()	Returns the registered client.
boolean	hasKey(Object key)	Returns true if an attribute associated to the key exists, false otherwise.
static OidcLogoutAuthenticationContext.Builder	with(OidcLogoutAuthenticationToken authentication)	Constructs a new OidcLogoutAuthenticationContext.Builder with the provided OidcLogoutAuthenticationToken.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.oauth2.server.authorization.context.Context

get

Methods inherited from interface org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthenticationContext

getAuthentication

Method Details

get

@Nullable
public <V> V get(Object key)

Description copied from interface: Context

Returns the value of the attribute associated to the key.

Specified by:

get in interface Context

Type Parameters:

V - the type of the value for the attribute

Parameters:

key - the key for the attribute

Returns:

the value of the attribute associated to the key, or null if not available

hasKey

public boolean hasKey(Object key)

Description copied from interface: Context

Returns true if an attribute associated to the key exists, false otherwise.

Specified by:

hasKey in interface Context

Parameters:

key - the key for the attribute

Returns:

true if an attribute associated to the key exists, false otherwise

getRegisteredClient

public RegisteredClient getRegisteredClient()

Returns the registered client.

Returns:

the RegisteredClient

with

public static OidcLogoutAuthenticationContext.Builder with(OidcLogoutAuthenticationToken authentication)

Constructs a new OidcLogoutAuthenticationContext.Builder with the provided OidcLogoutAuthenticationToken.

Parameters:

authentication - the OidcLogoutAuthenticationToken

Returns:

the OidcLogoutAuthenticationContext.Builder