Merge pull request #2 from SourceLabOrg/sp/httpClient5

Crim · web-flow · commit 4533f525642c · 2021-01-19T17:01:54.000+09:00
Refactor to use HttpComponents/HttpClient 5.0.x
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,5 +2,8 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.2.0 (01/19/2021)
+- Upgrade internal dependency of HttpClient from 4.5.x to 5.0.3. 
+
 ## 0.1.0 (01/18/2021)
 - Initial release!
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>org.sourcelab</groupId>
     <artifactId>java-hkp-client</artifactId>
-    <version>0.1.1-SNAPSHOT</version>
+    <version>0.2.0</version>
 
     <!-- Require Maven 3.3.9 -->
     <prerequisites>
@@ -48,7 +48,7 @@
         <maven.compiler.target>8</maven.compiler.target>
 
         <!-- Http Components version -->
-        <http-components.version>4.5.13</http-components.version>
+        <http-components.version>5.0.3</http-components.version>
 
         <!-- Specify which Checkstyle ruleset to use -->
         <checkstyle.ruleset>build/checkstyle.xml</checkstyle.ruleset>
@@ -75,8 +75,8 @@
     <dependencies>
         <!-- Http Client -->
         <dependency>
-            <groupId>org.apache.httpcomponents</groupId>
-            <artifactId>httpclient</artifactId>
+            <groupId>org.apache.httpcomponents.client5</groupId>
+            <artifactId>httpclient5</artifactId>
             <version>${http-components.version}</version>
         </dependency>
 
diff --git a/src/main/java/org/sourcelab/hkp/HkpClient.java b/src/main/java/org/sourcelab/hkp/HkpClient.java
@@ -26,13 +26,13 @@
 import org.sourcelab.hkp.request.GetRequest;
 import org.sourcelab.hkp.request.Request;
 import org.sourcelab.hkp.request.SearchRequest;
+import org.sourcelab.hkp.response.ErrorResponse;
+import org.sourcelab.hkp.response.Result;
 import org.sourcelab.hkp.response.get.PgpPublicKey;
 import org.sourcelab.hkp.response.search.SearchIndexResponse;
-import org.sourcelab.hkp.rest.HttpClientRestClient;
+import org.sourcelab.hkp.rest.HttpClient5RestClient;
 import org.sourcelab.hkp.rest.RestClient;
 import org.sourcelab.hkp.rest.RestResponse;
-import org.sourcelab.hkp.response.ErrorResponse;
-import org.sourcelab.hkp.response.Result;
 
 import java.io.IOException;
 import java.util.Objects;
@@ -66,7 +66,7 @@ public class HkpClient implements AutoCloseable {
     public HkpClient(final ConfigurationBuilder configurationBuilder) {
         this(
             configurationBuilder,
-            new HttpClientRestClient()
+            new HttpClient5RestClient()
         );
     }
 
diff --git a/src/main/java/org/sourcelab/hkp/rest/HttpClient5RestClient.java b/src/main/java/org/sourcelab/hkp/rest/HttpClient5RestClient.java
@@ -17,30 +17,32 @@
 
 package org.sourcelab.hkp.rest;
 
-import org.apache.http.HttpHost;
-import org.apache.http.NameValuePair;
-import org.apache.http.auth.AuthScope;
-import org.apache.http.auth.UsernamePasswordCredentials;
-import org.apache.http.client.AuthCache;
-import org.apache.http.client.ClientProtocolException;
-import org.apache.http.client.CredentialsProvider;
-import org.apache.http.client.ResponseHandler;
-import org.apache.http.client.config.RequestConfig;
-import org.apache.http.client.entity.UrlEncodedFormEntity;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.protocol.HttpClientContext;
-import org.apache.http.client.utils.URIBuilder;
-import org.apache.http.conn.socket.LayeredConnectionSocketFactory;
-import org.apache.http.conn.ssl.NoopHostnameVerifier;
-import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
-import org.apache.http.impl.auth.BasicScheme;
-import org.apache.http.impl.client.BasicAuthCache;
-import org.apache.http.impl.client.BasicCredentialsProvider;
-import org.apache.http.impl.client.CloseableHttpClient;
-import org.apache.http.impl.client.HttpClientBuilder;
-import org.apache.http.message.BasicNameValuePair;
-import org.apache.http.ssl.SSLContexts;
+import org.apache.hc.client5.http.ClientProtocolException;
+import org.apache.hc.client5.http.auth.AuthCache;
+import org.apache.hc.client5.http.auth.AuthScope;
+import org.apache.hc.client5.http.auth.CredentialsStore;
+import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.config.RequestConfig;
+import org.apache.hc.client5.http.impl.auth.BasicAuthCache;
+import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
+import org.apache.hc.client5.http.impl.auth.BasicScheme;
+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.PoolingHttpClientConnectionManagerBuilder;
+import org.apache.hc.client5.http.io.HttpClientConnectionManager;
+import org.apache.hc.client5.http.protocol.HttpClientContext;
+import org.apache.hc.client5.http.ssl.DefaultHostnameVerifier;
+import org.apache.hc.client5.http.ssl.NoopHostnameVerifier;
+import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
+import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactoryBuilder;
+import org.apache.hc.core5.http.ClassicHttpRequest;
+import org.apache.hc.core5.http.HttpHost;
+import org.apache.hc.core5.http.io.HttpClientResponseHandler;
+import org.apache.hc.core5.http.ssl.TLS;
+import org.apache.hc.core5.net.URIBuilder;
+import org.apache.hc.core5.ssl.SSLContexts;
+import org.apache.hc.core5.util.Timeout;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sourcelab.hkp.ConnectionFailedException;
@@ -55,7 +57,6 @@
 import javax.net.ssl.TrustManager;
 import javax.net.ssl.TrustManagerFactory;
 import java.io.IOException;
-import java.net.ConnectException;
 import java.net.SocketException;
 import java.net.URISyntaxException;
 import java.nio.charset.StandardCharsets;
@@ -64,17 +65,13 @@
 import java.security.KeyStoreException;
 import java.security.NoSuchAlgorithmException;
 import java.security.SecureRandom;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
-import java.util.concurrent.TimeUnit;
 
 /**
  * RestClient implementation using HTTPClient.
  */
-public class HttpClientRestClient implements RestClient {
-    private static final Logger logger = LoggerFactory.getLogger(HttpClientRestClient.class);
+public class HttpClient5RestClient implements RestClient {
+    private static final Logger logger = LoggerFactory.getLogger(HttpClient5RestClient.class);
 
     /**
      * Save a copy of the configuration.
@@ -90,7 +87,7 @@ public class HttpClientRestClient implements RestClient {
     /**
      * Constructor.
      */
-    public HttpClientRestClient() {
+    public HttpClient5RestClient() {
     }
 
     /**
@@ -123,23 +120,22 @@ public void init(final Configuration configuration) {
             hostnameVerifier = NoopHostnameVerifier.INSTANCE;
         } else {
             // Use default implementation
-            hostnameVerifier = SSLConnectionSocketFactory.getDefaultHostnameVerifier();
+            hostnameVerifier = new DefaultHostnameVerifier();
         }
 
         // Allow TLSv1_1 and TLSv1_2 protocols
-        final LayeredConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(
-            sslcontext,
-            new String[] { "TLSv1.1", "TLSv1.2" },
-            null,
-            hostnameVerifier
-        );
+        final SSLConnectionSocketFactory sslsf = SSLConnectionSocketFactoryBuilder.create()
+            .setSslContext(sslcontext)
+            .setTlsVersions(TLS.V_1_1, TLS.V_1_2)
+            .setHostnameVerifier(hostnameVerifier)
+            .build();
+        final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create()
+            .setSSLSocketFactory(sslsf)
+            .build();
 
         // Setup client builder
-        final HttpClientBuilder clientBuilder = HttpClientBuilder.create();
-        clientBuilder
-            // Disconnect requests after 120 seconds.
-            .setConnectionTimeToLive(configuration.getRequestTimeoutSecs(), TimeUnit.SECONDS)
-            .setSSLSocketFactory(sslsf);
+        final HttpClientBuilder clientBuilder = HttpClientBuilder.create()
+            .setConnectionManager(cm);
 
         // Define our RequestConfigBuilder
         final RequestConfig.Builder requestConfigBuilder = RequestConfig.custom();
@@ -154,32 +150,32 @@ public void init(final Configuration configuration) {
         if (configuration.hasProxyConfigured()) {
             // Define proxy host
             final HttpHost proxyHost = new HttpHost(
+                configuration.getProxyConfiguration().getScheme(),
                 configuration.getProxyConfiguration().getHost(),
-                configuration.getProxyConfiguration().getPort(),
-                configuration.getProxyConfiguration().getScheme()
+                configuration.getProxyConfiguration().getPort()
             );
 
             // If we have proxy auth enabled
             if (configuration.getProxyConfiguration().isAuthenticationRequired()) {
                 // Create credential provider
-                final CredentialsProvider credsProvider = new BasicCredentialsProvider();
+                final CredentialsStore credsProvider = new BasicCredentialsProvider();
                 credsProvider.setCredentials(
                     new AuthScope(
                         configuration.getProxyConfiguration().getHost(),
                         configuration.getProxyConfiguration().getPort()
                     ),
                     new UsernamePasswordCredentials(
                         configuration.getProxyConfiguration().getUsername(),
-                        configuration.getProxyConfiguration().getPassword()
+                        configuration.getProxyConfiguration().getPassword().toCharArray()
                     )
                 );
 
                 // Preemptive load context with authentication.
                 authCache.put(
                     new HttpHost(
+                        configuration.getProxyConfiguration().getScheme(),
                         configuration.getProxyConfiguration().getHost(),
-                        configuration.getProxyConfiguration().getPort(),
-                        configuration.getProxyConfiguration().getScheme()
+                        configuration.getProxyConfiguration().getPort()
                     ),
                     new BasicScheme()
                 );
@@ -190,7 +186,10 @@ public void init(final Configuration configuration) {
             }
 
             // Attach Proxy to request config builder
-            requestConfigBuilder.setProxy(proxyHost);
+            requestConfigBuilder
+                .setConnectionRequestTimeout(Timeout.ofSeconds(configuration.getRequestTimeoutSecs()))
+                .setConnectTimeout(Timeout.ofSeconds(configuration.getRequestTimeoutSecs()))
+                .setProxy(proxyHost);
 
             // Configure context.
             httpClientContext.setAuthCache(authCache);
@@ -233,8 +232,8 @@ public void close() {
         if (httpClient != null) {
             try {
                 httpClient.close();
-            } catch (IOException e) {
-                logger.error("Error closing: {}", e.getMessage(), e);
+            } catch (final IOException exception) {
+                logger.error("Error closing: {}", exception.getMessage(), exception);
             }
         }
         httpClient = null;
@@ -250,7 +249,7 @@ public void close() {
     public RestResponse submitRequest(final Request request) throws RestException {
         try {
             return submitRequest(request, new RestResponseHandler());
-        } catch (IOException exception) {
+        } catch (final IOException exception) {
             throw new RestException(exception.getMessage(), exception);
         }
     }
@@ -262,7 +261,7 @@ public RestResponse submitRequest(final Request request) throws RestException {
      * @param <T> The return type.
      * @return The parsed API response.
      */
-    private <T> T submitRequest(final Request request, final ResponseHandler<T> responseHandler) throws IOException {
+    private <T> T submitRequest(final Request request, final HttpClientResponseHandler<T> responseHandler) throws IOException {
         final String url = constructApiUrl(request);
         return submitRequest(url, request.getRequestParameters(), responseHandler);
     }
@@ -276,7 +275,7 @@ private <T> T submitRequest(final Request request, final ResponseHandler<T> resp
      * @return Parsed response.
      * @throws ConnectionFailedException if remote server does not accept connection.
      */
-    private <T> T submitRequest(final String url, final Map<String, String> getParams, final ResponseHandler<T> responseHandler) throws IOException {
+    private <T> T submitRequest(final String url, final Map<String, String> getParams, final HttpClientResponseHandler<T> responseHandler) {
         try {
             // Construct URI including our request parameters.
             final URIBuilder uriBuilder = new URIBuilder(url)
@@ -288,13 +287,13 @@ private <T> T submitRequest(final String url, final Map<String, String> getParam
             }
 
             // Build Get Request
-            final HttpGet get = new HttpGet(uriBuilder.build());
+            final ClassicHttpRequest get = new HttpGet(uriBuilder.build());
 
             // Debug logging
-            logger.info("Executing request {}", get.getRequestLine());
+            logger.info("Executing request {}", get.getRequestUri());
 
             // Execute and return
-            return httpClient.execute(get, responseHandler, httpClientContext);
+            return httpClient.execute(get, httpClientContext, responseHandler);
         } catch (final ClientProtocolException | SocketException | URISyntaxException | SSLHandshakeException connectionException) {
             // Signals that an error occurred while attempting to connect a
             // socket to a remote address and port.  Typically, the connection
diff --git a/src/main/java/org/sourcelab/hkp/rest/handlers/RestResponseHandler.java b/src/main/java/org/sourcelab/hkp/rest/handlers/RestResponseHandler.java
@@ -17,10 +17,11 @@
 
 package org.sourcelab.hkp.rest.handlers;
 
-import org.apache.http.HttpEntity;
-import org.apache.http.HttpResponse;
-import org.apache.http.client.ResponseHandler;
-import org.apache.http.util.EntityUtils;
+import org.apache.hc.core5.http.ClassicHttpResponse;
+import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.ParseException;
+import org.apache.hc.core5.http.io.HttpClientResponseHandler;
+import org.apache.hc.core5.http.io.entity.EntityUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sourcelab.hkp.rest.RestResponse;
@@ -30,12 +31,12 @@
 /**
  * Handles parsing a response to RestResponse object.
  */
-public class RestResponseHandler implements ResponseHandler<RestResponse> {
+public class RestResponseHandler implements HttpClientResponseHandler<RestResponse> {
     private static final Logger logger = LoggerFactory.getLogger(RestResponseHandler.class);
 
     @Override
-    public RestResponse handleResponse(final HttpResponse response) {
-        final int statusCode = response.getStatusLine().getStatusCode();
+    public RestResponse handleResponse(final ClassicHttpResponse response) {
+        final int statusCode = response.getCode();
 
         try {
             final HttpEntity entity = response.getEntity();
@@ -46,7 +47,7 @@ public RestResponse handleResponse(final HttpResponse response) {
 
             // Construct return object
             return new RestResponse(responseStr, statusCode);
-        } catch (final IOException exception) {
+        } catch (final IOException | ParseException exception) {
             logger.error("Failed to read entity: {}", exception.getMessage(), exception);
             throw new RuntimeException("Failed to read entity", exception);
         }
diff --git a/src/main/java/org/sourcelab/hkp/rest/handlers/StringResponseHandler.java b/src/main/java/org/sourcelab/hkp/rest/handlers/StringResponseHandler.java
@@ -17,27 +17,37 @@
 
 package org.sourcelab.hkp.rest.handlers;
 
-import org.apache.http.HttpEntity;
-import org.apache.http.HttpResponse;
-import org.apache.http.client.ResponseHandler;
-import org.apache.http.util.EntityUtils;
+import org.apache.hc.core5.http.ClassicHttpResponse;
+import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.ParseException;
+import org.apache.hc.core5.http.io.HttpClientResponseHandler;
+import org.apache.hc.core5.http.io.entity.EntityUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 
 /**
  * Returns response as a string.
  */
-public class StringResponseHandler implements ResponseHandler<String> {
-    @Override
-    public String handleResponse(final HttpResponse response) throws IOException {
+public class StringResponseHandler implements HttpClientResponseHandler<String> {
+    private static final Logger logger = LoggerFactory.getLogger(StringResponseHandler.class);
 
-        final HttpEntity entity = response.getEntity();
-        final String responseStr = entity != null ? EntityUtils.toString(entity) : null;
+    @Override
+    public String handleResponse(final ClassicHttpResponse response) throws IOException {
+        try {
+            final HttpEntity entity = response.getEntity();
+            final String responseStr;
+            responseStr = entity != null ? EntityUtils.toString(entity) : null;
 
-        // Fully consume entity.
-        EntityUtils.consume(entity);
+            // Fully consume entity.
+            EntityUtils.consume(entity);
 
-        // Construct return object
-        return responseStr;
+            // Construct return object
+            return responseStr;
+        } catch (final ParseException exception) {
+            logger.error("Failed to read entity: {}", exception.getMessage(), exception);
+            throw new RuntimeException("Failed to read entity", exception);
+        }
     }
 }
diff --git a/src/test/java/org/sourcelab/hkp/HkpClientTest.java b/src/test/java/org/sourcelab/hkp/HkpClientTest.java
