Change Builder name

Author: ngocnhan-tran1996

oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/SpringOpaqueTokenIntrospector.java

@@ -82,7 +82,7 @@ public class SpringOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
 	 * @param introspectionUri The introspection endpoint uri
 	 * @param clientId The client id authorized to introspect
 	 * @param clientSecret The client's secret
-	 * @deprecated
+	 * @deprecated Please use {@link SpringOpaqueTokenIntrospector.Builder}
 	 */
 	@Deprecated(since = "6.5", forRemoval = true)
 	public SpringOpaqueTokenIntrospector(String introspectionUri, String clientId, String clientSecret) {
@@ -300,92 +300,101 @@ default List<String> getScopes() {
 
 	}
 
+	/**
+	 * Creates a {@code SpringOpaqueTokenIntrospector.Builder} with the provided
+	 * parameters
+	 * @param introspectionUri The introspection endpoint uri
+	 * @return the {@link SpringOpaqueTokenIntrospector.Builder}
+	 * @since 6.5
+	 */
+	public static Builder withIntrospectionUri(String introspectionUri) {
+		Assert.notNull(introspectionUri, "introspectionUri cannot be null");
+		return new Builder(introspectionUri);
+	}
+
 	/**
 	 * Used to build {@link SpringOpaqueTokenIntrospector}.
 	 *
 	 * @author Ngoc Nhan
 	 * @since 6.5
 	 */
-	public static final class SpringOpaqueTokenIntrospectorBuilder {
+	public static final class Builder {
 
 		private final String introspectionUri;
 
-		private SpringOpaqueTokenIntrospectorBuilder(String introspectionUri) {
+		private String clientId;
+
+		private String clientSecret;
+
+		private Builder(String introspectionUri) {
 			this.introspectionUri = introspectionUri;
 		}
 
 		/**
-		 * Creates a {@code SpringOpaqueTokenIntrospectorBuilder} with the provided
+		 * Creates a {@code SpringOpaqueTokenIntrospector.Builder} with the provided
 		 * parameters
-		 * @param introspectionUri The introspection endpoint uri
-		 * @return the {@link SpringOpaqueTokenIntrospectorBuilder}
+		 * @param clientId The client id authorized that should be encoded
+		 * @param charset The charset to use
+		 * @return the {@link SpringOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public static SpringOpaqueTokenIntrospectorBuilder withIntrospectionUri(String introspectionUri) {
-			Assert.notNull(introspectionUri, "introspectionUri cannot be null");
-			return new SpringOpaqueTokenIntrospectorBuilder(introspectionUri);
+		public Builder clientId(String clientId, Charset charset) {
+			Assert.notNull(clientId, "clientId cannot be null");
+			Assert.notNull(charset, "charset cannot be null");
+			this.clientId = URLEncoder.encode(clientId, charset);
+			return this;
 		}
 
 		/**
-		 * Creates a {@code SpringOpaqueTokenIntrospector} with the provided parameters
-		 * @param clientId The client id authorized that should be encode
-		 * @param clientSecret The client secret that should be encode for the authorized
-		 * client
-		 * @return the {@link SpringOpaqueTokenIntrospector}
+		 * Creates a {@code SpringOpaqueTokenIntrospector.Builder} with the provided
+		 * parameters
+		 * @param clientId The client id authorized
+		 * @return the {@link SpringOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public SpringOpaqueTokenIntrospector introspectionEncodeClientCredentials(String clientId,
-				String clientSecret) {
-			return this.introspectionEncodeClientCredentials(clientId, clientSecret, StandardCharsets.UTF_8);
+		public Builder clientId(String clientId) {
+			Assert.notNull(clientId, "clientId cannot be null");
+			this.clientId = clientId;
+			return this;
 		}
 
 		/**
-		 * Creates a {@code SpringOpaqueTokenIntrospector} with the provided parameters
-		 * @param clientId The client id authorized that should be encode
-		 * @param clientSecret The client secret that should be encode for the authorized
-		 * client
-		 * @param charset the charset to use
-		 * @return the {@link SpringOpaqueTokenIntrospector}
+		 * Creates a {@code SpringOpaqueTokenIntrospector.Builder} with the provided
+		 * parameters
+		 * @param clientSecret The client id authorized
+		 * @param charset The charset to use
+		 * @return the {@link SpringOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public SpringOpaqueTokenIntrospector introspectionEncodeClientCredentials(String clientId, String clientSecret,
-				Charset charset) {
-			Assert.notNull(clientId, "clientId cannot be null");
+		public Builder clientSecret(String clientSecret, Charset charset) {
 			Assert.notNull(clientSecret, "clientSecret cannot be null");
 			Assert.notNull(charset, "charset cannot be null");
-			String encodeClientId = URLEncoder.encode(clientId, charset);
-			String encodeClientSecret = URLEncoder.encode(clientSecret, charset);
-			RestTemplate restTemplate = new RestTemplate();
-			restTemplate.getInterceptors().add(new BasicAuthenticationInterceptor(encodeClientId, encodeClientSecret));
-			return new SpringOpaqueTokenIntrospector(this.introspectionUri, restTemplate);
+			this.clientId = URLEncoder.encode(clientSecret, charset);
+			return this;
 		}
 
 		/**
-		 * Creates a {@code SpringOpaqueTokenIntrospector} with the provided parameters
-		 * @param clientId The client id authorized
-		 * @param clientSecret The client secret for the authorized client
-		 * @return the {@link SpringOpaqueTokenIntrospector}
+		 * Creates a {@code SpringOpaqueTokenIntrospector.Builder} with the provided
+		 * parameters
+		 * @param clientSecret The client id authorized
+		 * @return the {@link SpringOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public SpringOpaqueTokenIntrospector introspectionClientCredentials(String clientId, String clientSecret) {
-			Assert.notNull(clientId, "clientId cannot be null");
+		public Builder clientSecret(String clientSecret) {
 			Assert.notNull(clientSecret, "clientSecret cannot be null");
-			RestTemplate restTemplate = new RestTemplate();
-			restTemplate.getInterceptors().add(new BasicAuthenticationInterceptor(clientId, clientSecret));
-			return new SpringOpaqueTokenIntrospector(this.introspectionUri, restTemplate);
+			this.clientSecret = clientSecret;
+			return this;
 		}
 
 		/**
 		 * Creates a {@code SpringOpaqueTokenIntrospector} with the provided parameters
-		 * The given {@link RestOperations} should perform its own client authentication
-		 * against the introspection endpoint.
-		 * @param restOperations The client for performing the introspection request
 		 * @return the {@link SpringOpaqueTokenIntrospector}
 		 * @since 6.5
 		 */
-		public SpringOpaqueTokenIntrospector withRestOperations(RestOperations restOperations) {
-			Assert.notNull(restOperations, "restOperations cannot be null");
-			return new SpringOpaqueTokenIntrospector(this.introspectionUri, restOperations);
+		public SpringOpaqueTokenIntrospector build() {
+			RestTemplate restTemplate = new RestTemplate();
+			restTemplate.getInterceptors().add(new BasicAuthenticationInterceptor(this.clientId, this.clientSecret));
+			return new SpringOpaqueTokenIntrospector(this.introspectionUri, restTemplate);
 		}
 
 	}

oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospector.java

@@ -20,7 +20,6 @@
 import java.net.URI;
 import java.net.URLEncoder;
 import java.nio.charset.Charset;
-import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -77,7 +76,7 @@ public class SpringReactiveOpaqueTokenIntrospector implements ReactiveOpaqueToke
 	 * @param introspectionUri The introspection endpoint uri
 	 * @param clientId The client id authorized to introspect
 	 * @param clientSecret The client secret for the authorized client
-	 * @deprecated
+	 * @deprecated Please use {@link SpringReactiveOpaqueTokenIntrospector.Builder}
 	 */
 	@Deprecated(since = "6.5", forRemoval = true)
 	public SpringReactiveOpaqueTokenIntrospector(String introspectionUri, String clientId, String clientSecret) {
@@ -254,96 +253,102 @@ default List<String> getScopes() {
 
 	}
 
+	/**
+	 * Creates a {@code SpringReactiveOpaqueTokenIntrospector.Builder} with the provided
+	 * parameters
+	 * @param introspectionUri The introspection endpoint uri
+	 * @return the {@link SpringReactiveOpaqueTokenIntrospector.Builder}
+	 * @since 6.5
+	 */
+	public static Builder withIntrospectionUri(String introspectionUri) {
+
+		return new Builder(introspectionUri);
+	}
+
 	/**
 	 * Used to build {@link SpringReactiveOpaqueTokenIntrospector}.
 	 *
 	 * @author Ngoc Nhan
 	 * @since 6.5
 	 */
-	public static final class SpringReactiveOpaqueTokenIntrospectorBuilder {
+	public static final class Builder {
 
 		private final String introspectionUri;
 
-		private SpringReactiveOpaqueTokenIntrospectorBuilder(String introspectionUri) {
+		private String clientId;
+
+		private String clientSecret;
+
+		private Builder(String introspectionUri) {
 			this.introspectionUri = introspectionUri;
 		}
 
 		/**
-		 * Creates a {@code SpringReactiveOpaqueTokenIntrospectorBuilder} with the
+		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector.Builder} with the
 		 * provided parameters
-		 * @param introspectionUri The introspection endpoint uri
-		 * @return the {@link SpringReactiveOpaqueTokenIntrospectorBuilder}
+		 * @param clientId The client id authorized that should be encoded
+		 * @param charset The charset to use
+		 * @return the {@link SpringReactiveOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public static SpringReactiveOpaqueTokenIntrospectorBuilder withIntrospectionUri(String introspectionUri) {
-
-			return new SpringReactiveOpaqueTokenIntrospectorBuilder(introspectionUri);
+		public SpringReactiveOpaqueTokenIntrospector.Builder clientId(String clientId, Charset charset) {
+			Assert.notNull(clientId, "clientId cannot be null");
+			Assert.notNull(charset, "charset cannot be null");
+			this.clientId = URLEncoder.encode(clientId, charset);
+			return this;
 		}
 
 		/**
-		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector} with the provided
-		 * parameters
-		 * @param clientId The client id authorized that should be encode
-		 * @param clientSecret The client secret that should be encode for the authorized
-		 * client
-		 * @return the {@link SpringReactiveOpaqueTokenIntrospector}
+		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector.Builder} with the
+		 * provided parameters
+		 * @param clientId The client id authorized
+		 * @return the {@link SpringReactiveOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public SpringReactiveOpaqueTokenIntrospector introspectionEncodeClientCredentials(String clientId,
-				String clientSecret) {
-			return this.introspectionEncodeClientCredentials(clientId, clientSecret, StandardCharsets.UTF_8);
+		public SpringReactiveOpaqueTokenIntrospector.Builder clientId(String clientId) {
+			Assert.notNull(clientId, "clientId cannot be null");
+			this.clientId = clientId;
+			return this;
 		}
 
 		/**
-		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector} with the provided
-		 * parameters
-		 * @param clientId The client id authorized that should be encode
-		 * @param clientSecret The client secret that should be encode for the authorized
-		 * client
-		 * @param charset the charset to use
-		 * @return the {@link SpringReactiveOpaqueTokenIntrospector}
+		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector.Builder} with the
+		 * provided parameters
+		 * @param clientSecret The client id authorized that should be encoded
+		 * @param charset The charset to use
+		 * @return the {@link SpringReactiveOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public SpringReactiveOpaqueTokenIntrospector introspectionEncodeClientCredentials(String clientId,
-				String clientSecret, Charset charset) {
-			Assert.notNull(clientId, "clientId cannot be null");
+		public SpringReactiveOpaqueTokenIntrospector.Builder clientSecret(String clientSecret, Charset charset) {
 			Assert.notNull(clientSecret, "clientSecret cannot be null");
 			Assert.notNull(charset, "charset cannot be null");
-			String encodeClientId = URLEncoder.encode(clientId, charset);
-			String encodeClientSecret = URLEncoder.encode(clientSecret, charset);
-			WebClient webClient = WebClient.builder()
-				.defaultHeaders((h) -> h.setBasicAuth(encodeClientId, encodeClientSecret))
-				.build();
-			return new SpringReactiveOpaqueTokenIntrospector(this.introspectionUri, webClient);
+			this.clientId = URLEncoder.encode(clientSecret, charset);
+			return this;
 		}
 
 		/**
-		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector} with the provided
-		 * parameters
-		 * @param clientId The client id authorized
-		 * @param clientSecret The client secret for the authorized client
-		 * @return the {@link SpringReactiveOpaqueTokenIntrospector}
+		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector.Builder} with the
+		 * provided parameters
+		 * @param clientSecret The client id authorized
+		 * @return the {@link SpringReactiveOpaqueTokenIntrospector.Builder}
 		 * @since 6.5
 		 */
-		public SpringReactiveOpaqueTokenIntrospector introspectionClientCredentials(String clientId,
-				String clientSecret) {
-			Assert.notNull(clientId, "clientId cannot be null");
+		public SpringReactiveOpaqueTokenIntrospector.Builder clientSecret(String clientSecret) {
 			Assert.notNull(clientSecret, "clientSecret cannot be null");
-			WebClient webClient = WebClient.builder()
-				.defaultHeaders((h) -> h.setBasicAuth(clientId, clientSecret))
-				.build();
-			return new SpringReactiveOpaqueTokenIntrospector(this.introspectionUri, webClient);
+			this.clientSecret = clientSecret;
+			return this;
 		}
 
 		/**
 		 * Creates a {@code SpringReactiveOpaqueTokenIntrospector} with the provided
 		 * parameters
-		 * @param webClient The client for performing the introspection request
 		 * @return the {@link SpringReactiveOpaqueTokenIntrospector}
 		 * @since 6.5
 		 */
-		public SpringReactiveOpaqueTokenIntrospector withRestOperations(WebClient webClient) {
-			Assert.notNull(webClient, "webClient cannot be null");
+		public SpringReactiveOpaqueTokenIntrospector build() {
+			WebClient webClient = WebClient.builder()
+				.defaultHeaders((h) -> h.setBasicAuth(this.clientId, this.clientSecret))
+				.build();
 			return new SpringReactiveOpaqueTokenIntrospector(this.introspectionUri, webClient);
 		}
 

oauth2/oauth2-resource-server/src/test/java/org/springframework/security/oauth2/server/resource/introspection/SpringOpaqueTokenIntrospectorTests.java

@@ -17,6 +17,7 @@
 package org.springframework.security.oauth2.server.resource.introspection;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.Base64;
@@ -43,7 +44,6 @@
 import org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal;
 import org.springframework.security.oauth2.core.OAuth2TokenIntrospectionClaimAccessor;
 import org.springframework.security.oauth2.core.OAuth2TokenIntrospectionClaimNames;
-import org.springframework.security.oauth2.server.resource.introspection.SpringOpaqueTokenIntrospector.SpringOpaqueTokenIntrospectorBuilder;
 import org.springframework.web.client.RestOperations;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -369,9 +369,11 @@ public void introspectWithEncodeClientCredentialsThenOk() throws Exception {
 					""";
 			server.setDispatcher(requiresAuth("client%25%261", "secret%40%242", response));
 			String introspectUri = server.url("/introspect").toString();
-			OpaqueTokenIntrospector introspectionClient = SpringOpaqueTokenIntrospectorBuilder
+			OpaqueTokenIntrospector introspectionClient = SpringOpaqueTokenIntrospector
 				.withIntrospectionUri(introspectUri)
-				.introspectionEncodeClientCredentials("client%&1", "secret@$2");
+				.clientId("client%&1", StandardCharsets.UTF_8)
+				.clientSecret("secret@$2", StandardCharsets.UTF_8)
+				.build();
 			OAuth2AuthenticatedPrincipal authority = introspectionClient.introspect("token");
 			// @formatter:off
 			assertThat(authority.getAttributes())

oauth2/oauth2-resource-server/src/test/java/org/springframework/security/oauth2/server/resource/introspection/SpringReactiveOpaqueTokenIntrospectorTests.java

@@ -17,6 +17,7 @@
 package org.springframework.security.oauth2.server.resource.introspection;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.Base64;
@@ -293,9 +294,11 @@ public void introspectWithEncodeClientCredentialsThenOk() throws Exception {
 					""";
 			server.setDispatcher(requiresAuth("client%25%261", "secret%40%242", response));
 			String introspectUri = server.url("/introspect").toString();
-			ReactiveOpaqueTokenIntrospector introspectionClient = SpringReactiveOpaqueTokenIntrospectorBuilder
+			ReactiveOpaqueTokenIntrospector introspectionClient = SpringReactiveOpaqueTokenIntrospector
 				.withIntrospectionUri(introspectUri)
-				.introspectionEncodeClientCredentials("client%&1", "secret@$2");
+				.clientId("client%&1", StandardCharsets.UTF_8)
+				.clientSecret("secret@$2", StandardCharsets.UTF_8)
+				.build();
 			OAuth2AuthenticatedPrincipal authority = introspectionClient.introspect("token").block();
 			// @formatter:off
 			assertThat(authority.getAttributes())