Package software.amazon.awssdk.http

Class AmazonHttpClient

java.lang.Object

software.amazon.awssdk.http.AmazonHttpClient

All Implemented Interfaces:

AutoCloseable

@ThreadSafe
public class AmazonHttpClient
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AmazonHttpClient.Builder
static interface	AmazonHttpClient.RequestExecutionBuilder	Interface to configure a request execution and execute the request.

Field Summary

Fields

Modifier and Type	Field	Description
static String	HEADER_SDK_TRANSACTION_ID
static String	HEADER_USER_AGENT
static org.apache.commons.logging.Log	REQUEST_LOG	Logger providing detailed information on requests/responses.
static int	THROTTLED_RETRY_COST	When throttled retries are enabled, each retry attempt will consume this much capacity.

Method Summary

Modifier and Type	Method	Description
static AmazonHttpClient.Builder	builder()
static void	checkInterrupted()	Check if the thread has been interrupted.
static void	checkInterrupted(Response<?> response)	Check if the thread has been interrupted.
void	close()	Shuts down this HTTP client object, releasing any resources that might be held open.
<T> T	execute(Request<?> request, HttpResponseHandler<AmazonWebServiceResponse<T>> responseHandler, HttpResponseHandler<AmazonServiceException> errorResponseHandler, ExecutionContext executionContext)	Deprecated. Use requestExecutionBuilder() to configure and execute a HTTP request.
ClientExecutionTimer	getClientExecutionTimer()	Package protected for unit-testing.
RequestMetricCollector	getRequestMetricCollector()	Returns the httpClientSettings client specific request metric collector; or null if there is none.
AmazonHttpClient.RequestExecutionBuilder	requestExecutionBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_USER_AGENT

public static final String HEADER_USER_AGENT

See Also:

Constant Field Values

HEADER_SDK_TRANSACTION_ID

public static final String HEADER_SDK_TRANSACTION_ID

See Also:

Constant Field Values

REQUEST_LOG

public static final org.apache.commons.logging.Log REQUEST_LOG

Logger providing detailed information on requests/responses. Users can enable this logger to get access to AWS request IDs for responses, individual requests and parameters sent to AWS, etc.

THROTTLED_RETRY_COST

public static final int THROTTLED_RETRY_COST

When throttled retries are enabled, each retry attempt will consume this much capacity. Successful retry attempts will release this capacity back to the pool while failed retries will not. Successful initial (non-retry) requests will always release 1 capacity unit to the pool.

See Also:

Constant Field Values

Method Detail

builder

public static AmazonHttpClient.Builder builder()

close

public void close()
           throws Exception

Shuts down this HTTP client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it cannot be used to make more requests.

Specified by:

close in interface AutoCloseable

Throws:

Exception

getClientExecutionTimer

public ClientExecutionTimer getClientExecutionTimer()

Package protected for unit-testing.

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

Returns the httpClientSettings client specific request metric collector; or null if there is none.

checkInterrupted

public static void checkInterrupted()
                             throws InterruptedException

Check if the thread has been interrupted. If so throw an InterruptedException. Long running tasks should be periodically checked if the current thread has been interrupted and handle it appropriately

Throws:

InterruptedException - If thread has been interrupted

checkInterrupted

public static void checkInterrupted(Response<?> response)
                             throws InterruptedException

Check if the thread has been interrupted. If so throw an InterruptedException. Long running tasks should be periodically checked if the current thread has been interrupted and handle it appropriately

Parameters:

response - Response to be closed before returning control to the caller to avoid leaking the connection.

Throws:

InterruptedException - If thread has been interrupted

execute

@Deprecated
public <T> T execute(Request<?> request,
                     HttpResponseHandler<AmazonWebServiceResponse<T>> responseHandler,
                     HttpResponseHandler<AmazonServiceException> errorResponseHandler,
                     ExecutionContext executionContext)

Deprecated. Use requestExecutionBuilder() to configure and execute a HTTP request.

Executes the request and returns the result.

Parameters:

request - The AmazonWebServices request to send to the remote server

responseHandler - A response handler to accept a successful response from the remote server

errorResponseHandler - A response handler to accept an unsuccessful response from the remote server

executionContext - Additional information about the context of this web service call

requestExecutionBuilder

public AmazonHttpClient.RequestExecutionBuilder requestExecutionBuilder()

Returns:

A builder used to configure and execute a HTTP request.