software.amazon.awssdk.http.apache

Class ApacheHttpClient

java.lang.Object

software.amazon.awssdk.http.apache.ApacheHttpClient

All Implemented Interfaces:

AutoCloseable, ConfigurationProvider, SdkHttpClient, SdkAutoCloseable

public final class ApacheHttpClient
extends Object
implements SdkHttpClient

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

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

This can be created via builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApacheHttpClient.Builder	builder()
void	close()
<T> Optional<T>	getConfigurationValue(SdkHttpConfigurationOption<T> key) Retrieve the current value of the configuration option, if present.
AbortableCallable<SdkHttpFullResponse>	prepareRequest(SdkHttpFullRequest request, SdkRequestContext context) Create a AbortableCallable 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 Detail

builder

public static ApacheHttpClient.Builder builder()

prepareRequest

public AbortableCallable<SdkHttpFullResponse> prepareRequest(SdkHttpFullRequest request,
                                                             SdkRequestContext context)

Description copied from interface: SdkHttpClient

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

Specified by:

prepareRequest in interface SdkHttpClient

Parameters:

request - Representation of an HTTP request.

context - Contains any extra dependencies needed.

Returns:

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

getConfigurationValue

public <T> Optional<T> getConfigurationValue(SdkHttpConfigurationOption<T> key)

Description copied from interface: ConfigurationProvider

Retrieve the current value of the configuration option, if present.

Specified by:

getConfigurationValue in interface ConfigurationProvider

Type Parameters:

T - Type of configuration value.

Parameters:

key - Key of configuration value to retrieve.

Returns:

Empty Optional if configuration option is not supported, otherwise a fulfilled Optional containing the current value.

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable