Upgrade httpcomponents from 4.5.14 to 5.5

Author: hmiguim

pom.xml

@@ -127,7 +127,7 @@
         <spring.version>6.2.7</spring.version>
         <solr.version>9.8.1</solr.version>
         <pekko.version>1.1.3</pekko.version>
-        <httpcomponents.version>4.5.14</httpcomponents.version>
+        <httpcomponents.version>5.5</httpcomponents.version>
         <commons_ip2.version>2.10.0</commons_ip2.version>
         <metrics.version>3.2.6</metrics.version>
         <roda_community_url>https://roda-community.org</roda_community_url>
@@ -875,14 +875,9 @@
                 </exclusions>
             </dependency>
             <dependency>
-                <groupId>org.apache.httpcomponents</groupId>
-                <artifactId>httpclient</artifactId>
-                <version>${httpcomponents.version}</version>
-            </dependency>
-            <dependency>
-                <groupId>org.apache.httpcomponents</groupId>
-                <artifactId>httpmime</artifactId>
-                <version>${httpcomponents.version}</version>
+                <groupId>org.apache.httpcomponents.client5</groupId>
+                <artifactId>httpclient5</artifactId>
+                <version>5.5</version>
             </dependency>
             <!-- Templating system dependencies -->
             <dependency>

roda-common/roda-common-utils/pom.xml

@@ -37,12 +37,8 @@
       <artifactId>commons-io</artifactId>
     </dependency>
     <dependency>
-      <groupId>org.apache.httpcomponents</groupId>
-      <artifactId>httpclient</artifactId>
-    </dependency>
-    <dependency>
-      <groupId>org.apache.httpcomponents</groupId>
-      <artifactId>httpmime</artifactId>
+      <groupId>org.apache.httpcomponents.client5</groupId>
+      <artifactId>httpclient5</artifactId>
     </dependency>
       <dependency>
           <groupId>org.springframework</groupId>

roda-common/roda-common-utils/src/main/java/org/roda/core/util/RESTClientUtility.java

@@ -9,36 +9,32 @@
 
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Serializable;
 import java.nio.CharBuffer;
+import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.lang3.ArrayUtils;
-import org.apache.http.HttpEntity;
-import org.apache.http.HttpResponse;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.entity.ContentType;
-import org.apache.http.entity.StringEntity;
-import org.apache.http.entity.mime.HttpMultipartMode;
-import org.apache.http.entity.mime.MultipartEntityBuilder;
-import org.apache.http.impl.client.CloseableHttpClient;
-import org.apache.http.impl.client.HttpClientBuilder;
-import org.apache.http.util.EntityUtils;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.entity.mime.HttpMultipartMode;
+import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
+import org.apache.hc.client5.http.impl.classic.HttpClients;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.io.entity.EntityUtils;
+import org.apache.hc.core5.http.io.entity.StringEntity;
 import org.roda.core.data.common.RodaConstants;
 import org.roda.core.data.common.SecureString;
 import org.roda.core.data.exceptions.GenericException;
 import org.roda.core.data.exceptions.RODAException;
 import org.roda.core.data.utils.JsonUtils;
 import org.roda.core.data.v2.accessToken.AccessToken;
 
-import com.fasterxml.jackson.databind.JsonNode;
-
 /**
  * 20160824 hsilva: I think someone, outside RODA code base, is using this
  * method via maven dependency
@@ -52,168 +48,106 @@ private RESTClientUtility() {
     // do nothing
   }
 
-  public static <T extends Serializable> T sendPostRequest(T element, Class<T> elementClass, String url,
-    String resource, String username, String password) throws RODAException {
-    CloseableHttpClient httpClient = HttpClientBuilder.create().build();
-    String basicAuthToken = new String(Base64.encode((username + ":" + password).getBytes()));
-    HttpPost httpPost = new HttpPost(url + resource);
-    httpPost.setHeader("Authorization", "Basic " + basicAuthToken);
-    httpPost.addHeader("content-type", "application/json");
-    httpPost.addHeader("Accept", "application/json");
+  public static <T extends Serializable> T sendPostRequestWithoutBodyHttp5(Class<T> elementClass, String url,
+    String resource, AccessToken accessToken) throws GenericException {
+    try (final CloseableHttpClient httpclient = HttpClients.createDefault()) {
+      HttpPost httpPost = new HttpPost(url + resource);
+      httpPost.addHeader("Authorization", "Bearer " + accessToken.getToken());
+      httpPost.addHeader("content-type", "application/json");
+      httpPost.addHeader("Accept", "application/json");
 
-    try {
-      httpPost.setEntity(new StringEntity(JsonUtils.getJsonFromObject(element)));
-      HttpResponse response;
-      response = httpClient.execute(httpPost);
-      HttpEntity responseEntity = response.getEntity();
+      Result result = httpclient.execute(httpPost, response -> new Result(response.getCode(),
+        EntityUtils.toString(response.getEntity(), Charset.defaultCharset())));
 
-      int responseStatusCode = response.getStatusLine().getStatusCode();
-      if (responseStatusCode == 201) {
-        return JsonUtils.getObjectFromJson(responseEntity.getContent(), elementClass);
-      } else {
-        throw new RODAException("POST request response status code: " + responseStatusCode);
-      }
-    } catch (IOException e) {
-      throw new RODAException("Error sending POST request", e);
-    }
-  }
-
-  public static <T extends Serializable> T sendPostRequestWithoutBody(Class<T> elementClass, String url, String resource,
-    AccessToken accessToken) throws GenericException {
-    CloseableHttpClient httpClient = HttpClientBuilder.create().build();
-    HttpPost httpPost = new HttpPost(url + resource);
-    httpPost.addHeader("Authorization", "Bearer " + accessToken.getToken());
-    httpPost.addHeader("content-type", "application/json");
-    httpPost.addHeader("Accept", "application/json");
-
-    try {
-      HttpResponse response;
-      response = httpClient.execute(httpPost);
-      HttpEntity responseEntity = response.getEntity();
-      int responseStatusCode = response.getStatusLine().getStatusCode();
-
-      if (responseStatusCode == 201) {
+      if (result.statusCode == 201) {
         if (elementClass != null) {
-          return JsonUtils.getObjectFromJson(responseEntity.getContent(), elementClass);
+          return JsonUtils.getObjectFromJson(result.content, elementClass);
         } else {
           return null;
         }
       } else {
-        throw new GenericException("POST request response status code: " + responseStatusCode);
+        throw new GenericException("POST request response status code: " + result.statusCode);
       }
     } catch (IOException e) {
       throw new GenericException("Error sending POST request", e);
     }
   }
 
-  public static <T extends Serializable> T sendPostRequest(Object element, Class<T> elementClass, String url,
+  public static <T extends Serializable> T sendPostRequestHttpClient5(Object element, Class<T> elementClass, String url,
     String resource, AccessToken accessToken) throws GenericException {
-    CloseableHttpClient httpClient = HttpClientBuilder.create().build();
-    HttpPost httpPost = new HttpPost(url + resource);
-    httpPost.addHeader("Authorization", "Bearer " + accessToken.getToken());
-    httpPost.addHeader("content-type", "application/json");
-    httpPost.addHeader("Accept", "application/json");
+    try (final CloseableHttpClient httpclient = HttpClients.createDefault()) {
+      HttpPost httpPost = new HttpPost(url + resource);
+      httpPost.addHeader("Authorization", "Bearer " + accessToken.getToken());
+      httpPost.addHeader("content-type", "application/json");
+      httpPost.addHeader("Accept", "application/json");
 
-    try {
       httpPost.setEntity(new StringEntity(JsonUtils.getJsonFromObject(element)));
-      HttpResponse response;
-      response = httpClient.execute(httpPost);
-      HttpEntity responseEntity = response.getEntity();
 
-      int responseStatusCode = response.getStatusLine().getStatusCode();
-      if (responseStatusCode == 201) {
+      Result result = httpclient.execute(httpPost, response -> new Result(response.getCode(),
+        EntityUtils.toString(response.getEntity(), Charset.defaultCharset())));
+
+      if (result.statusCode == 201) {
         if (elementClass != null) {
-          return JsonUtils.getObjectFromJson(responseEntity.getContent(), elementClass);
+          return JsonUtils.getObjectFromJson(result.content, elementClass);
         } else {
           return null;
         }
       } else {
-        throw new GenericException("POST request response status code: " + responseStatusCode);
+        throw new GenericException("POST request response status code: " + result.statusCode);
       }
     } catch (IOException e) {
       throw new GenericException("Error sending POST request", e);
     }
   }
 
-  public static int sendPostRequestWithCompressedFile(String url, String resource, Path path, AccessToken accessToken)
-    throws RODAException, IOException {
-    CloseableHttpClient httpClient = HttpClientBuilder.create().build();
-
-    HttpPost httpPost = new HttpPost(url + resource);
-    httpPost.addHeader("Authorization", "Bearer " + accessToken.getToken());
-
-    InputStream inputStream = Files.newInputStream(path.toFile().toPath());
-    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
-    builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
-    builder.addBinaryBody(RodaConstants.API_QUERY_KEY_FILE, inputStream, ContentType.create("application/zip"),
-      path.getFileName().toString());
+  public static int sendPostRequestWithCompressedFileHttp5(String url, String resource, Path path,
+    AccessToken accessToken) throws RODAException {
+    try (final CloseableHttpClient httpclient = HttpClients.createDefault()) {
+      HttpPost httpPost = new HttpPost(url + resource);
+      httpPost.addHeader("Authorization", "Bearer " + accessToken.getToken());
 
-    HttpEntity entity = builder.build();
+      InputStream inputStream = Files.newInputStream(path.toFile().toPath());
+      MultipartEntityBuilder builder = MultipartEntityBuilder.create();
+      builder.setMode(HttpMultipartMode.STRICT);
+      builder.addBinaryBody(RodaConstants.API_QUERY_KEY_FILE, inputStream, ContentType.create("application/zip"),
+        path.getFileName().toString());
+      httpPost.setEntity(builder.build());
 
-    try {
-      httpPost.setEntity(entity);
-      HttpResponse response = httpClient.execute(httpPost);
-
-      return response.getStatusLine().getStatusCode();
+      Result result = httpclient.execute(httpPost, response -> new Result(response.getCode(), null));
 
+      return result.statusCode;
     } catch (IOException e) {
       throw new RODAException("Error sending POST request", e);
     }
   }
 
-  public static JsonNode sendPostRequest(String url, String resource, Object object) throws GenericException {
-    CloseableHttpClient httpClient = HttpClientBuilder.create().build();
-    HttpPost httpPost = new HttpPost(url + resource);
-    httpPost.addHeader("content-type", "application/json");
-    httpPost.addHeader("Accept", "application/json");
-
-    try {
-      httpPost.setEntity(new StringEntity(JsonUtils.getJsonFromObject(object)));
-      HttpResponse response;
-      response = httpClient.execute(httpPost);
-      HttpEntity responseEntity = response.getEntity();
-
-      int responseStatusCode = response.getStatusLine().getStatusCode();
-      if (responseStatusCode == 200) {
-        String json = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8);
-        return JsonUtils.parseJson(json);
-      } else {
-        throw new GenericException("POST request response status code: " + responseStatusCode);
+  public static int sendPostRequestWithFileHttp5(String url, String resource, String username, SecureString password,
+    Path file) throws RODAException {
+    try (final CloseableHttpClient httpclient = HttpClients.createDefault()) {
+      HttpPost httpPost = new HttpPost(url + resource);
+      try (
+        SecureString basicAuth = new SecureString(
+          ArrayUtils.addAll((username + ":").toCharArray(), password.getChars()));
+        SecureString basicAuthToken = new SecureString(
+          Base64.encode(StandardCharsets.UTF_8.encode(CharBuffer.wrap(basicAuth)).array()))) {
+
+        httpPost.setHeader("Authorization", "Basic " + basicAuthToken);
+        File fileToUpload = new File(FilenameUtils.normalize(file.toString()));
+        InputStream inputStream = new FileInputStream(fileToUpload);
+        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
+        builder.addBinaryBody(RodaConstants.API_QUERY_KEY_FILE, inputStream, ContentType.DEFAULT_BINARY,
+          fileToUpload.getName());
+        httpPost.setEntity(builder.build());
+
+        Result result = httpclient.execute(httpPost, response -> new Result(response.getCode(), null));
+
+        return result.statusCode;
       }
     } catch (IOException e) {
-      throw new GenericException("Error sending POST request", e);
+      throw new RODAException("Error sending POST request", e);
     }
   }
 
-  public static int sendPostRequestWithFile(String url, String resource, String username, SecureString password,
-    Path file) throws RODAException, FileNotFoundException {
-    CloseableHttpClient httpClient = HttpClientBuilder.create().build();
-    HttpPost httpPost = new HttpPost(url + resource);
-    SecureString basicAuth = new SecureString(ArrayUtils.addAll((username + ":").toCharArray(), password.getChars()));
-    SecureString basicAuthToken = new SecureString(
-      Base64.encode(StandardCharsets.UTF_8.encode(CharBuffer.wrap(basicAuth)).array()));
-
-    httpPost.setHeader("Authorization", "Basic " + basicAuthToken.toString());
-
-    File fileToUpload = new File(FilenameUtils.normalize(file.toString()));
-    InputStream inputStream = new FileInputStream(fileToUpload);
-    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
-    builder.addBinaryBody(RodaConstants.API_QUERY_KEY_FILE, inputStream, ContentType.DEFAULT_BINARY,
-      fileToUpload.getName());
-
-    HttpEntity multipart = builder.build();
-
-    try {
-      httpPost.setEntity(multipart);
-      HttpResponse response = httpClient.execute(httpPost);
-
-      return response.getStatusLine().getStatusCode();
-
-    } catch (IOException e) {
-      throw new RODAException("Error sending POST request", e);
-    } finally {
-      basicAuth.close();
-      basicAuthToken.close();
-    }
+  private record Result(int statusCode, String content) {
   }
 }

roda-core/roda-core/src/main/java/org/roda/core/model/ModelService.java

@@ -2201,7 +2201,7 @@ public synchronized void findOldLogsAndSendThemToMaster(Path logDirectory, Path
         RodaCoreFactory.getProperty(RodaConstants.CORE_ACTION_LOGS_PRIMARY_PASS, "").toCharArray())) {
       for (Path path : directoryStream) {
         if (!path.equals(currentLogFile)) {
-          int httpExitCode = RESTClientUtility.sendPostRequestWithFile(url, resource, username, password, path);
+          int httpExitCode = RESTClientUtility.sendPostRequestWithFileHttp5(url, resource, username, password, path);
           if (httpExitCode == RodaConstants.HTTP_RESPONSE_CODE_CREATED) {
             LOGGER.info("The action log file ({}) was moved to Master successfully!", path);
             Files.delete(path);

roda-core/roda-core/src/main/java/org/roda/core/plugins/base/synchronization/instance/RegisterPlugin.java

@@ -149,7 +149,7 @@ private void subscribeLocalInstance(ModelService model, Job cachedJob, Report pl
         AccessToken accessToken = TokenManager.getInstance().getAccessToken(localInstance);
         String resource = RodaConstants.API_SEP + RodaConstants.API_REST_V2_DISTRIBUTED_INSTANCE + RodaConstants.API_SEP
           + localInstance.getId() + RodaConstants.API_SEP + RodaConstants.API_PATH_PARAM_DISTRIBUTED_INSTANCE_REGISTER;
-        RESTClientUtility.sendPostRequestWithoutBody(null, localInstance.getCentralInstanceURL(), resource,
+        RESTClientUtility.sendPostRequestWithoutBodyHttp5(null, localInstance.getCentralInstanceURL(), resource,
           accessToken);
         localInstance.setIsSubscribed(true);
         localInstance.setStatus(SynchronizingStatus.ACTIVE);

roda-core/roda-core/src/main/java/org/roda/core/plugins/base/synchronization/proccess/SendSyncBundlePlugin.java

@@ -196,9 +196,9 @@ private int send(Path zipPath) throws GenericException {
 
       String resource = RodaConstants.API_SEP + RodaConstants.API_REST_V2_DISTRIBUTED_INSTANCE
         + RodaConstants.API_PATH_PARAM_DISTRIBUTED_INSTANCE_SYNC + RodaConstants.API_SEP + localInstance.getId();
-      return RESTClientUtility.sendPostRequestWithCompressedFile(localInstance.getCentralInstanceURL(), resource,
+      return RESTClientUtility.sendPostRequestWithCompressedFileHttp5(localInstance.getCentralInstanceURL(), resource,
         zipPath, accessToken);
-    } catch (RODAException | IOException e) {
+    } catch (RODAException e) {
       LOGGER.error("Unable to send bundle to central instance", e);
       throw new GenericException("Unable to send bundle to central instance", e);
     }

roda-ui/roda-wui/pom.xml

@@ -497,8 +497,8 @@
             <version>2.10.0</version>
         </dependency>
         <dependency>
-            <groupId>org.apache.httpcomponents</groupId>
-            <artifactId>httpclient</artifactId>
+            <groupId>org.apache.httpcomponents.client5</groupId>
+            <artifactId>httpclient5</artifactId>
         </dependency>
         <dependency>
             <groupId>com.github.nmorel.gwtjackson</groupId>