Class OAuth2AuthorizeRequest

java.lang.Object

org.springframework.security.oauth2.client.OAuth2AuthorizeRequest

public final class OAuth2AuthorizeRequest
extends Object

Represents a request the OAuth2AuthorizedClientManager uses to authorize (or re-authorize) the client identified by the provided clientRegistrationId.

Since:

5.2

See Also:

• OAuth2AuthorizedClientManager

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
<T> @Nullable T	getAttribute(String name)	Returns the value of an attribute associated to the request or null if not available.
Map<String,Object>	getAttributes()	Returns the attributes associated to the request.
@Nullable OAuth2AuthorizedClient	getAuthorizedClient()	Returns the authorized client or null if it was not provided.
String	getClientRegistrationId()	Returns the identifier for the client registration.
Authentication	getPrincipal()	Returns the Principal (to be) associated to the authorized client.
static OAuth2AuthorizeRequest.Builder	withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)	Returns a new OAuth2AuthorizeRequest.Builder initialized with the authorized client.
static OAuth2AuthorizeRequest.Builder	withClientRegistrationId(String clientRegistrationId)	Returns a new OAuth2AuthorizeRequest.Builder initialized with the identifier for the client registration.

Methods inherited from class Object

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

Method Details

getClientRegistrationId

public String getClientRegistrationId()

Returns the identifier for the client registration.

Returns:

the identifier for the client registration

getAuthorizedClient

public @Nullable OAuth2AuthorizedClient getAuthorizedClient()

Returns the authorized client or null if it was not provided.

Returns:

the OAuth2AuthorizedClient or null if it was not provided

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 request.

Returns:

a Map of the attributes associated to the request

getAttribute

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

Returns the value of an attribute associated to the request 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 request

withClientRegistrationId

public static OAuth2AuthorizeRequest.Builder withClientRegistrationId(String clientRegistrationId)

Returns a new OAuth2AuthorizeRequest.Builder initialized with the identifier for the client registration.

Parameters:

clientRegistrationId - the identifier for the client registration

Returns:

the OAuth2AuthorizeRequest.Builder

withAuthorizedClient

public static OAuth2AuthorizeRequest.Builder withAuthorizedClient(OAuth2AuthorizedClient authorizedClient)

Returns a new OAuth2AuthorizeRequest.Builder initialized with the authorized client.

Parameters:

authorizedClient - the authorized client

Returns:

the OAuth2AuthorizeRequest.Builder