From 61552956564db93017ad9a83c3577c3d252cabba Mon Sep 17 00:00:00 2001 From: John Viegas Date: Fri, 25 Jul 2025 08:02:05 -0700 Subject: [PATCH 1/2] Update Java docs for Apache Clients --- .../awssdk/http/apache/ApacheHttpClient.java | 8 ++++--- .../http/apache5/Apache5HttpClient.java | 23 +++++++++++++++---- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/ApacheHttpClient.java b/http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/ApacheHttpClient.java index 04976de94ef7..6013c07bdaa8 100644 --- a/http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/ApacheHttpClient.java +++ b/http-clients/apache-client/src/main/java/software/amazon/awssdk/http/apache/ApacheHttpClient.java @@ -92,9 +92,11 @@ import software.amazon.awssdk.utils.Validate; /** - * An implementation of {@link SdkHttpClient} that uses Apache HTTP client to communicate with the service. This is the most - * powerful synchronous client that adds an extra dependency and additional startup latency in exchange for more functionality, - * like support for HTTP proxies. + * + * An implementation of {@link SdkHttpClient} that uses Apache HttpClient 4.x to communicate with the service. This is a + * full-featured synchronous client that adds an extra dependency and higher startup latency compared to + * UrlConnectionHttpClient + * in exchange for more functionality, like support for HTTP proxies. * *

See software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient for an alternative implementation.

* diff --git a/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java b/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java index 135b76e05a0d..a479f02f55d1 100644 --- a/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java +++ b/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java @@ -101,14 +101,29 @@ import software.amazon.awssdk.utils.Validate; /** - * An implementation of {@link SdkHttpClient} that uses Apache5 HTTP client to communicate with the service. This is the most - * powerful synchronous client that adds an extra dependency and additional startup latency in exchange for more functionality, - * like support for HTTP proxies. + * An implementation of {@link SdkHttpClient} that uses Apache HttpClient 5.x to communicate with the service. This is a + * full-featured synchronous client that adds an extra dependency and higher startup latency compared to + * UrlConnectionHttpClient + * in exchange for more functionality, like support for HTTP proxies. * - *

See software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient for an alternative implementation.

+ *

Note: The higher startup latency is compared to UrlConnectionHttpClient, not to the Apache HttpClient 4.5.x + * based client. Performance characteristics between Apache 4.5.x and 5.x clients are similar.

+ * + *

This client uses Apache HttpClient 5.x, which provides the following + * improvements over the Apache HttpClient 4.5.x based client:

+ * + * + *

See + * UrlConnectionHttpClient + * for a lighter-weight alternative implementation.

* *

This can be created via {@link #builder()}

*/ + @SdkPreviewApi @SdkPublicApi public final class Apache5HttpClient implements SdkHttpClient { From 2837f73974ab9289a260c47aef2f4a7525f20a1f Mon Sep 17 00:00:00 2001 From: John Viegas Date: Fri, 25 Jul 2025 14:12:14 -0700 Subject: [PATCH 2/2] handled PR comments --- .../amazon/awssdk/http/apache5/Apache5HttpClient.java | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java b/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java index a479f02f55d1..d39522574561 100644 --- a/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java +++ b/http-clients/apache5-client/src/main/java/software/amazon/awssdk/http/apache5/Apache5HttpClient.java @@ -106,9 +106,6 @@ * UrlConnectionHttpClient * in exchange for more functionality, like support for HTTP proxies. * - *

Note: The higher startup latency is compared to UrlConnectionHttpClient, not to the Apache HttpClient 4.5.x - * based client. Performance characteristics between Apache 4.5.x and 5.x clients are similar.

- * *

This client uses Apache HttpClient 5.x, which provides the following * improvements over the Apache HttpClient 4.5.x based client:

* - * + *

Note: Performance characteristics between Apache 4.5.x and 5.x clients are similar.

*

See * UrlConnectionHttpClient * for a lighter-weight alternative implementation.