Rename @OAuth2Client to @RegisteredOAuth2AuthorizedClient

Fixes gh-5360

config/src/main/java/org/springframework/security/config/annotation/web/configuration/OAuth2ClientConfiguration.java

@@ -21,8 +21,7 @@ import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.ImportSelector;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService;
-import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
-import org.springframework.security.oauth2.client.web.method.annotation.OAuth2ClientArgumentResolver;
+import org.springframework.security.oauth2.client.web.method.annotation.OAuth2AuthorizedClientArgumentResolver;
 import org.springframework.util.ClassUtils;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@@ -58,18 +57,15 @@ final class OAuth2ClientConfiguration {
 
 	@Configuration
 	static class OAuth2ClientWebMvcSecurityConfiguration implements WebMvcConfigurer {
-		@Autowired(required = false)
-		private ClientRegistrationRepository clientRegistrationRepository;
-
 		@Autowired(required = false)
 		private OAuth2AuthorizedClientService authorizedClientService;
 
 		@Override
 		public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
-			if (this.clientRegistrationRepository != null && this.authorizedClientService != null) {
-				OAuth2ClientArgumentResolver oauth2ClientArgumentResolver = new OAuth2ClientArgumentResolver(
-					this.clientRegistrationRepository, this.authorizedClientService);
-				argumentResolvers.add(oauth2ClientArgumentResolver);
+			if (this.authorizedClientService != null) {
+				OAuth2AuthorizedClientArgumentResolver authorizedClientArgumentResolver =
+						new OAuth2AuthorizedClientArgumentResolver(this.authorizedClientService);
+				argumentResolvers.add(authorizedClientArgumentResolver);
 			}
 		}
 	}

config/src/main/java/org/springframework/security/config/annotation/web/reactive/ReactiveOAuth2ClientImportSelector.java

@@ -16,19 +16,18 @@
 
 package org.springframework.security.config.annotation.web.reactive;
 
-import java.util.List;
-
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.ImportSelector;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.security.oauth2.client.ReactiveOAuth2AuthorizedClientService;
-import org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository;
-import org.springframework.security.oauth2.client.web.reactive.result.method.annotation.OAuth2ClientArgumentResolver;
+import org.springframework.security.oauth2.client.web.reactive.result.method.annotation.OAuth2AuthorizedClientArgumentResolver;
 import org.springframework.util.ClassUtils;
 import org.springframework.web.reactive.config.WebFluxConfigurer;
 import org.springframework.web.reactive.result.method.annotation.ArgumentResolverConfigurer;
 
+import java.util.List;
+
 /**
  * {@link Configuration} for OAuth 2.0 Client support.
  *
@@ -52,21 +51,12 @@ final class ReactiveOAuth2ClientImportSelector implements ImportSelector {
 
 	@Configuration
 	static class OAuth2ClientWebFluxSecurityConfiguration implements WebFluxConfigurer {
-		private ReactiveClientRegistrationRepository clientRegistrationRepository;
-
 		private ReactiveOAuth2AuthorizedClientService authorizedClientService;
 
 		@Override
 		public void configureArgumentResolvers(ArgumentResolverConfigurer configurer) {
-			if (this.clientRegistrationRepository != null && this.authorizedClientService != null) {
-				configurer.addCustomResolver(new OAuth2ClientArgumentResolver(this.clientRegistrationRepository, this.authorizedClientService));
-			}
-		}
-
-		@Autowired(required = false)
-		public void setClientRegistrationRepository(List<ReactiveClientRegistrationRepository> clientRegistrationRepository) {
-			if (clientRegistrationRepository.size() == 1) {
-				this.clientRegistrationRepository = clientRegistrationRepository.get(0);
+			if (this.authorizedClientService != null) {
+				configurer.addCustomResolver(new OAuth2AuthorizedClientArgumentResolver(this.authorizedClientService));
 			}
 		}
 

config/src/test/java/org/springframework/security/config/annotation/web/configuration/OAuth2ClientConfigurationTests.java

@@ -23,11 +23,7 @@ import org.springframework.security.config.annotation.web.builders.HttpSecurity;
 import org.springframework.security.config.test.SpringTestRule;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService;
-import org.springframework.security.oauth2.client.annotation.OAuth2Client;
-import org.springframework.security.oauth2.client.registration.ClientRegistration;
-import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
-import org.springframework.security.oauth2.core.AuthorizationGrantType;
-import org.springframework.security.oauth2.core.ClientAuthenticationMethod;
+import org.springframework.security.oauth2.client.annotation.RegisteredOAuth2AuthorizedClient;
 import org.springframework.security.oauth2.core.OAuth2AccessToken;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -54,24 +50,10 @@ public class OAuth2ClientConfigurationTests {
 	private MockMvc mockMvc;
 
 	@Test
-	public void requestWhenAuthorizedClientFoundThenOAuth2ClientArgumentsResolved() throws Exception {
+	public void requestWhenAuthorizedClientFoundThenMethodArgumentResolved() throws Exception {
 		String clientRegistrationId = "client1";
 		String principalName = "user1";
 
-		ClientRegistrationRepository clientRegistrationRepository = mock(ClientRegistrationRepository.class);
-		ClientRegistration clientRegistration = ClientRegistration.withRegistrationId(clientRegistrationId)
-				.clientId("client-id")
-				.clientSecret("secret")
-				.clientAuthenticationMethod(ClientAuthenticationMethod.BASIC)
-				.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
-				.redirectUriTemplate("{baseUrl}/client1")
-				.scope("scope1", "scope2")
-				.authorizationUri("https://provider.com/oauth2/auth")
-				.tokenUri("https://provider.com/oauth2/token")
-				.clientName("Client 1")
-				.build();
-		when(clientRegistrationRepository.findByRegistrationId(clientRegistrationId)).thenReturn(clientRegistration);
-
 		OAuth2AuthorizedClientService authorizedClientService = mock(OAuth2AuthorizedClientService.class);
 		OAuth2AuthorizedClient authorizedClient = mock(OAuth2AuthorizedClient.class);
 		when(authorizedClientService.loadAuthorizedClient(clientRegistrationId, principalName)).thenReturn(authorizedClient);
@@ -79,25 +61,17 @@ public class OAuth2ClientConfigurationTests {
 		OAuth2AccessToken accessToken = mock(OAuth2AccessToken.class);
 		when(authorizedClient.getAccessToken()).thenReturn(accessToken);
 
-		OAuth2ClientArgumentResolverConfig.CLIENT_REGISTRATION_REPOSITORY = clientRegistrationRepository;
-		OAuth2ClientArgumentResolverConfig.AUTHORIZED_CLIENT_SERVICE = authorizedClientService;
-		this.spring.register(OAuth2ClientArgumentResolverConfig.class).autowire();
+		OAuth2AuthorizedClientArgumentResolverConfig.AUTHORIZED_CLIENT_SERVICE = authorizedClientService;
+		this.spring.register(OAuth2AuthorizedClientArgumentResolverConfig.class).autowire();
 
-		this.mockMvc.perform(get("/access-token").with(user(principalName)))
-			.andExpect(status().isOk())
-			.andExpect(content().string("resolved"));
 		this.mockMvc.perform(get("/authorized-client").with(user(principalName)))
 			.andExpect(status().isOk())
 			.andExpect(content().string("resolved"));
-		this.mockMvc.perform(get("/client-registration").with(user(principalName)))
-			.andExpect(status().isOk())
-			.andExpect(content().string("resolved"));
 	}
 
 	@EnableWebMvc
 	@EnableWebSecurity
-	static class OAuth2ClientArgumentResolverConfig extends WebSecurityConfigurerAdapter {
-		static ClientRegistrationRepository CLIENT_REGISTRATION_REPOSITORY;
+	static class OAuth2AuthorizedClientArgumentResolverConfig extends WebSecurityConfigurerAdapter {
 		static OAuth2AuthorizedClientService AUTHORIZED_CLIENT_SERVICE;
 
 		@Override
@@ -107,25 +81,10 @@ public class OAuth2ClientConfigurationTests {
 		@RestController
 		public class Controller {
 
-			@GetMapping("/access-token")
-			public String accessToken(@OAuth2Client("client1") OAuth2AccessToken accessToken) {
-				return accessToken != null ? "resolved" : "not-resolved";
-			}
-
 			@GetMapping("/authorized-client")
-			public String authorizedClient(@OAuth2Client("client1") OAuth2AuthorizedClient authorizedClient) {
+			public String authorizedClient(@RegisteredOAuth2AuthorizedClient("client1") OAuth2AuthorizedClient authorizedClient) {
 				return authorizedClient != null ? "resolved" : "not-resolved";
 			}
-
-			@GetMapping("/client-registration")
-			public String clientRegistration(@OAuth2Client("client1") ClientRegistration clientRegistration) {
-				return clientRegistration != null ? "resolved" : "not-resolved";
-			}
-		}
-
-		@Bean
-		public ClientRegistrationRepository clientRegistrationRepository() {
-			return CLIENT_REGISTRATION_REPOSITORY;
 		}
 
 		@Bean

config/src/test/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OAuth2ClientConfigurerTests.java

@@ -30,7 +30,7 @@ import org.springframework.security.config.test.SpringTestRule;
 import org.springframework.security.oauth2.client.InMemoryOAuth2AuthorizedClientService;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
 import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService;
-import org.springframework.security.oauth2.client.annotation.OAuth2Client;
+import org.springframework.security.oauth2.client.annotation.RegisteredOAuth2AuthorizedClient;
 import org.springframework.security.oauth2.client.endpoint.OAuth2AccessTokenResponseClient;
 import org.springframework.security.oauth2.client.endpoint.OAuth2AuthorizationCodeGrantRequest;
 import org.springframework.security.oauth2.client.registration.ClientRegistration;
@@ -205,7 +205,7 @@ public class OAuth2ClientConfigurerTests {
 		@RestController
 		public class ResourceController {
 			@GetMapping("/resource1")
-			public String resource1(@OAuth2Client("registration-1") OAuth2AuthorizedClient authorizedClient) {
+			public String resource1(@RegisteredOAuth2AuthorizedClient("registration-1") OAuth2AuthorizedClient authorizedClient) {
 				return "resource1";
 			}
 		}