Package org.springframework.security.oauth2.client.web.method.annotation

Class OAuth2AuthorizedClientArgumentResolver

java.lang.Object

org.springframework.security.oauth2.client.web.method.annotation.OAuth2AuthorizedClientArgumentResolver

All Implemented Interfaces:

org.springframework.web.method.support.HandlerMethodArgumentResolver

public final class OAuth2AuthorizedClientArgumentResolver
extends java.lang.Object
implements org.springframework.web.method.support.HandlerMethodArgumentResolver

An implementation of a HandlerMethodArgumentResolver that is capable of resolving a method parameter to an argument value of type OAuth2AuthorizedClient.

For example:

 @Controller
 public class MyController {
     @GetMapping("/authorized-client")
     public String authorizedClient(@RegisteredOAuth2AuthorizedClient("login-client") OAuth2AuthorizedClient authorizedClient) {
         // do something with authorizedClient
     }
 }
 

Since:

5.1

See Also:

RegisteredOAuth2AuthorizedClient

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizedClientArgumentResolver(OAuth2AuthorizedClientManager authorizedClientManager)	Constructs an OAuth2AuthorizedClientArgumentResolver using the provided parameters.
OAuth2AuthorizedClientArgumentResolver(ClientRegistrationRepository clientRegistrationRepository, OAuth2AuthorizedClientRepository authorizedClientRepository)	Constructs an OAuth2AuthorizedClientArgumentResolver using the provided parameters.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	resolveArgument(org.springframework.core.MethodParameter parameter, org.springframework.web.method.support.ModelAndViewContainer mavContainer, org.springframework.web.context.request.NativeWebRequest webRequest, org.springframework.web.bind.support.WebDataBinderFactory binderFactory)
void	setClientCredentialsTokenResponseClient(OAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> clientCredentialsTokenResponseClient)	Deprecated. Use OAuth2AuthorizedClientArgumentResolver(OAuth2AuthorizedClientManager) instead.
boolean	supportsParameter(org.springframework.core.MethodParameter parameter)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2AuthorizedClientArgumentResolver

public OAuth2AuthorizedClientArgumentResolver(OAuth2AuthorizedClientManager authorizedClientManager)

Constructs an OAuth2AuthorizedClientArgumentResolver using the provided parameters.

Parameters:

authorizedClientManager - the OAuth2AuthorizedClientManager which manages the authorized client(s)

Since:

5.2

OAuth2AuthorizedClientArgumentResolver

public OAuth2AuthorizedClientArgumentResolver(ClientRegistrationRepository clientRegistrationRepository,
                                              OAuth2AuthorizedClientRepository authorizedClientRepository)

Constructs an OAuth2AuthorizedClientArgumentResolver using the provided parameters.

Parameters:

clientRegistrationRepository - the repository of client registrations

authorizedClientRepository - the repository of authorized clients

Method Detail

supportsParameter

public boolean supportsParameter(org.springframework.core.MethodParameter parameter)

Specified by:

supportsParameter in interface org.springframework.web.method.support.HandlerMethodArgumentResolver

resolveArgument

@NonNull
public java.lang.Object resolveArgument(org.springframework.core.MethodParameter parameter,
                                        @Nullable
                                        org.springframework.web.method.support.ModelAndViewContainer mavContainer,
                                        org.springframework.web.context.request.NativeWebRequest webRequest,
                                        @Nullable
                                        org.springframework.web.bind.support.WebDataBinderFactory binderFactory)

Specified by:

resolveArgument in interface org.springframework.web.method.support.HandlerMethodArgumentResolver

setClientCredentialsTokenResponseClient

@Deprecated
public void setClientCredentialsTokenResponseClient(OAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> clientCredentialsTokenResponseClient)

Deprecated.

Use OAuth2AuthorizedClientArgumentResolver(OAuth2AuthorizedClientManager) instead. Create an instance of ClientCredentialsOAuth2AuthorizedClientProvider configured with a DefaultClientCredentialsTokenResponseClient (or a custom one) and than supply it to DefaultOAuth2AuthorizedClientManager.

Sets the client used when requesting an access token credential at the Token Endpoint for the client_credentials grant.

Parameters:

clientCredentialsTokenResponseClient - the client used when requesting an access token credential at the Token Endpoint for the client_credentials grant