Simplify HttpComponents5MessageSender

Previously, HttpComponents5MessageSender can be configured to use both
a custom HttpClient or configure one using a number of convenient
properties. This setup creates an odd arrangement where calling those
convenient methods once an HttpClient is set throws an exception as
the implementation supports one or the other.

This commit moves the first use case in a simple implementation that
only accepts a custom HttpClient or the state of
HttpComponents5ClientFactory for convenience and discoverability.

Specifying an HttpComponents5MessageSender is deprecated as a result.

Closes gh-1519

Author: snicoll

spring-ws-core/src/main/java/org/springframework/ws/transport/http/AbstractHttpComponents5MessageSender.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2005-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.ws.transport.http;
+
+import java.io.IOException;
+import java.net.URI;
+
+import org.apache.hc.client5.http.classic.HttpClient;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
+import org.apache.hc.core5.http.EntityDetails;
+import org.apache.hc.core5.http.HttpException;
+import org.apache.hc.core5.http.HttpHeaders;
+import org.apache.hc.core5.http.HttpHost;
+import org.apache.hc.core5.http.HttpRequest;
+import org.apache.hc.core5.http.HttpRequestInterceptor;
+import org.apache.hc.core5.http.protocol.HttpContext;
+
+import org.springframework.beans.factory.DisposableBean;
+import org.springframework.ws.transport.WebServiceConnection;
+
+/**
+ * Base {@link AbstractHttpWebServiceMessageSender} implementation that uses
+ * <a href="http://hc.apache.org/httpcomponents-client">Apache HttpClient</a> to execute
+ * POST requests.
+ * <p>
+ * To configure the underlying {@link HttpClient} consider using
+ * {@link HttpComponents5MessageSender}. To take control on how the {@link HttpClient} is
+ * built, use {@link SimpleHttpComponents5MessageSender}.
+ *
+ * @author Stephane Nicoll
+ * @since 4.1.0
+ * @see HttpComponents5MessageSender
+ * @see SimpleHttpComponents5MessageSender
+ */
+public abstract class AbstractHttpComponents5MessageSender extends AbstractHttpWebServiceMessageSender
+		implements DisposableBean {
+
+	/**
+	 * Return the {@code HttpClient} used by this message sender.
+	 */
+	public abstract HttpClient getHttpClient();
+
+	@Override
+	public WebServiceConnection createConnection(URI uri) throws IOException {
+		HttpPost httpPost = new HttpPost(uri);
+		if (isAcceptGzipEncoding()) {
+			httpPost.addHeader(HttpTransportConstants.HEADER_ACCEPT_ENCODING,
+					HttpTransportConstants.CONTENT_ENCODING_GZIP);
+		}
+		HttpHost httpHost = HttpHost.create(uri);
+		HttpContext httpContext = createContext(uri);
+		return new HttpComponents5Connection(getHttpClient(), httpHost, httpPost, httpContext);
+	}
+
+	@Override
+	public void destroy() throws Exception {
+		if (getHttpClient() instanceof CloseableHttpClient client) {
+			client.close();
+		}
+	}
+
+	/**
+	 * Template method that allows for creation of an {@link HttpContext} for the given
+	 * uri. Default implementation returns {@code null}.
+	 * @param uri the URI to create the context for
+	 * @return the context, or {@code null}
+	 */
+	protected HttpContext createContext(URI uri) {
+		return null;
+	}
+
+	/**
+	 * HttpClient {@link HttpRequestInterceptor} implementation that removes
+	 * {@code Content-Length} and {@code Transfer-Encoding} headers from the request.
+	 * Necessary, because some SAAJ and other SOAP implementations set these headers
+	 * themselves, and HttpClient throws an exception if they have been set.
+	 */
+	public static class RemoveSoapHeadersInterceptor implements HttpRequestInterceptor {
+
+		@Override
+		public void process(HttpRequest request, EntityDetails entityDetails, HttpContext httpContext)
+				throws HttpException, IOException {
+
+			if (request.containsHeader(HttpHeaders.TRANSFER_ENCODING)) {
+				request.removeHeaders(HttpHeaders.TRANSFER_ENCODING);
+			}
+
+			if (request.containsHeader(HttpHeaders.CONTENT_LENGTH)) {
+				request.removeHeaders(HttpHeaders.CONTENT_LENGTH);
+			}
+		}
+
+	}
+
+}

spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpComponents5MessageSender.java

@@ -16,40 +16,26 @@
 
 package org.springframework.ws.transport.http;
 
-import java.io.IOException;
-import java.net.URI;
 import java.time.Duration;
 import java.util.Map;
 
 import org.apache.hc.client5.http.auth.AuthScope;
 import org.apache.hc.client5.http.auth.Credentials;
 import org.apache.hc.client5.http.classic.HttpClient;
-import org.apache.hc.client5.http.classic.methods.HttpPost;
-import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
 import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
 import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
-import org.apache.hc.core5.http.EntityDetails;
-import org.apache.hc.core5.http.HttpException;
-import org.apache.hc.core5.http.HttpHeaders;
-import org.apache.hc.core5.http.HttpHost;
-import org.apache.hc.core5.http.HttpRequest;
 import org.apache.hc.core5.http.HttpRequestInterceptor;
-import org.apache.hc.core5.http.protocol.HttpContext;
 
-import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.util.Assert;
-import org.springframework.ws.transport.WebServiceConnection;
 
 /**
- * {@code WebServiceMessageSender} implementation that uses
- * <a href="http://hc.apache.org/httpcomponents-client">Apache HttpClient</a> to execute
- * POST requests.
+ * {@code AbstractHttpComponents5MessageSender} implementation that configures the
+ * underlying <a href="http://hc.apache.org/httpcomponents-client">Apache HttpClient</a>
+ * that executes POST requests.
  * <p>
- * Allows to use a pre-configured HttpClient instance, potentially with authentication,
- * HTTP connection pooling, etc. Authentication can also be set by injecting a
- * {@link Credentials} instance (such as the
- * {@link org.apache.hc.client5.http.auth.UsernamePasswordCredentials}).
+ * To specify the {@link HttpClient}, consider using
+ * {@link SimpleHttpComponents5MessageSender} instead.
  *
  * @author Alan Stewart
  * @author Barry Pitman
@@ -59,8 +45,7 @@
  * @since 4.0.5
  * @see HttpClient
  */
-public class HttpComponents5MessageSender extends AbstractHttpWebServiceMessageSender
-		implements InitializingBean, DisposableBean {
+public class HttpComponents5MessageSender extends AbstractHttpComponents5MessageSender implements InitializingBean {
 
 	private static final String HTTP_CLIENT_ALREADY_SET = "httpClient already set";
 
@@ -87,40 +72,43 @@ public HttpComponents5MessageSender() {
 	 * {@linkplain HttpClientBuilder#addRequestInterceptorFirst(HttpRequestInterceptor)
 	 * add} the {@link RemoveSoapHeadersInterceptor}.
 	 * @param httpClient the HttpClient instance to use for this sender
+	 * @deprecated as of 4.1.0 in favor of {@link SimpleHttpComponents5MessageSender}
 	 */
+	@Deprecated(since = "4.1.0", forRemoval = true)
 	public HttpComponents5MessageSender(HttpClient httpClient) {
 		this();
 		Assert.notNull(httpClient, "httpClient must not be null");
 		this.httpClient = httpClient;
 	}
 
-	/*
-	 * * @see HttpComponents5ClientFactory#setAuthScope(AuthScope)
+	@Override
+	public HttpClient getHttpClient() {
+		return this.httpClient;
+	}
+
+	/**
+	 * Set the authentication scope to be used. Only used when the {@code credentials}
+	 * property has been set.
+	 * @see HttpComponents5ClientFactory#setAuthScope(AuthScope)
 	 */
 	public void setAuthScope(AuthScope authScope) {
-		if (getHttpClient() != null) {
+		if (this.httpClient != null) {
 			throw new IllegalStateException(HTTP_CLIENT_ALREADY_SET);
 		}
 		this.clientFactory.setAuthScope(authScope);
 	}
 
-	/*
-	 * * @see HttpComponents5ClientFactory#setCredentials(Credentials)
+	/**
+	 * Set the credentials to be used. If not set, no authentication is done.
+	 * @see HttpComponents5ClientFactory#setCredentials(Credentials)
 	 */
 	public void setCredentials(Credentials credentials) {
-		if (getHttpClient() != null) {
+		if (this.httpClient != null) {
 			throw new IllegalStateException(HTTP_CLIENT_ALREADY_SET);
 		}
 		this.clientFactory.setCredentials(credentials);
 	}
 
-	/**
-	 * Returns the {@code HttpClient} used by this message sender.
-	 */
-	public HttpClient getHttpClient() {
-		return this.httpClient;
-	}
-
 	/**
 	 * Set the {@code HttpClient} used by this message sender.
 	 * <p>
@@ -129,7 +117,9 @@ public HttpClient getHttpClient() {
 	 * {@linkplain HttpClientBuilder#addRequestInterceptorFirst(HttpRequestInterceptor)
 	 * add} the {@link RemoveSoapHeadersInterceptor}.
 	 * @param httpClient the HttpClient to use
+	 * @deprecated as of 4.1.0 in favor of {@link SimpleHttpComponents5MessageSender}
 	 */
+	@Deprecated(since = "4.1.0", forRemoval = true)
 	public void setHttpClient(HttpClient httpClient) {
 		this.httpClient = httpClient;
 	}
@@ -139,7 +129,7 @@ public void setHttpClient(HttpClient httpClient) {
 	 * @see HttpComponents5ClientFactory#setConnectionTimeout(Duration)
 	 */
 	public void setConnectionTimeout(Duration timeout) {
-		if (getHttpClient() != null) {
+		if (this.httpClient != null) {
 			throw new IllegalStateException(HTTP_CLIENT_ALREADY_SET);
 		}
 		this.clientFactory.setConnectionTimeout(timeout);
@@ -150,7 +140,7 @@ public void setConnectionTimeout(Duration timeout) {
 	 * @see HttpComponents5ClientFactory#setReadTimeout(Duration)
 	 */
 	public void setReadTimeout(Duration timeout) {
-		if (getHttpClient() != null) {
+		if (this.httpClient != null) {
 			throw new IllegalStateException(HTTP_CLIENT_ALREADY_SET);
 		}
 		this.clientFactory.setReadTimeout(timeout);
@@ -161,7 +151,7 @@ public void setReadTimeout(Duration timeout) {
 	 * @see HttpComponents5ClientFactory#setMaxTotalConnections(int)
 	 */
 	public void setMaxTotalConnections(int maxTotalConnections) {
-		if (getHttpClient() != null) {
+		if (this.httpClient != null) {
 			throw new IllegalStateException(HTTP_CLIENT_ALREADY_SET);
 		}
 		this.clientFactory.setMaxTotalConnections(maxTotalConnections);
@@ -172,74 +162,17 @@ public void setMaxTotalConnections(int maxTotalConnections) {
 	 * @see HttpComponents5ClientFactory#setMaxConnectionsPerHost(Map)
 	 */
 	public void setMaxConnectionsPerHost(Map<String, String> maxConnectionsPerHost) {
-		if (getHttpClient() != null) {
+		if (this.httpClient != null) {
 			throw new IllegalStateException(HTTP_CLIENT_ALREADY_SET);
 		}
 		this.clientFactory.setMaxConnectionsPerHost(maxConnectionsPerHost);
 	}
 
 	@Override
 	public void afterPropertiesSet() throws Exception {
-		if (getHttpClient() == null) {
+		if (this.httpClient == null) {
 			this.httpClient = this.clientFactory.getObject();
 		}
 	}
 
-	@Override
-	public WebServiceConnection createConnection(URI uri) throws IOException {
-
-		HttpPost httpPost = new HttpPost(uri);
-
-		if (isAcceptGzipEncoding()) {
-			httpPost.addHeader(HttpTransportConstants.HEADER_ACCEPT_ENCODING,
-					HttpTransportConstants.CONTENT_ENCODING_GZIP);
-		}
-
-		HttpHost httpHost = HttpHost.create(uri);
-		HttpContext httpContext = createContext(uri);
-
-		return new HttpComponents5Connection(getHttpClient(), httpHost, httpPost, httpContext);
-	}
-
-	/**
-	 * Template method that allows for creation of an {@link HttpContext} for the given
-	 * uri. Default implementation returns {@code null}.
-	 * @param uri the URI to create the context for
-	 * @return the context, or {@code null}
-	 */
-	protected HttpContext createContext(URI uri) {
-		return null;
-	}
-
-	@Override
-	public void destroy() throws Exception {
-
-		if (getHttpClient() instanceof CloseableHttpClient client) {
-			client.close();
-		}
-	}
-
-	/**
-	 * HttpClient {@link HttpRequestInterceptor} implementation that removes
-	 * {@code Content-Length} and {@code Transfer-Encoding} headers from the request.
-	 * Necessary, because some SAAJ and other SOAP implementations set these headers
-	 * themselves, and HttpClient throws an exception if they have been set.
-	 */
-	public static class RemoveSoapHeadersInterceptor implements HttpRequestInterceptor {
-
-		@Override
-		public void process(HttpRequest request, EntityDetails entityDetails, HttpContext httpContext)
-				throws HttpException, IOException {
-
-			if (request.containsHeader(HttpHeaders.TRANSFER_ENCODING)) {
-				request.removeHeaders(HttpHeaders.TRANSFER_ENCODING);
-			}
-
-			if (request.containsHeader(HttpHeaders.CONTENT_LENGTH)) {
-				request.removeHeaders(HttpHeaders.CONTENT_LENGTH);
-			}
-		}
-
-	}
-
 }