Polishing

See gh-30117

Author: rstoyanchev

framework-docs/modules/ROOT/pages/integration/rest-clients.adoc

@@ -388,7 +388,8 @@ either using `WebClient`:
 [source,java,indent=0,subs="verbatim,quotes"]
 ----
 	WebClient client = WebClient.builder().baseUrl("https://api.github.com/").build();
-	HttpServiceProxyFactory factory = HttpServiceProxyFactory.builder().exchangeAdapter(WebClientAdapter.forClient(webClient)).build();
+	WebClientAdapter adapter = WebClientAdapter.forClient(webClient)
+	HttpServiceProxyFactory factory = HttpServiceProxyFactory.builderFor(adapter).build();
 
 	RepositoryService service = factory.createClient(RepositoryService.class);
 ----
@@ -398,8 +399,9 @@ or using `RestTemplate`:
 [source,java,indent=0,subs="verbatim,quotes"]
 ----
 	RestTemplate restTemplate = new RestTemplate();
-		restTemplate.setUriTemplateHandler(new DefaultUriBuilderFactory("https://api.github.com/"));
-	HttpServiceProxyFactory factory = HttpServiceProxyFactory.builder().exchangeAdapter(RestTemplateAdapter.forTemplate(restTemplate)).build();
+	restTemplate.setUriTemplateHandler(new DefaultUriBuilderFactory("https://api.github.com/"));
+	RestTemplateAdapter adapter = RestTemplateAdapter.forTemplate(restTemplate);
+	HttpServiceProxyFactory factory = HttpServiceProxyFactory.builderFor(adapter).build();
 
 	RepositoryService service = factory.createClient(RepositoryService.class);
 ----

spring-web/src/main/java/org/springframework/web/client/support/RestTemplateAdapter.java

@@ -17,8 +17,9 @@
 package org.springframework.web.client.support;
 
 import java.net.URI;
+import java.util.ArrayList;
 import java.util.List;
-import java.util.stream.Collectors;
+import java.util.Map;
 
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.http.HttpCookie;
@@ -27,19 +28,17 @@
 import org.springframework.http.RequestEntity;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.Assert;
-import org.springframework.util.LinkedMultiValueMap;
-import org.springframework.util.MultiValueMap;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.service.invoker.HttpExchangeAdapter;
 import org.springframework.web.service.invoker.HttpRequestValues;
 import org.springframework.web.service.invoker.HttpServiceProxyFactory;
 
 /**
- * An {@link HttpExchangeAdapter} that enables an {@link HttpServiceProxyFactory} to use
+ * {@link HttpExchangeAdapter} that enables an {@link HttpServiceProxyFactory} to use
  * {@link RestTemplate} for request execution.
- * <p>
- * Use static factory methods in this class to create an {@link HttpServiceProxyFactory}
- * configured with a given {@link RestTemplate}.
+ *
+ * <p>Use static factory methods in this class to create an
+ * {@link HttpServiceProxyFactory} configured with a given {@link RestTemplate}.
  *
  * @author Olga Maciaszek-Sharma
  * @since 6.1
@@ -48,11 +47,17 @@ public final class RestTemplateAdapter implements HttpExchangeAdapter {
 
 	private final RestTemplate restTemplate;
 
-	// Private constructor; use static factory methods to instantiate
+
 	private RestTemplateAdapter(RestTemplate restTemplate) {
 		this.restTemplate = restTemplate;
 	}
 
+
+	@Override
+	public boolean supportsRequestAttributes() {
+		return false;
+	}
+
 	@Override
 	public void exchange(HttpRequestValues requestValues) {
 		this.restTemplate.exchange(newRequest(requestValues), Void.class);
@@ -74,14 +79,10 @@ public ResponseEntity<Void> exchangeForBodilessEntity(HttpRequestValues requestV
 	}
 
 	@Override
-	public <T> ResponseEntity<T> exchangeForEntity(HttpRequestValues requestValues,
-			ParameterizedTypeReference<T> bodyType) {
-		return this.restTemplate.exchange(newRequest(requestValues), bodyType);
-	}
+	public <T> ResponseEntity<T> exchangeForEntity(
+			HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
 
-	@Override
-	public boolean supportsRequestAttributes() {
-		return false;
+		return this.restTemplate.exchange(newRequest(requestValues), bodyType);
 	}
 
 	private RequestEntity<?> newRequest(HttpRequestValues requestValues) {
@@ -90,8 +91,9 @@ private RequestEntity<?> newRequest(HttpRequestValues requestValues) {
 			uri = requestValues.getUri();
 		}
 		else if (requestValues.getUriTemplate() != null) {
-			uri = this.restTemplate.getUriTemplateHandler().expand(requestValues.getUriTemplate(),
-					requestValues.getUriVariables());
+			String uriTemplate = requestValues.getUriTemplate();
+			Map<String, String> variables = requestValues.getUriVariables();
+			uri = this.restTemplate.getUriTemplateHandler().expand(uriTemplate, variables);
 		}
 		else {
 			throw new IllegalStateException("Neither full URL nor URI template");
@@ -100,35 +102,30 @@ else if (requestValues.getUriTemplate() != null) {
 		HttpMethod httpMethod = requestValues.getHttpMethod();
 		Assert.notNull(httpMethod, "HttpMethod is required");
 
-		RequestEntity.BodyBuilder builder = RequestEntity.method(httpMethod, uri)
-				.headers(requestValues.getHeaders());
+		RequestEntity.BodyBuilder builder = RequestEntity.method(httpMethod, uri);
+		builder.headers(requestValues.getHeaders());
 
 		if (!requestValues.getCookies().isEmpty()) {
-			MultiValueMap<String, HttpCookie> cookies = new LinkedMultiValueMap<>();
-			requestValues.getCookies()
-				.forEach((name, values) -> values.forEach(value ->
-						cookies.add(name, new HttpCookie(name, value))));
-
-			builder.header(HttpHeaders.COOKIE,
-					cookies.values()
-						.stream()
-						.flatMap(List::stream)
-						.map(HttpCookie::toString)
-						.collect(Collectors.joining("; ")));
+			List<String> cookies = new ArrayList<>();
+			requestValues.getCookies().forEach((name, values) -> values.forEach(value -> {
+				HttpCookie cookie = new HttpCookie(name, value);
+				cookies.add(cookie.toString());
+			}));
+			builder.header(HttpHeaders.COOKIE, String.join("; ", cookies));
 		}
 
 		if (requestValues.getBodyValue() != null) {
 			return builder.body(requestValues.getBodyValue());
 		}
+
 		return builder.build();
 	}
 
+
 	/**
-	 * Create a {@link RestTemplateAdapter} for the given {@link RestTemplate} instance.
-	 * @param restTemplate the {@link RestTemplate} to use
-	 * @return the created adapter instance
+	 * Create a {@link RestTemplateAdapter} with the given {@link RestTemplate}.
 	 */
-	public static RestTemplateAdapter forTemplate(RestTemplate restTemplate) {
+	public static RestTemplateAdapter create(RestTemplate restTemplate) {
 		return new RestTemplateAdapter(restTemplate);
 	}
 

spring-web/src/main/java/org/springframework/web/service/invoker/AbstractReactorHttpExchangeAdapter.java

@@ -29,10 +29,8 @@
 import org.springframework.util.Assert;
 
 /**
- * A base reactive adapter that implements both {@link HttpClientAdapter}
- * and {@link HttpExchangeAdapter}. Allows to ensure backwards compatibility
- * with the deprecated {@link HttpClientAdapter} and handles blocking from reactive
- * publishers to objects where necessary.
+ * Convenient base class for a {@link ReactorHttpExchangeAdapter} implementation
+ * adapting to the synchronous {@link HttpExchangeAdapter} contract.
  *
  * @author Rossen Stoyanchev
  * @since 6.1
@@ -55,30 +53,21 @@ protected AbstractReactorHttpExchangeAdapter() {
 
 
 	/**
-	 * Configure the registry for adapting various reactive types.
-	 * <p>By default this is an instance of {@link ReactiveAdapterRegistry} with
-	 * default settings.
+	 * Configure the {@link ReactiveAdapterRegistry} to use.
+	 * <p>By default, this is {@link ReactiveAdapterRegistry#getSharedInstance()}.
 	 */
 	public void setReactiveAdapterRegistry(ReactiveAdapterRegistry reactiveAdapterRegistry) {
 		this.reactiveAdapterRegistry = reactiveAdapterRegistry;
 	}
 
-	/**
-	 * Return the configured reactive type registry of adapters.
-	 */
 	@Override
 	public ReactiveAdapterRegistry getReactiveAdapterRegistry() {
 		return this.reactiveAdapterRegistry;
 	}
 
 	/**
-	 * Configure how long to block for the response of an HTTP service method with a
-	 * synchronous (blocking) method signature.
-	 * <p>
-	 * By default, this is not set, in which case the behavior depends on connection and
-	 * request timeout settings of the underlying HTTP client. We recommend configuring
-	 * timeout values directly on the underlying HTTP client, which provides more
-	 * control over such settings.
+	 * Configure how long to block for the response of an HTTP service method
+	 * as described in {@link #getBlockTimeout()}.
 	 */
 	public void setBlockTimeout(@Nullable Duration blockTimeout) {
 		this.blockTimeout = blockTimeout;
@@ -90,6 +79,7 @@ public Duration getBlockTimeout() {
 		return this.blockTimeout;
 	}
 
+
 	@Override
 	public void exchange(HttpRequestValues requestValues) {
 		if (this.blockTimeout != null) {
@@ -126,7 +116,9 @@ public ResponseEntity<Void> exchangeForBodilessEntity(HttpRequestValues requestV
 	}
 
 	@Override
-	public <T> ResponseEntity<T> exchangeForEntity(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
+	public <T> ResponseEntity<T> exchangeForEntity(
+			HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
+
 		ResponseEntity<T> entity = (this.blockTimeout != null ?
 				exchangeForEntityMono(requestValues, bodyType).block(this.blockTimeout) :
 				exchangeForEntityMono(requestValues, bodyType).block());

spring-web/src/main/java/org/springframework/web/service/invoker/HttpClientAdapter.java

@@ -91,59 +91,55 @@ public interface HttpClientAdapter {
 
 
 	/**
-	 * Adapt this {@link HttpClientAdapter} to {@link ReactorHttpExchangeAdapter}.
-	 * @return a {@link ReactorHttpExchangeAdapter} instance created that delegating to
-	 * the underlying {@link HttpClientAdapter} implementation
+	 * Adapt this instance to {@link ReactorHttpExchangeAdapter}.
 	 * @since 6.1
 	 */
-	default ReactorHttpExchangeAdapter asHttpExchangeAdapter() {
-
-		HttpClientAdapter delegate = this;
+	default ReactorHttpExchangeAdapter asReactorExchangeAdapter() {
 
 		return new AbstractReactorHttpExchangeAdapter() {
 
 			@Override
-			public Mono<Void> exchangeForMono(HttpRequestValues requestValues) {
-				return delegate.requestToVoid(requestValues);
+			public boolean supportsRequestAttributes() {
+				return true;
+			}
+
+			@Override
+			public Mono<Void> exchangeForMono(HttpRequestValues values) {
+				return HttpClientAdapter.this.requestToVoid(values);
 			}
 
 			@Override
-			public Mono<HttpHeaders> exchangeForHeadersMono(HttpRequestValues requestValues) {
-				return delegate.requestToHeaders(requestValues);
+			public Mono<HttpHeaders> exchangeForHeadersMono(HttpRequestValues values) {
+				return HttpClientAdapter.this.requestToHeaders(values);
 			}
 
 			@Override
-			public <T> Mono<T> exchangeForBodyMono(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
-				return delegate.requestToBody(requestValues, bodyType);
+			public <T> Mono<T> exchangeForBodyMono(HttpRequestValues values, ParameterizedTypeReference<T> bodyType) {
+				return HttpClientAdapter.this.requestToBody(values, bodyType);
 			}
 
 			@Override
-			public <T> Flux<T> exchangeForBodyFlux(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
-				return delegate.requestToBodyFlux(requestValues, bodyType);
+			public <T> Flux<T> exchangeForBodyFlux(HttpRequestValues values, ParameterizedTypeReference<T> bodyType) {
+				return HttpClientAdapter.this.requestToBodyFlux(values, bodyType);
 			}
 
 			@Override
-			public Mono<ResponseEntity<Void>> exchangeForBodilessEntityMono(HttpRequestValues requestValues) {
-				return delegate.requestToBodilessEntity(requestValues);
+			public Mono<ResponseEntity<Void>> exchangeForBodilessEntityMono(HttpRequestValues values) {
+				return HttpClientAdapter.this.requestToBodilessEntity(values);
 			}
 
 			@Override
 			public <T> Mono<ResponseEntity<T>> exchangeForEntityMono(
 					HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
 
-				return delegate.requestToEntity(requestValues, bodyType);
+				return HttpClientAdapter.this.requestToEntity(requestValues, bodyType);
 			}
 
 			@Override
 			public <T> Mono<ResponseEntity<Flux<T>>> exchangeForEntityFlux(
 					HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType) {
 
-				return delegate.requestToEntityFlux(requestValues, bodyType);
-			}
-
-			@Override
-			public boolean supportsRequestAttributes() {
-				return true;
+				return HttpClientAdapter.this.requestToEntityFlux(requestValues, bodyType);
 			}
 		};
 	}

spring-web/src/main/java/org/springframework/web/service/invoker/HttpExchangeAdapter.java

@@ -30,6 +30,11 @@
  */
 public interface HttpExchangeAdapter {
 
+	/**
+	 * Whether the underlying client supports use of request attributes.
+	 */
+	boolean supportsRequestAttributes();
+
 	/**
 	 * Perform the given request, and release the response content, if any.
 	 * @param requestValues the request to perform
@@ -49,26 +54,23 @@ public interface HttpExchangeAdapter {
 	 * @param requestValues the request to perform
 	 * @param bodyType the target type to decode to
 	 * @param <T> the type the response is decoded to
-	 * @return the decoded response.
+	 * @return the decoded response body.
 	 */
 	@Nullable
 	<T> T exchangeForBody(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType);
 
 	/**
 	 * Variant of {@link #exchange(HttpRequestValues)} with additional
 	 * access to the response status and headers.
+	 * @return the response entity with status and headers.
 	 */
 	ResponseEntity<Void> exchangeForBodilessEntity(HttpRequestValues requestValues);
 
 	/**
 	 * Variant of {@link #exchangeForBody(HttpRequestValues, ParameterizedTypeReference)}
 	 * with additional access to the response status and headers.
+	 * @return the response entity with status, headers, and body.
 	 */
 	<T> ResponseEntity<T> exchangeForEntity(HttpRequestValues requestValues, ParameterizedTypeReference<T> bodyType);
 
-	/**
-	 * A flag that indicates whether request attributes are supported by a specific client
-	 * adapter.
-	 */
-	boolean supportsRequestAttributes();
 }