Class Apache5HttpClient

java.lang.Object

software.amazon.awssdk.http.apache5.Apache5HttpClient

All Implemented Interfaces:

AutoCloseable, SdkHttpClient, SdkAutoCloseable

@SdkPublicApi
public final class Apache5HttpClient
extends Object
implements SdkHttpClient

An implementation of 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.

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

• Modern Java ecosystem compatibility including virtual thread support for Java 21
• Active maintenance with regular security updates
• Enhanced logging flexibility through SLF4J (replacing problematic JCL dependencies)

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

See UrlConnectionHttpClient for a lighter-weight alternative implementation.

This can be created via builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Apache5HttpClient.Builder	Builder for creating an instance of SdkHttpClient.

Method Summary

Modifier and Type	Method	Description
static Apache5HttpClient.Builder	builder()
String	clientName()	Each HTTP client implementation should return a well-formed client name that allows requests to be identifiable back to the client that made the request.
void	close()
static SdkHttpClient	create()	Create a Apache5HttpClient with the default properties
ExecutableHttpRequest	prepareRequest(HttpExecuteRequest request)	Create a ExecutableHttpRequest that can be used to execute the HTTP request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static Apache5HttpClient.Builder builder()

create

public static SdkHttpClient create()

Create a Apache5HttpClient with the default properties

Returns:

an Apache5HttpClient

prepareRequest

public ExecutableHttpRequest prepareRequest(HttpExecuteRequest request)

Description copied from interface: SdkHttpClient

Create a ExecutableHttpRequest that can be used to execute the HTTP request.

Specified by:

prepareRequest in interface SdkHttpClient

Parameters:

request - Representation of an HTTP request.

Returns:

Task that can execute an HTTP request and can be aborted.

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

clientName

public String clientName()

Description copied from interface: SdkHttpClient

Each HTTP client implementation should return a well-formed client name that allows requests to be identifiable back to the client that made the request. The client name should include the backing implementation as well as the Sync or Async to identify the transmission type of the request. Client names should only include alphanumeric characters. Examples of well formed client names include, ApacheSync, for requests using Apache's synchronous http client or NettyNioAsync for Netty's asynchronous http client.

Specified by:

clientName in interface SdkHttpClient

Returns:

String containing the name of the client