@ThreadSafe
public class AmazonHttpClient
extends Object 

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and 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 and Description
  static String	HEADER_SDK_RETRY_INFO
  static String	HEADER_SDK_TRANSACTION_ID
  static String	HEADER_USER_AGENT
  static org.apache.commons.logging.Log	requestLog Logger providing detailed information on requests/responses.

• Constructor Summary

  Constructors

  Constructor and Description
  AmazonHttpClient (ClientConfiguration config) Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc).
  AmazonHttpClient (ClientConfiguration clientConfig, ConnectionManagerAwareHttpClient httpClient, RequestMetricCollector requestMetricCollector, TokenBucket tokenBucket) Package-protected constructor for unit test purposes.
  AmazonHttpClient (ClientConfiguration config, 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 (ClientConfiguration config, 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.
  AmazonHttpClient (ClientConfiguration config, RequestMetricCollector requestMetricCollector, boolean useBrowserCompatibleHostNameVerifier, boolean calculateCRC32FromCompressedData) Constructs a new AWS client using the specified client configuration options (ex: max retry attempts, proxy httpClientSettings, etc), and request metric collector.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  static AmazonHttpClient.Builder	builder ()
  <T> Response<T>	execute (Request<?> request, HttpResponseHandler<AmazonWebServiceResponse<T>> responseHandler, HttpResponseHandler<AmazonServiceException> errorResponseHandler, ExecutionContext executionContext) Deprecated. Use requestExecutionBuilder() to configure and execute a HTTP request.
  <T> Response<T>	execute (Request<?> request, HttpResponseHandler<AmazonWebServiceResponse<T>> responseHandler, HttpResponseHandler<AmazonServiceException> errorResponseHandler, ExecutionContext executionContext, RequestConfig requestConfig)
  ClientExecutionTimer	getClientExecutionTimer () Package protected for unit-testing
  HttpRequestTimer	getHttpRequestTimer () Package protected for unit-testing
  RequestMetricCollector	getRequestMetricCollector () Returns the httpClientSettings client specific request metric collector; or null if there is none.
  ResponseMetadata	getResponseMetadataForRequest (AmazonWebServiceRequest request) Returns additional response metadata for an executed request.
  int	getTimeOffset () Returns the time difference in seconds between this client and AWS.
  AmazonHttpClient.RequestExecutionBuilder	requestExecutionBuilder ()
  void	shutdown () Shuts down this HTTP client object, releasing any resources that might be held open.

  • 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

  • HEADER_SDK_RETRY_INFO

    public static final String HEADER_SDK_RETRY_INFO

    See Also:

    Constant Field Values

  • requestLog

    public 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.

• Constructor Detail

  • AmazonHttpClient

    public AmazonHttpClient(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(ClientConfiguration config,
     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(ClientConfiguration config,
     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

    public AmazonHttpClient(ClientConfiguration config,
     RequestMetricCollector requestMetricCollector,
     boolean useBrowserCompatibleHostNameVerifier,
     boolean calculateCRC32FromCompressedData)

    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.

    calculateCRC32FromCompressedData - The flag indicating whether the CRC32 checksum is calculated from compressed data or not. It is only applicable when the header "x-amz-crc32" is set in the response.

  • AmazonHttpClient

    public AmazonHttpClient(ClientConfiguration clientConfig,
     ConnectionManagerAwareHttpClient httpClient,
     RequestMetricCollector requestMetricCollector,
     TokenBucket tokenBucket)

    Package-protected constructor for unit test purposes.

• Method Detail

  • builder

    public static AmazonHttpClient.Builder builder()

  • 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.

  • getHttpRequestTimer

    public HttpRequestTimer getHttpRequestTimer()

    Package protected for unit-testing

  • getClientExecutionTimer

    public ClientExecutionTimer getClientExecutionTimer()

    Package protected for unit-testing

  • getResponseMetadataForRequest

    public ResponseMetadata getResponseMetadataForRequest(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.

  • getRequestMetricCollector

    public RequestMetricCollector getRequestMetricCollector()

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

  • getTimeOffset

    public int getTimeOffset()

    Returns the time difference in seconds between this client and AWS.

  • execute

    @Deprecated
    public <T> Response<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

  • execute

    public <T> Response<T> execute(Request<?> request,
     HttpResponseHandler<AmazonWebServiceResponse<T>> responseHandler,
     HttpResponseHandler<AmazonServiceException> errorResponseHandler,
     ExecutionContext executionContext,
     RequestConfig requestConfig)

  • requestExecutionBuilder

    public AmazonHttpClient.RequestExecutionBuilder requestExecutionBuilder()

    Returns:

    A builder used to configure and execute a HTTP request.