com.amazonaws.services.dynamodbv2.nio.http

Class AmazonHttpClient

java.lang.Object

com.amazonaws.services.dynamodbv2.nio.http.AmazonHttpClient

@ThreadSafe
public class AmazonHttpClient
extends Object

Created by amiroshn

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmazonHttpClient.ExecOneRequestParams Stateful parameters that are used for executing a single httpClientSettings request.

Field Summary

Fields

Modifier and Type	Field and Description
private com.amazonaws.ClientConfiguration	config Client configuration options, such as proxy httpClientSettings, max retries, etc.
static String	HEADER_SDK_TRANSACTION_ID
static String	HEADER_USER_AGENT
private ConnectionManagerAwareHttpClient	httpClient Internal client for sending HTTP requests
private static com.amazonaws.http.client.HttpClientFactory<SdkHttpClient>	httpClientFactory
private com.amazonaws.http.settings.HttpClientSettings	httpClientSettings Client configuration options, such as proxy httpClientSettings, max retries, etc.
private com.amazonaws.http.request.HttpRequestFactory<org.apache.http.client.methods.HttpRequestBase>	httpRequestFactory
(package private) static org.apache.commons.logging.Log	log Logger for more detailed debugging information, that might not be as useful for end users (ex: HTTP client configuration, etc).
private static org.apache.commons.logging.Log	requestLog Logger providing detailed information on requests/responses.
private com.amazonaws.metrics.RequestMetricCollector	requestMetricCollector A request metric collector used specifically for this httpClientSettings client; or null if there is none.
private com.amazonaws.util.ResponseMetadataCache	responseMetadataCache Cache of metadata for recently executed requests for diagnostic purposes
private int	timeOffset The time difference in seconds between this client and AWS.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AmazonHttpClient(com.amazonaws.ClientConfiguration config) Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc).
	AmazonHttpClient(com.amazonaws.ClientConfiguration config, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc), and request metric collector.
	AmazonHttpClient(com.amazonaws.ClientConfiguration config, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector, boolean useBrowserCompatibleHostNameVerifier) Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc), and request metric collector.
private	AmazonHttpClient(com.amazonaws.ClientConfiguration clientConfig, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector, com.amazonaws.http.settings.HttpClientSettings httpClientSettings)

Method Summary

Modifier and Type	Method and Description
private void	checkInterrupted() Check if the thread has been interrupted.
private void	checkInterrupted(com.amazonaws.Response<?> response) Check if the thread has been interrupted.
private static String	createUserAgentString(String existingUserAgentString, String userAgent) Appends the given user-agent string to the existing one and returns it.
private <T> Future<T>	doExecute(com.amazonaws.Request<?> request, com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler, ExecutionContext executionContext, ResultHandler<T> asyncHandler)
<T> Future<T>	execute(com.amazonaws.Request<?> request, com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler, ExecutionContext executionContext, ResultHandler<T> asyncHandler) Executes the request and returns the result.
private <T> Future<T>	executeHelper(com.amazonaws.Request<?> request, com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler, ExecutionContext executionContext, List<com.amazonaws.handlers.RequestHandler2> requestHandlers, ResultHandler<T> asyncHandler) Internal method to execute the HTTP method given.
private <T> Future<T>	executeOneRequest(com.amazonaws.Request<?> request, com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler, ExecutionContext execContext, AmazonHttpClient.ExecOneRequestParams execOneParams, List<com.amazonaws.handlers.RequestHandler2> requestHandlers, ResultHandler<T> asyncHandler) Returns the response from executing one httpClientSettings request; or null for retry.
protected void	finalize()
private com.amazonaws.auth.AWSCredentials	getCredentialsFromContext(ExecutionContext executionContext) Returns the credentials from the execution if exists.
private <T> com.amazonaws.http.HttpResponseHandler<T>	getNonNullResponseHandler(com.amazonaws.http.HttpResponseHandler<T> responseHandler) Ensures the response handler is not null.
com.amazonaws.metrics.RequestMetricCollector	getRequestMetricCollector() Returns the httpClientSettings client specific request metric collector; or null if there is none.
com.amazonaws.ResponseMetadata	getResponseMetadataForRequest(com.amazonaws.AmazonWebServiceRequest request) Returns additional response metadata for an executed request.
private RuntimeException	handleInterruptedException(ExecutionContext executionContext, InterruptedException e) Determine if an interrupted exception is caused by the client execution timer interrupting the current thread or some other task interrupting the thread for another purpose.
private void	mergeQueryParameters(com.amazonaws.Request<?> request, Map<String,List<String>> params) Merge query parameters into the given request.
private List<com.amazonaws.handlers.RequestHandler2>	requestHandler2s(com.amazonaws.Request<?> request, ExecutionContext executionContext)
private void	setSdkTransactionId(com.amazonaws.Request<?> request) Create a client side identifier that will be sent with the initial request and each retry.
private void	setUserAgent(com.amazonaws.Request<?> request) Sets a User-Agent for the specified request, taking into account any custom data.
void	shutdown() Shuts down this HTTP client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

clone, 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

log

static final org.apache.commons.logging.Log log

Logger for more detailed debugging information, that might not be as useful for end users (ex: HTTP client configuration, etc).

requestLog

private static final org.apache.commons.logging.Log requestLog

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.

httpClientFactory

private static final com.amazonaws.http.client.HttpClientFactory<SdkHttpClient> httpClientFactory

httpRequestFactory

private final com.amazonaws.http.request.HttpRequestFactory<org.apache.http.client.methods.HttpRequestBase> httpRequestFactory

httpClient

private ConnectionManagerAwareHttpClient httpClient

Internal client for sending HTTP requests

config

private final com.amazonaws.ClientConfiguration config

Client configuration options, such as proxy httpClientSettings, max retries, etc.

httpClientSettings

private final com.amazonaws.http.settings.HttpClientSettings httpClientSettings

Client configuration options, such as proxy httpClientSettings, max retries, etc.

responseMetadataCache

private final com.amazonaws.util.ResponseMetadataCache responseMetadataCache

Cache of metadata for recently executed requests for diagnostic purposes

requestMetricCollector

private final com.amazonaws.metrics.RequestMetricCollector requestMetricCollector

A request metric collector used specifically for this httpClientSettings client; or null if there is none. This collector, if specified, always takes precedence over the one specified at the AWS SDK level.

See Also:

AwsSdkMetrics

timeOffset

private volatile int timeOffset

The time difference in seconds between this client and AWS.

Constructor Detail

AmazonHttpClient

public AmazonHttpClient(com.amazonaws.ClientConfiguration config)

Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc).

Parameters:

config - Configuration options specifying how this client will communicate with AWS (ex: proxy httpClientSettings, retry count, etc.).

AmazonHttpClient

public AmazonHttpClient(com.amazonaws.ClientConfiguration config,
                        com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc), and request metric collector.

Parameters:

config - Configuration options specifying how this client will communicate with AWS (ex: proxy httpClientSettings, retry count, etc.).

requestMetricCollector - client specific request metric collector, which takes precedence over the one at the AWS SDK level; or null if there is none.

AmazonHttpClient

public AmazonHttpClient(com.amazonaws.ClientConfiguration config,
                        com.amazonaws.metrics.RequestMetricCollector requestMetricCollector,
                        boolean useBrowserCompatibleHostNameVerifier)

Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc), and request metric collector.

Parameters:

config - Configuration options specifying how this client will communicate with AWS (ex: proxy httpClientSettings, retry count, etc.).

requestMetricCollector - client specific request metric collector, which takes precedence over the one at the AWS SDK level; or null if there is none.

AmazonHttpClient

private AmazonHttpClient(com.amazonaws.ClientConfiguration clientConfig,
                         com.amazonaws.metrics.RequestMetricCollector requestMetricCollector,
                         com.amazonaws.http.settings.HttpClientSettings httpClientSettings)

Method Detail

createUserAgentString

private static String createUserAgentString(String existingUserAgentString,
                                            String userAgent)

Appends the given user-agent string to the existing one and returns it.

getResponseMetadataForRequest

public com.amazonaws.ResponseMetadata getResponseMetadataForRequest(com.amazonaws.AmazonWebServiceRequest request)

Returns additional response metadata for an executed request. Response metadata isn't considered part of the standard results returned by an operation, so it's accessed instead through this diagnostic interface. Response metadata is typically used for troubleshooting issues with AWS support staff when services aren't acting as expected.

Parameters:

request - A previously executed AmazonWebServiceRequest object, whose response metadata is desired.

Returns:

The response metadata for the specified request, otherwise null if there is no response metadata available for the request.

execute

public <T> Future<T> execute(com.amazonaws.Request<?> request,
                             com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler,
                             ExecutionContext executionContext,
                             ResultHandler<T> asyncHandler)

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

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

asyncHandler - Handler

getNonNullResponseHandler

private <T> com.amazonaws.http.HttpResponseHandler<T> getNonNullResponseHandler(com.amazonaws.http.HttpResponseHandler<T> responseHandler)

Ensures the response handler is not null. If it is this method returns a dummy response handler.

Parameters:

responseHandler - Response handler passed to execute(com.amazonaws.Request, com.amazonaws.http.HttpResponseHandler, com.amazonaws.services.dynamodbv2.nio.http.ExecutionContext, com.amazonaws.services.dynamodbv2.nio.handlers.ResultHandler)

Returns:

Either original response handler or dummy response handler.

doExecute

private <T> Future<T> doExecute(com.amazonaws.Request<?> request,
                                com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler,
                                ExecutionContext executionContext,
                                ResultHandler<T> asyncHandler)
                         throws InterruptedException

Throws:

InterruptedException

handleInterruptedException

private RuntimeException handleInterruptedException(ExecutionContext executionContext,
                                                    InterruptedException e)

Determine if an interrupted exception is caused by the client execution timer interrupting the current thread or some other task interrupting the thread for another purpose.

Parameters:

executionContext -

e -

Returns:

ClientExecutionTimeoutException if the InterruptedException was caused by the ClientExecutionTimer. Otherwise re-interrupts the current thread and returns an AmazonClientException wrapping an InterruptedException

checkInterrupted

private 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

private void checkInterrupted(com.amazonaws.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

mergeQueryParameters

private void mergeQueryParameters(com.amazonaws.Request<?> request,
                                  Map<String,List<String>> params)

Merge query parameters into the given request.

requestHandler2s

private List<com.amazonaws.handlers.RequestHandler2> requestHandler2s(com.amazonaws.Request<?> request,
                                                                      ExecutionContext executionContext)

executeHelper

private <T> Future<T> executeHelper(com.amazonaws.Request<?> request,
                                    com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler,
                                    ExecutionContext executionContext,
                                    List<com.amazonaws.handlers.RequestHandler2> requestHandlers,
                                    ResultHandler<T> asyncHandler)
                             throws InterruptedException

Internal method to execute the HTTP method given.

Throws:

InterruptedException

getCredentialsFromContext

private com.amazonaws.auth.AWSCredentials getCredentialsFromContext(ExecutionContext executionContext)

Returns the credentials from the execution if exists. Else returns null.

executeOneRequest

private <T> Future<T> executeOneRequest(com.amazonaws.Request<?> request,
                                        com.amazonaws.http.HttpResponseHandler<com.amazonaws.AmazonWebServiceResponse<T>> responseHandler,
                                        ExecutionContext execContext,
                                        AmazonHttpClient.ExecOneRequestParams execOneParams,
                                        List<com.amazonaws.handlers.RequestHandler2> requestHandlers,
                                        ResultHandler<T> asyncHandler)
                                 throws IOException,
                                        InterruptedException

Returns the response from executing one httpClientSettings request; or null for retry.

Throws:

IOException

InterruptedException

setSdkTransactionId

private void setSdkTransactionId(com.amazonaws.Request<?> request)

Create a client side identifier that will be sent with the initial request and each retry.

setUserAgent

private void setUserAgent(com.amazonaws.Request<?> request)

Sets a User-Agent for the specified request, taking into account any custom data.

shutdown

public void shutdown()

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.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getRequestMetricCollector

public com.amazonaws.metrics.RequestMetricCollector getRequestMetricCollector()

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