AuthorizationCodeOAuth2AuthorizedClientProvider (spring-security-oauth2-client 5.5.1 API)

java.lang.Object
- org.springframework.security.oauth2.client.AuthorizationCodeOAuth2AuthorizedClientProvider

All Implemented Interfaces:

OAuth2AuthorizedClientProvider
```
public final class AuthorizationCodeOAuth2AuthorizedClientProvider
extends java.lang.Object
implements OAuth2AuthorizedClientProvider
```
An implementation of an OAuth2AuthorizedClientProvider for the authorization_code grant.

Since:

5.2

See Also:

OAuth2AuthorizedClientProvider

Constructor Summary

Constructors
Constructor Description

AuthorizationCodeOAuth2AuthorizedClientProvider()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OAuth2AuthorizedClient`	`authorize(OAuth2AuthorizationContext context)`	Attempt to authorize the `client` in the provided `context`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AuthorizationCodeOAuth2AuthorizedClientProvider
```
public AuthorizationCodeOAuth2AuthorizedClientProvider()
```
- Method Detail
  - authorize
```
@Nullable
public OAuth2AuthorizedClient authorize(OAuth2AuthorizationContext context)
```
    Attempt to authorize the client in the provided context. Returns null if authorization is not supported, e.g. the client's authorization grant type is not authorization_code OR the client is already authorized.
    
    Specified by:
    
    authorize in interface OAuth2AuthorizedClientProvider
    
    Parameters:
    
    context - the context that holds authorization-specific state for the client
    
    Returns:
    
    null if authorization is not supported or the client is already authorized
    
    Throws:
    
    ClientAuthorizationRequiredException - in order to trigger authorization in which the OAuth2AuthorizationRequestRedirectFilter will catch and initiate the authorization request