Introduce HttpComponents HttpClient 5 support.

Resolves #1164.
Original Pull Request: #1356.

polish

polish

polish

pom.xml

@@ -96,6 +96,7 @@
         <ehcache.version>2.10.9.2</ehcache.version>
         <greenmail.version>2.0.0-alpha-2</greenmail.version>
         <httpclient.version>4.5.3</httpclient.version>
+        <httpclient5.version>5.2.1</httpclient5.version>
         <jakarta-annotation.version>2.1.1</jakarta-annotation.version>
         <jakarta-jms.version>3.1.0</jakarta-jms.version>
         <jakarta-mail-api.version>2.1.0</jakarta-mail-api.version>

spring-ws-core/pom.xml

@@ -160,6 +160,24 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents.client5</groupId>
+            <artifactId>httpclient5</artifactId>
+            <version>${httpclient5.version}</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>${httpclient.version}</version>
+            <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
 
         <dependency>
             <groupId>org.eclipse.jetty</groupId>

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

@@ -0,0 +1,239 @@
+/*
+ * Copyright 2005-2023 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
+ *
+ *      http://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.net.URI;
+import java.net.URISyntaxException;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import org.apache.hc.client5.http.HttpRoute;
+import org.apache.hc.client5.http.auth.AuthScope;
+import org.apache.hc.client5.http.auth.Credentials;
+import org.apache.hc.client5.http.config.RequestConfig;
+import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
+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.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
+import org.apache.hc.core5.http.HttpHost;
+
+import org.springframework.beans.factory.FactoryBean;
+
+/**
+ * {@code FactoryBean} to set up a <a href="http://hc.apache.org/httpcomponents-client">Apache
+ * CloseableHttpClient</a>
+ *
+ * @author Lars Uffmann
+ * @since 4.0.5
+ */
+public class HttpComponents5ClientFactory implements FactoryBean<CloseableHttpClient> {
+	private static final int DEFAULT_CONNECTION_TIMEOUT_MILLISECONDS = (60 * 1000);
+
+	private int connectionTimeout = DEFAULT_CONNECTION_TIMEOUT_MILLISECONDS;
+	private static final int DEFAULT_READ_TIMEOUT_MILLISECONDS = (60 * 1000);
+
+	private int readTimeout = DEFAULT_READ_TIMEOUT_MILLISECONDS;
+
+	private int maxTotalConnections = -1;
+	private AuthScope authScope = null;
+
+	private Credentials credentials = null;
+
+	private Map<String, String> maxConnectionsPerHost = Map.of();
+
+	private PoolingHttpClientConnectionManager connectionManager;
+
+	private HttpClientBuilderCustomizer clientBuilderCustomizer;
+
+	private PoolingHttpClientConnectionManagerBuilderCustomizer connectionManagerBuilderCustomizer;
+
+	/**
+	 * Sets the credentials to be used. If not set, no authentication is done.
+	 *
+	 * @see org.apache.hc.client5.http.auth.UsernamePasswordCredentials
+	 * @see org.apache.hc.client5.http.auth.NTCredentials
+	 */
+	public void setCredentials(Credentials credentials) {
+		this.credentials = credentials;
+	}
+
+	/**
+	 * Sets the authentication scope to be used. Only used when the {@code credentials} property has been set.
+	 * <p>
+	 * By default, the {@link AuthScope#ANY} is used.
+	 *
+	 * @see #setCredentials(Credentials)
+	 */
+	public void setAuthScope(AuthScope authScope) {
+		this.authScope = authScope;
+	}
+
+	/**
+	 * Sets the timeout until a connection is established. A value of 0 means <em>never</em> timeout.
+	 *
+	 * @param timeout the timeout value in milliseconds
+	 */
+	public void setConnectionTimeout(int timeout) {
+		if (timeout < 0) {
+			throw new IllegalArgumentException("timeout must be a non-negative value");
+		}
+		this.connectionTimeout = timeout;
+	}
+
+	/**
+	 * Set the socket read timeout for the underlying HttpClient. A value of 0 means <em>never</em> timeout.
+	 *
+	 * @param timeout the timeout value in milliseconds
+	 */
+	public void setReadTimeout(int timeout) {
+		if (timeout < 0) {
+			throw new IllegalArgumentException("timeout must be a non-negative value");
+		}
+		this.readTimeout = timeout;
+	}
+
+	/**
+	 * Sets the maximum number of connections allowed for the underlying HttpClient.
+	 *
+	 * @param maxTotalConnections the maximum number of connections allowed
+	 * @see PoolingHttpClientConnectionManager...
+	 */
+	public void setMaxTotalConnections(int maxTotalConnections) {
+		if (maxTotalConnections <= 0) {
+			throw new IllegalArgumentException("maxTotalConnections must be a positive value");
+		}
+		this.maxTotalConnections = maxTotalConnections;
+	}
+
+	/**
+	 * Sets the maximum number of connections per host for the underlying HttpClient. The maximum number of connections
+	 * per host can be set in a form accepted by the {@code java.util.Properties} class, like as follows:
+	 *
+	 * <pre>
+	 * https://www.example.com=1
+	 * http://www.example.com:8080=7
+	 * http://www.springframework.org=10
+	 * </pre>
+	 * <p>
+	 * The host can be specified as a URI (with scheme and port).
+	 *
+	 * @param maxConnectionsPerHost a properties object specifying the maximum number of connection
+	 * @see PoolingHttpClientConnectionManager...
+	 */
+	public void setMaxConnectionsPerHost(Map<String, String> maxConnectionsPerHost) {
+		this.maxConnectionsPerHost = maxConnectionsPerHost;
+	}
+
+	void applyMaxConnectionsPerHost(PoolingHttpClientConnectionManager connectionManager) throws URISyntaxException {
+
+		for (Map.Entry<String, String> entry : maxConnectionsPerHost.entrySet()) {
+			URI uri = new URI(entry.getKey());
+			HttpHost host = new HttpHost(uri.getScheme(), uri.getHost(), getPort(uri));
+			final HttpRoute route;
+
+			if (uri.getScheme().equals("https")) {
+				route = new HttpRoute(host, null, true);
+			}
+			else {
+				route = new HttpRoute(host);
+			}
+			int max = Integer.parseInt(entry.getValue());
+			connectionManager.setMaxPerRoute(route, max);
+		}
+	}
+
+	static int getPort(URI uri) {
+		if (uri.getPort() == -1) {
+			if ("https".equalsIgnoreCase(uri.getScheme())) {
+				return 443;
+			}
+			if ("http".equalsIgnoreCase(uri.getScheme())) {
+				return 80;
+			}
+		}
+		return uri.getPort();
+	}
+
+	@Override
+	public boolean isSingleton() {
+		return true;
+	}
+
+	@Override
+	public CloseableHttpClient getObject() throws Exception {
+		PoolingHttpClientConnectionManagerBuilder connectionManagerBuilder = PoolingHttpClientConnectionManagerBuilder.create();
+		if (this.maxTotalConnections != -1) {
+			connectionManagerBuilder.setMaxConnTotal(this.maxTotalConnections);
+		}
+
+		if (null != this.connectionManagerBuilderCustomizer) {
+			this.connectionManagerBuilderCustomizer.customize(connectionManagerBuilder);
+		}
+
+		this.connectionManager = connectionManagerBuilder.build();
+
+		applyMaxConnectionsPerHost(connectionManager);
+
+		RequestConfig.Builder requestConfigBuilder = RequestConfig.custom()
+				.setConnectTimeout(connectionTimeout, TimeUnit.MILLISECONDS)
+				.setResponseTimeout(readTimeout, TimeUnit.MILLISECONDS);
+
+		HttpClientBuilder httpClientBuilder = HttpClientBuilder.create()
+				.setDefaultRequestConfig(requestConfigBuilder.build())
+				.setConnectionManager(connectionManager);
+
+		if (null != credentials && null != authScope) {
+			BasicCredentialsProvider basicCredentialsProvider = new BasicCredentialsProvider();
+			basicCredentialsProvider.setCredentials(authScope, credentials);
+			httpClientBuilder.setDefaultCredentialsProvider(basicCredentialsProvider);
+		}
+
+		if (null != this.clientBuilderCustomizer) {
+			clientBuilderCustomizer.customize(httpClientBuilder);
+		}
+
+		return httpClientBuilder.build();
+	}
+
+	@Override
+	public Class<?> getObjectType() {
+		return CloseableHttpClient.class;
+	}
+
+	PoolingHttpClientConnectionManager getConnectionManager() {
+		return this.connectionManager;
+	}
+
+	public void setClientBuilderCustomizer(HttpClientBuilderCustomizer clientBuilderCustomizer) {
+		this.clientBuilderCustomizer = clientBuilderCustomizer;
+	}
+
+	public void setConnectionManagerBuilderCustomizer(PoolingHttpClientConnectionManagerBuilderCustomizer connectionManagerBuilderCustomizer) {
+		this.connectionManagerBuilderCustomizer = connectionManagerBuilderCustomizer;
+	}
+
+	@FunctionalInterface
+	public interface HttpClientBuilderCustomizer {
+		void customize(HttpClientBuilder httpClientBuilder);
+	}
+
+	@FunctionalInterface
+	public interface PoolingHttpClientConnectionManagerBuilderCustomizer {
+		void customize(PoolingHttpClientConnectionManagerBuilder poolingHttpClientConnectionManagerBuilder);
+	}
+}