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 aHandlerMethodArgumentResolver
that is capable of resolving a method parameter to an argument value of typeOAuth2AuthorizedClient
.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 anOAuth2AuthorizedClientArgumentResolver
using the provided parameters.OAuth2AuthorizedClientArgumentResolver(ClientRegistrationRepository clientRegistrationRepository, OAuth2AuthorizedClientRepository authorizedClientRepository)
Constructs anOAuth2AuthorizedClientArgumentResolver
using the provided parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods 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.void
setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)
Sets theSecurityContextHolderStrategy
to use.boolean
supportsParameter(org.springframework.core.MethodParameter parameter)
-
-
-
Constructor Detail
-
OAuth2AuthorizedClientArgumentResolver
public OAuth2AuthorizedClientArgumentResolver(OAuth2AuthorizedClientManager authorizedClientManager)
Constructs anOAuth2AuthorizedClientArgumentResolver
using the provided parameters.- Parameters:
authorizedClientManager
- theOAuth2AuthorizedClientManager
which manages the authorized client(s)- Since:
- 5.2
-
OAuth2AuthorizedClientArgumentResolver
public OAuth2AuthorizedClientArgumentResolver(ClientRegistrationRepository clientRegistrationRepository, OAuth2AuthorizedClientRepository authorizedClientRepository)
Constructs anOAuth2AuthorizedClientArgumentResolver
using the provided parameters.- Parameters:
clientRegistrationRepository
- the repository of client registrationsauthorizedClientRepository
- the repository of authorized clients
-
-
Method Detail
-
supportsParameter
public boolean supportsParameter(org.springframework.core.MethodParameter parameter)
- Specified by:
supportsParameter
in interfaceorg.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 interfaceorg.springframework.web.method.support.HandlerMethodArgumentResolver
-
setClientCredentialsTokenResponseClient
@Deprecated public void setClientCredentialsTokenResponseClient(OAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> clientCredentialsTokenResponseClient)
Deprecated.UseOAuth2AuthorizedClientArgumentResolver(OAuth2AuthorizedClientManager)
instead. Create an instance ofClientCredentialsOAuth2AuthorizedClientProvider
configured with aDefaultClientCredentialsTokenResponseClient
(or a custom one) and than supply it toDefaultOAuth2AuthorizedClientManager
.Sets the client used when requesting an access token credential at the Token Endpoint for theclient_credentials
grant.- Parameters:
clientCredentialsTokenResponseClient
- the client used when requesting an access token credential at the Token Endpoint for theclient_credentials
grant
-
setSecurityContextHolderStrategy
public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)
Sets theSecurityContextHolderStrategy
to use. The default action is to use theSecurityContextHolderStrategy
stored inSecurityContextHolder
.- Since:
- 5.8
-
-