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

Class OAuth2ClientCredentialsAuthenticationContext

java.lang.Object

org.springframework.security.oauth2.server.authorization.authentication.OAuth2ClientCredentialsAuthenticationContext

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OAuth2ClientCredentialsAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OAuth2ClientCredentialsAuthenticationToken and additional information and is used when validating the OAuth 2.0 Client Credentials Grant Request.

Since:

1.3

See Also:

• OAuth2AuthenticationContext
• OAuth2ClientCredentialsAuthenticationToken
• OAuth2ClientCredentialsAuthenticationProvider.setAuthenticationValidator(Consumer)

Nested Class Summary

Nested Classes

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

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 OAuth2ClientCredentialsAuthenticationContext.Builder	with(OAuth2ClientCredentialsAuthenticationToken authentication)	Constructs a new OAuth2ClientCredentialsAuthenticationContext.Builder with the provided OAuth2ClientCredentialsAuthenticationToken.

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 OAuth2ClientCredentialsAuthenticationContext.Builder with(OAuth2ClientCredentialsAuthenticationToken authentication)

Constructs a new OAuth2ClientCredentialsAuthenticationContext.Builder with the provided OAuth2ClientCredentialsAuthenticationToken.

Parameters:

authentication - the OAuth2ClientCredentialsAuthenticationToken

Returns:

the OAuth2ClientCredentialsAuthenticationContext.Builder