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

Class OidcUserInfoAuthenticationContext

java.lang.Object

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

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OidcUserInfoAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OidcUserInfoAuthenticationToken and additional information and is used when mapping claims to an instance of OidcUserInfo.

Since:

0.2.1

See Also:

• OAuth2AuthenticationContext
• OidcUserInfo
• OidcUserInfoAuthenticationProvider.setUserInfoMapper(Function)

Nested Class Summary

Nested Classes

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

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.
org.springframework.security.oauth2.core.OAuth2AccessToken	getAccessToken()	Returns the OAuth 2.0 Access Token.
OAuth2Authorization	getAuthorization()	Returns the authorization.
boolean	hasKey(Object key)	Returns true if an attribute associated to the key exists, false otherwise.
static OidcUserInfoAuthenticationContext.Builder	with(OidcUserInfoAuthenticationToken authentication)	Constructs a new OidcUserInfoAuthenticationContext.Builder with the provided OidcUserInfoAuthenticationToken.

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

getAccessToken

public org.springframework.security.oauth2.core.OAuth2AccessToken getAccessToken()

Returns the OAuth 2.0 Access Token.

Returns:

the OAuth2AccessToken

getAuthorization

public OAuth2Authorization getAuthorization()

Returns the authorization.

Returns:

the OAuth2Authorization

with

public static OidcUserInfoAuthenticationContext.Builder with(OidcUserInfoAuthenticationToken authentication)

Constructs a new OidcUserInfoAuthenticationContext.Builder with the provided OidcUserInfoAuthenticationToken.

Parameters:

authentication - the OidcUserInfoAuthenticationToken

Returns:

the OidcUserInfoAuthenticationContext.Builder