Skip to main content
Open source

Migrate to ApacheHttpClient 5.x

Recipe IDorg.openrewrite.apache.httpclient5.UpgradeApacheHttpClient_5
Artifactorg.openrewrite.recipe:rewrite-apache

Migrate applications to the latest Apache HttpClient 5.x release. This recipe will modify an application's build files, make changes to deprecated/preferred APIs, and migrate configuration settings that have changes between versions.

Composite recipeOpenRewritehttpclientapacheModerne Source Available License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Definition​

Preconditions1
Recipes18
18 recipes

Examples​

java
Before
import org.apache.http.client.config.CookieSpecs;

class A {
    void method() {
        String c1 = CookieSpecs.IGNORE_COOKIES;
        String c2 = CookieSpecs.STANDARD;
        String c3 = CookieSpecs.STANDARD_STRICT;
    }
}
After
import org.apache.hc.client5.http.cookie.StandardCookieSpec;

class A {
    void method() {
        String c1 = StandardCookieSpec.IGNORE;
        String c2 = StandardCookieSpec.RELAXED;
        String c3 = StandardCookieSpec.STRICT;
    }
}
java
Before
import org.apache.http.auth.AuthScope;

class A {
    void method() {
        AuthScope any = AuthScope.ANY;
    }
}
After
import org.apache.hc.client5.http.auth.AuthScope;

class A {
    void method() {
        AuthScope any = new AuthScope(null, -1);
    }
}
java
Before
import org.apache.http.auth.AuthScheme;
import org.apache.http.auth.AuthState;
import org.apache.http.auth.AuthProtocolState;

class A {
    void m(AuthState s, AuthScheme scheme) {
        s.setAuthScheme(scheme);
        s.setState(AuthProtocolState.CHALLENGED);
        s.reset();
    }
}
After
import org.apache.hc.client5.http.auth.AuthExchange.State;
import org.apache.hc.client5.http.auth.AuthScheme;
import org.apache.hc.client5.http.auth.AuthExchange;

class A {
    void m(AuthExchange s, AuthScheme scheme) {
        s.select(scheme);
        s.setState(AuthExchange.State.CHALLENGED);
        s.reset();
    }
}
java
Before
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;

import java.io.IOException;

class HttpClientManager {
    void getEntity() throws IOException {
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpGet httpGet = new HttpGet("https://example.com");
        HttpResponse response = httpClient.execute(httpGet);
        HttpEntity entity = response.getEntity();
    }
}
After
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;

import java.io.IOException;

class HttpClientManager {
    void getEntity() throws IOException {
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpGet httpGet = new HttpGet("https://example.com");
        ClassicHttpResponse response = httpClient.execute(httpGet);
        HttpEntity entity = response.getEntity();
    }
}
java
Before
import javax.net.ssl.SSLContext;

import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.ssl.SSLContexts;

class HttpClientManager {
    void create() {
        SSLContext sslContext = SSLContexts.createDefault();
        SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext);
        HttpClients.custom().setSSLSocketFactory(sslConnectionSocketFactory).build();
    }
}
After
import javax.net.ssl.SSLContext;

import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.client5.http.io.HttpClientConnectionManager;
import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy;
import org.apache.hc.client5.http.ssl.TlsSocketStrategy;
import org.apache.hc.core5.ssl.SSLContexts;

class HttpClientManager {
    void create() {
        SSLContext sslContext = SSLContexts.createDefault();
        TlsSocketStrategy tlsSocketStrategy = new DefaultClientTlsStrategy(sslContext);
        HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create().setTlsSocketStrategy(tlsSocketStrategy).build();
        HttpClients.custom().setConnectionManager(cm).build();
    }
}
java
Before
import org.apache.http.client.methods.HttpGet;
import org.apache.http.ProtocolVersion;

class A {
    void method() {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        System.out.println("httpGet.getRequestLine() :: " + httpGet.getRequestLine());
        String method = httpGet.getRequestLine().getMethod();
        String uri = httpGet.getRequestLine().getUri();
        ProtocolVersion version = httpGet.getRequestLine().getProtocolVersion();
    }
}
After
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.core5.http.message.RequestLine;
import org.apache.hc.core5.http.ProtocolVersion;

class A {
    void method() {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        System.out.println("httpGet.getRequestLine() :: " + new RequestLine(httpGet));
        String method = new RequestLine(httpGet).getMethod();
        String uri = new RequestLine(httpGet).getUri();
        ProtocolVersion version = new RequestLine(httpGet).getProtocolVersion();
    }
}
java
Before
import org.apache.http.HttpStatus;
import org.apache.http.ProtocolVersion;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

import java.io.IOException;

class A {
    void method() throws IOException {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        CloseableHttpClient instance = HttpClientBuilder.create().build();
        CloseableHttpResponse response = instance.execute(httpGet);

        System.out.println("response.getStatusLine() :: " + response.getStatusLine());
        int statusCode = response.getStatusLine().getStatusCode();
        String reason = response.getStatusLine().getReasonPhrase();
        ProtocolVersion version = response.getStatusLine().getProtocolVersion();
    }
}
After
import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
import org.apache.hc.core5.http.message.StatusLine;
import org.apache.hc.core5.http.HttpStatus;
import org.apache.hc.core5.http.ProtocolVersion;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;

import java.io.IOException;

class A {
    void method() throws IOException {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        CloseableHttpClient instance = HttpClientBuilder.create().build();
        CloseableHttpResponse response = instance.execute(httpGet);

        System.out.println("response.getStatusLine() :: " + new StatusLine(response));
        int statusCode = response.getCode();
        String reason = response.getReasonPhrase();
        ProtocolVersion version = response.getVersion();
    }
}
java
Before
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MinimalField;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.util.EntityUtils;

class A {
    void method(HttpEntity entity, String urlStr) throws Exception {
        HttpUriRequest getRequest = new HttpGet(urlStr);
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
        StringBody body = new StringBody("stringbody", ContentType.TEXT_PLAIN);
        MinimalField field = new MinimalField("A", "B");
        EntityUtils.consume(entity);
    }
}
After
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.HttpUriRequest;
import org.apache.hc.client5.http.entity.mime.MimeField;
import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
import org.apache.hc.client5.http.entity.mime.StringBody;

class A {
    void method(HttpEntity entity, String urlStr) throws Exception {
        HttpUriRequest getRequest = new HttpGet(urlStr);
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
        StringBody body = new StringBody("stringbody", ContentType.TEXT_PLAIN);
        MimeField field = new MimeField("A", "B");
        EntityUtils.consume(entity);
    }
}
java
Before
import org.apache.http.client.config.CookieSpecs;

class A {
    void method() {
        String c1 = CookieSpecs.IGNORE_COOKIES;
        String c2 = CookieSpecs.STANDARD;
        String c3 = CookieSpecs.STANDARD_STRICT;
    }
}
After
import org.apache.hc.client5.http.cookie.StandardCookieSpec;

class A {
    void method() {
        String c1 = StandardCookieSpec.IGNORE;
        String c2 = StandardCookieSpec.RELAXED;
        String c3 = StandardCookieSpec.STRICT;
    }
}
java
Before
import org.apache.http.auth.AuthScope;

class A {
    void method() {
        AuthScope any = AuthScope.ANY;
    }
}
After
import org.apache.hc.client5.http.auth.AuthScope;

class A {
    void method() {
        AuthScope any = new AuthScope(null, -1);
    }
}
java
Before
import org.apache.http.auth.AuthScheme;
import org.apache.http.auth.AuthState;
import org.apache.http.auth.AuthProtocolState;

class A {
    void m(AuthState s, AuthScheme scheme) {
        s.setAuthScheme(scheme);
        s.setState(AuthProtocolState.CHALLENGED);
        s.reset();
    }
}
After
import org.apache.hc.client5.http.auth.AuthExchange.State;
import org.apache.hc.client5.http.auth.AuthScheme;
import org.apache.hc.client5.http.auth.AuthExchange;

class A {
    void m(AuthExchange s, AuthScheme scheme) {
        s.select(scheme);
        s.setState(AuthExchange.State.CHALLENGED);
        s.reset();
    }
}
java
Before
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;

import java.io.IOException;

class HttpClientManager {
    void getEntity() throws IOException {
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpGet httpGet = new HttpGet("https://example.com");
        HttpResponse response = httpClient.execute(httpGet);
        HttpEntity entity = response.getEntity();
    }
}
After
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;

import java.io.IOException;

class HttpClientManager {
    void getEntity() throws IOException {
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpGet httpGet = new HttpGet("https://example.com");
        ClassicHttpResponse response = httpClient.execute(httpGet);
        HttpEntity entity = response.getEntity();
    }
}
java
Before
import javax.net.ssl.SSLContext;

import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.ssl.SSLContexts;

class HttpClientManager {
    void create() {
        SSLContext sslContext = SSLContexts.createDefault();
        SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext);
        HttpClients.custom().setSSLSocketFactory(sslConnectionSocketFactory).build();
    }
}
After
import javax.net.ssl.SSLContext;

import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.client5.http.io.HttpClientConnectionManager;
import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy;
import org.apache.hc.client5.http.ssl.TlsSocketStrategy;
import org.apache.hc.core5.ssl.SSLContexts;

class HttpClientManager {
    void create() {
        SSLContext sslContext = SSLContexts.createDefault();
        TlsSocketStrategy tlsSocketStrategy = new DefaultClientTlsStrategy(sslContext);
        HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create().setTlsSocketStrategy(tlsSocketStrategy).build();
        HttpClients.custom().setConnectionManager(cm).build();
    }
}
java
Before
import org.apache.http.client.methods.HttpGet;
import org.apache.http.ProtocolVersion;

class A {
    void method() {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        System.out.println("httpGet.getRequestLine() :: " + httpGet.getRequestLine());
        String method = httpGet.getRequestLine().getMethod();
        String uri = httpGet.getRequestLine().getUri();
        ProtocolVersion version = httpGet.getRequestLine().getProtocolVersion();
    }
}
After
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.core5.http.message.RequestLine;
import org.apache.hc.core5.http.ProtocolVersion;

class A {
    void method() {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        System.out.println("httpGet.getRequestLine() :: " + new RequestLine(httpGet));
        String method = new RequestLine(httpGet).getMethod();
        String uri = new RequestLine(httpGet).getUri();
        ProtocolVersion version = new RequestLine(httpGet).getProtocolVersion();
    }
}
java
Before
import org.apache.http.HttpStatus;
import org.apache.http.ProtocolVersion;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

import java.io.IOException;

class A {
    void method() throws IOException {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        CloseableHttpClient instance = HttpClientBuilder.create().build();
        CloseableHttpResponse response = instance.execute(httpGet);

        System.out.println("response.getStatusLine() :: " + response.getStatusLine());
        int statusCode = response.getStatusLine().getStatusCode();
        String reason = response.getStatusLine().getReasonPhrase();
        ProtocolVersion version = response.getStatusLine().getProtocolVersion();
    }
}
After
import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
import org.apache.hc.core5.http.message.StatusLine;
import org.apache.hc.core5.http.HttpStatus;
import org.apache.hc.core5.http.ProtocolVersion;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;

import java.io.IOException;

class A {
    void method() throws IOException {
        HttpGet httpGet = new HttpGet("https://moderne.io");
        CloseableHttpClient instance = HttpClientBuilder.create().build();
        CloseableHttpResponse response = instance.execute(httpGet);

        System.out.println("response.getStatusLine() :: " + new StatusLine(response));
        int statusCode = response.getCode();
        String reason = response.getReasonPhrase();
        ProtocolVersion version = response.getVersion();
    }
}
java
Before
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MinimalField;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.util.EntityUtils;

class A {
    void method(HttpEntity entity, String urlStr) throws Exception {
        HttpUriRequest getRequest = new HttpGet(urlStr);
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
        StringBody body = new StringBody("stringbody", ContentType.TEXT_PLAIN);
        MinimalField field = new MinimalField("A", "B");
        EntityUtils.consume(entity);
    }
}
After
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.HttpUriRequest;
import org.apache.hc.client5.http.entity.mime.MimeField;
import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
import org.apache.hc.client5.http.entity.mime.StringBody;

class A {
    void method(HttpEntity entity, String urlStr) throws Exception {
        HttpUriRequest getRequest = new HttpGet(urlStr);
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
        StringBody body = new StringBody("stringbody", ContentType.TEXT_PLAIN);
        MimeField field = new MimeField("A", "B");
        EntityUtils.consume(entity);
    }
}

Usage​

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe UpgradeApacheHttpClient_5

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

mod config recipes jar install org.openrewrite.recipe:rewrite-apache:RELEASE

Data tables​

Maven metadata failures
org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Export after a run
mod study . --last-recipe-run \
  --data-table org.openrewrite.maven.table.MavenMetadataFailures
ColumnDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.
Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Export after a run
mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileResults
ColumnDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Export after a run
mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SearchResults
ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Export after a run
mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileErrors
ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Export after a run
mod study . --last-recipe-run \
  --data-table org.openrewrite.table.RecipeRunStats
ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.