Package org.springframework.security.oauth2.client

Class OAuth2AuthorizationContext

java.lang.Object

org.springframework.security.oauth2.client.OAuth2AuthorizationContext

public final class OAuth2AuthorizationContext
extends Object

A context that holds authorization-specific state and is used by an OAuth2AuthorizedClientProvider when attempting to authorize (or re-authorize) an OAuth 2.0 Client.

Since:

5.2

See Also:

• OAuth2AuthorizedClientProvider

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PASSWORD_ATTRIBUTE_NAME	The name of the attribute in the context associated to the value for the resource owner's password.
static final String	REQUEST_SCOPE_ATTRIBUTE_NAME	The name of the attribute in the context associated to the value for the "request scope(s)".
static final String	USERNAME_ATTRIBUTE_NAME	The name of the attribute in the context associated to the value for the resource owner's username.

Method Summary

Modifier and Type	Method	Description
<T> T	getAttribute(String name)	Returns the value of an attribute associated to the context or null if not available.
Map<String,Object>	getAttributes()	Returns the attributes associated to the context.
OAuth2AuthorizedClient	getAuthorizedClient()	Returns the authorized client or null if the client registration was supplied.
ClientRegistration	getClientRegistration()	Returns the client registration.
Authentication	getPrincipal()	Returns the Principal (to be) associated to the authorized client.
static OAuth2AuthorizationContext.Builder	withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)	Returns a new OAuth2AuthorizationContext.Builder initialized with the OAuth2AuthorizedClient.
static OAuth2AuthorizationContext.Builder	withClientRegistration(ClientRegistration clientRegistration)	Returns a new OAuth2AuthorizationContext.Builder initialized with the ClientRegistration.

Methods inherited from class java.lang.Object

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

Field Details

REQUEST_SCOPE_ATTRIBUTE_NAME

public static final String REQUEST_SCOPE_ATTRIBUTE_NAME

The name of the attribute in the context associated to the value for the "request scope(s)". The value of the attribute is a String[] of scope(s) to be requested by the client.

USERNAME_ATTRIBUTE_NAME

public static final String USERNAME_ATTRIBUTE_NAME

The name of the attribute in the context associated to the value for the resource owner's username.

PASSWORD_ATTRIBUTE_NAME

public static final String PASSWORD_ATTRIBUTE_NAME

The name of the attribute in the context associated to the value for the resource owner's password.

Method Details

getClientRegistration

public ClientRegistration getClientRegistration()

Returns the client registration.

Returns:

the ClientRegistration

getAuthorizedClient

@Nullable
public OAuth2AuthorizedClient getAuthorizedClient()

Returns the authorized client or null if the client registration was supplied.

Returns:

the OAuth2AuthorizedClient or null if the client registration was supplied

getPrincipal

public Authentication getPrincipal()

Returns the Principal (to be) associated to the authorized client.

Returns:

the Principal (to be) associated to the authorized client

getAttributes

public Map<String,Object> getAttributes()

Returns the attributes associated to the context.

Returns:

a Map of the attributes associated to the context

getAttribute

@Nullable
public <T> T getAttribute(String name)

Returns the value of an attribute associated to the context or null if not available.

Type Parameters:

T - the type of the attribute

Parameters:

name - the name of the attribute

Returns:

the value of the attribute associated to the context

withClientRegistration

public static OAuth2AuthorizationContext.Builder withClientRegistration(ClientRegistration clientRegistration)

Returns a new OAuth2AuthorizationContext.Builder initialized with the ClientRegistration.

Parameters:

clientRegistration - the client registration

Returns:

the OAuth2AuthorizationContext.Builder

withAuthorizedClient

public static OAuth2AuthorizationContext.Builder withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)

Returns a new OAuth2AuthorizationContext.Builder initialized with the OAuth2AuthorizedClient.

Parameters:

authorizedClient - the authorized client

Returns:

the OAuth2AuthorizationContext.Builder