AmazonWebServiceClient (aws-android-sdk-core 2.80.0 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient

Direct Known Subclasses:

AmazonCognitoIdentityClient, AWSSecurityTokenServiceClient
```
public abstract class AmazonWebServiceClient
extends java.lang.Object
```
Abstract base class for Amazon Web Service Java clients.
Responsible for basic client capabilities that are the same across all AWS SDK Java clients (ex: setting the client endpoint).

Field Summary

Fields
Modifier and Type	Field and Description
`protected AmazonHttpClient`	`client` Low level client for sending requests to AWS services.
`protected ClientConfiguration`	`clientConfiguration` The client configuration.
`protected java.net.URI`	`endpoint` The service endpoint to which this client will send requests.
`protected java.lang.String`	`endpointPrefix`
`static boolean`	`LOGGING_AWS_REQUEST_METRIC` Boolean for logging AWS request metrics.
`protected java.util.List<RequestHandler2>`	`requestHandler2s` Optional request handlers for additional request processing.
`protected long`	`timeOffset` Optional offset (in seconds) to use when signing requests.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AmazonWebServiceClient(ClientConfiguration clientConfiguration)` Constructs a new AmazonWebServiceClient object using the specified configuration.
`protected`	`AmazonWebServiceClient(ClientConfiguration clientConfiguration, HttpClient httpClient)` Constructs a new AmazonWebServiceClient object using the specified configuration.
`protected`	`AmazonWebServiceClient(ClientConfiguration clientConfiguration, HttpClient httpClient, RequestMetricCollector requestMetricCollector)` Deprecated.
`protected`	`AmazonWebServiceClient(ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRequestHandler(RequestHandler requestHandler)` Deprecated. by `addRequestHandler(RequestHandler2)`. Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
`void`	`addRequestHandler(RequestHandler2 requestHandler2)` Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
`protected void`	`configSigner(java.lang.String serviceName, java.lang.String regionId)` Deprecated. this method is now a no-op, as overriding the signer from sublcass is no longer supported.
`protected void`	`configSigner(java.net.URI uri)` Deprecated. this method is now a no-op, as overriding the signer from sublcass is no longer supported.
`protected ExecutionContext`	`createExecutionContext()` Deprecated. by `createExecutionContext(AmazonWebServiceRequest)`. This method exists only for backward compatiblity reason, so that clients compiled against the older version of this class won't get `NoSuchMethodError` at runtime. However, calling this methods would effectively ignore and disable the request metric collector, if any, specified at the request level. Request metric collector specified at the service client or AWS SDK level will still be honored.
`protected ExecutionContext`	`createExecutionContext(AmazonWebServiceRequest req)`
`protected ExecutionContext`	`createExecutionContext(Request<?> req)`
`protected void`	`endClientExecution(AWSRequestMetrics awsRequestMetrics, Request<?> request, Response<?> response)` Deprecated. metrics is deprecated
`protected void`	`endClientExecution(AWSRequestMetrics awsRequestMetrics, Request<?> request, Response<?> response, boolean loggingAwsRequestMetrics)` Deprecated. metrics is deprecated
`protected RequestMetricCollector`	`findRequestMetricCollector(Request<?> req)` Deprecated. metrics is deprecated
`java.lang.String`	`getEndpoint()` Returns the endpoint for the service.
`java.lang.String`	`getEndpointPrefix()` Returns the endpoint prefix for the service.
`Regions`	`getRegions()` Returns the region that the client is set to operate in.
`RequestMetricCollector`	`getRequestMetricsCollector()` Deprecated. metrics is deprecated
`protected java.lang.String`	`getServiceAbbreviation()` Deprecated. by `getServiceName()`.
`java.lang.String`	`getServiceName()`
`protected java.lang.String`	`getServiceNameIntern()` Internal method for implementing `getServiceName()`.
`protected Signer`	`getSigner()` Returns the signer.
`Signer`	`getSignerByURI(java.net.URI uri)` Returns the signer based on the given URI and the current AWS client configuration.
`java.lang.String`	`getSignerRegionOverride()`
`long`	`getTimeOffset()` Returns the optional value for time offset for this client.
`protected static boolean`	`isProfilingEnabled()` Deprecated.
`protected boolean`	`isRequestMetricsEnabled(AmazonWebServiceRequest req)` Deprecated. metrics is deprecated
`void`	`removeRequestHandler(RequestHandler requestHandler)` Deprecated.
`void`	`removeRequestHandler(RequestHandler2 requestHandler2)` Removes a request handler from the list of registered handlers that are run as part of a request's lifecycle.
`protected RequestMetricCollector`	`requestMetricCollector()` Deprecated. metrics is deprecated
`void`	`setConfiguration(ClientConfiguration clientConfiguration)` Deprecated. by client configuration via the constructor. This method will be removed later on.
`void`	`setEndpoint(java.lang.String endpoint)` Overrides the default endpoint for this client.
`void`	`setEndpoint(java.lang.String endpoint, java.lang.String serviceName, java.lang.String regionId)` Deprecated.
`void`	`setRegion(Region region)` An alternative to `setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`setServiceNameIntern(java.lang.String serviceName)` An internal method used to explicitly override the service name computed by the default implementation.
`void`	`setSignerRegionOverride(java.lang.String signerRegionOverride)` An internal method used to explicitly override the internal signer region computed by the default implementation.
`void`	`setTimeOffset(int timeOffset)` Sets the optional value for time offset for this client.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`AmazonWebServiceClient`	`withTimeOffset(int timeOffset)` Sets the optional value for time offset for this client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOGGING_AWS_REQUEST_METRIC
```
public static final boolean LOGGING_AWS_REQUEST_METRIC
```
    Boolean for logging AWS request metrics.
    
    See Also:
    
    Constant Field Values
  - endpoint
```
protected volatile java.net.URI endpoint
```
    The service endpoint to which this client will send requests.
    Subclass should only read but not assign to this field, at least not without synchronization on the enclosing object for thread-safety reason.
  - clientConfiguration
```
protected ClientConfiguration clientConfiguration
```
    The client configuration.
  - client
```
protected AmazonHttpClient client
```
    Low level client for sending requests to AWS services.
  - requestHandler2s
```
protected final java.util.List<RequestHandler2> requestHandler2s
```
    Optional request handlers for additional request processing.
  - timeOffset
```
protected long timeOffset
```
    Optional offset (in seconds) to use when signing requests.
  - endpointPrefix
```
protected volatile java.lang.String endpointPrefix
```
- Constructor Detail
  - AmazonWebServiceClient
```
protected AmazonWebServiceClient(ClientConfiguration clientConfiguration)
```
    Constructs a new AmazonWebServiceClient object using the specified configuration.
    
    Parameters:
    
    clientConfiguration - The client configuration for this client.
  - AmazonWebServiceClient
```
@Deprecated
protected AmazonWebServiceClient(ClientConfiguration clientConfiguration,
                                             RequestMetricCollector requestMetricCollector)
```
    Deprecated.
    
    Constructs a new AmazonWebServiceClient object using the specified configuration and request metric collector.
    
    Parameters:
    
    clientConfiguration - The client configuration for this client.
    
    requestMetricCollector - optional request metric collector to be used at the http client level; can be null.
  - AmazonWebServiceClient
```
protected AmazonWebServiceClient(ClientConfiguration clientConfiguration,
                                 HttpClient httpClient)
```
    Constructs a new AmazonWebServiceClient object using the specified configuration.
    
    Parameters:
    
    clientConfiguration - The client configuration for this client.
    
    httpClient - The HTTP client.
  - AmazonWebServiceClient
```
@Deprecated
protected AmazonWebServiceClient(ClientConfiguration clientConfiguration,
                                             HttpClient httpClient,
                                             RequestMetricCollector requestMetricCollector)
```
    Deprecated.
    
    Constructs a new AmazonWebServiceClient object using the specified configuration.
    
    Parameters:
    
    clientConfiguration - The client configuration for this client.
    
    httpClient - The HTTP client.
    
    requestMetricCollector - optional request metric collector to be used at the http client level; can be null.
- Method Detail
  - getSigner
```
protected Signer getSigner()
```
    Returns the signer.
    Note, however, the signer configured for S3 is incomplete at this stage as the information on the S3 bucket and key is not yet known.
    
    Returns:
    
    Signer.
  - setEndpoint
```
public void setEndpoint(java.lang.String endpoint)
```
    Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.
    This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
    Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/general/latest/gr/rande.html
    
    Parameters:
    
    endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.
  - getEndpoint
```
public java.lang.String getEndpoint()
```
    Returns the endpoint for the service.
    
    Returns:
    
    the endpoint for the service.
  - getEndpointPrefix
```
public java.lang.String getEndpointPrefix()
```
    Returns the endpoint prefix for the service.
    
    Returns:
    
    the endpoint prefix.
  - setEndpoint
```
@Deprecated
public void setEndpoint(java.lang.String endpoint,
                                    java.lang.String serviceName,
                                    java.lang.String regionId)
```
    Deprecated.
    
    An internal method that is not expected to be normally called except for AWS internal development purposes.
    Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
    Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    
    Parameters:
    
    endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
    
    serviceName - This parameter is ignored.
    
    regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.
  - configSigner
```
@Deprecated
protected void configSigner(java.net.URI uri)
```
    Deprecated. this method is now a no-op, as overriding the signer from sublcass is no longer supported.
  - configSigner
```
@Deprecated
protected void configSigner(java.lang.String serviceName,
                                        java.lang.String regionId)
```
    Deprecated. this method is now a no-op, as overriding the signer from sublcass is no longer supported.
  - getSignerByURI
```
public Signer getSignerByURI(java.net.URI uri)
```
    Returns the signer based on the given URI and the current AWS client configuration. Currently only the SQS client can have different region on a per request basis. For other AWS clients, the region remains the same on a per AWS client level.
    Note, however, the signer returned for S3 is incomplete at this stage as the information on the S3 bucket and key is not yet known.
    
    Parameters:
    
    uri - the URI.
    
    Returns:
    
    the signer based on the given URI and the current AWS client configuration.
  - setRegion
```
public void setRegion(Region region)
```
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
  - getRegions
```
public Regions getRegions()
```
    Returns the region that the client is set to operate in. Note: This may be different from the region the client uses in its signature.
    
    Returns:
    
    the region that the client is set to operate in
  - setConfiguration
```
@Deprecated
public void setConfiguration(ClientConfiguration clientConfiguration)
```
    Deprecated. by client configuration via the constructor. This method will be removed later on.
    
    Parameters:
    
    clientConfiguration - the client configuration.
  - shutdown
```
public void shutdown()
```
    Shuts down this 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 should not be used to make any more requests.
  - addRequestHandler
```
@Deprecated
public void addRequestHandler(RequestHandler requestHandler)
```
    Deprecated. by addRequestHandler(RequestHandler2). Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
    
    Parameters:
    
    requestHandler - The new handler to add to the current list of request handlers.
  - addRequestHandler
```
public void addRequestHandler(RequestHandler2 requestHandler2)
```
    Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
    
    Parameters:
    
    requestHandler2 - The new handler to add to the current list of request handlers.
  - removeRequestHandler
```
@Deprecated
public void removeRequestHandler(RequestHandler requestHandler)
```
    Deprecated.
    
    Removes a request handler from the list of registered handlers that are run as part of a request's lifecycle.
    
    Parameters:
    
    requestHandler - The handler to remove from the current list of request handlers.
  - removeRequestHandler
```
public void removeRequestHandler(RequestHandler2 requestHandler2)
```
    Removes a request handler from the list of registered handlers that are run as part of a request's lifecycle.
    
    Parameters:
    
    requestHandler2 - The handler to remove from the current list of request handlers.
  - createExecutionContext
```
protected ExecutionContext createExecutionContext(AmazonWebServiceRequest req)
```
  - createExecutionContext
```
protected final ExecutionContext createExecutionContext(Request<?> req)
```
  - createExecutionContext
```
@Deprecated
protected final ExecutionContext createExecutionContext()
```
    Deprecated. by createExecutionContext(AmazonWebServiceRequest). This method exists only for backward compatiblity reason, so that clients compiled against the older version of this class won't get NoSuchMethodError at runtime. However, calling this methods would effectively ignore and disable the request metric collector, if any, specified at the request level. Request metric collector specified at the service client or AWS SDK level will still be honored.
  - isProfilingEnabled
```
@Deprecated
protected static boolean isProfilingEnabled()
```
    Deprecated.
  - isRequestMetricsEnabled
```
@Deprecated
protected final boolean isRequestMetricsEnabled(AmazonWebServiceRequest req)
```
    Deprecated. metrics is deprecated
    
    Returns true if request metric collection is applicable to the given request; false otherwise.
  - setTimeOffset
```
public void setTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this client. This value will be applied to all requests processed through this client. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Parameters:
    
    timeOffset - The optional value for time offset (in seconds) for this client.
  - withTimeOffset
```
public AmazonWebServiceClient withTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this client. This value will be applied to all requests processed through this client. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Parameters:
    
    timeOffset - The optional value for time offset (in seconds) for this client.
    
    Returns:
    
    the updated web service client
  - getTimeOffset
```
public long getTimeOffset()
```
    Returns the optional value for time offset for this client. This value will be applied to all requests processed through this client. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Returns:
    
    The optional value for time offset (in seconds) for this client.
  - getRequestMetricsCollector
```
@Deprecated
public RequestMetricCollector getRequestMetricsCollector()
```
    Deprecated. metrics is deprecated
    
    Returns:
    
    the client specific RequestMetricCollector; or null if there is none.
  - requestMetricCollector
```
@Deprecated
protected RequestMetricCollector requestMetricCollector()
```
    Deprecated. metrics is deprecated
    
    Returns:
    
    the client specific request metric collector if there is one; or the one at the AWS SDK level otherwise.
  - findRequestMetricCollector
```
@Deprecated
protected final RequestMetricCollector findRequestMetricCollector(Request<?> req)
```
    Deprecated. metrics is deprecated
    
    Returns:
    
    the most specific request metric collector, starting from the request level, then client level, then finally the AWS SDK level.
  - endClientExecution
```
@Deprecated
protected final void endClientExecution(AWSRequestMetrics awsRequestMetrics,
                                                    Request<?> request,
                                                    Response<?> response)
```
    Deprecated. metrics is deprecated
    
    Convenient method to end the client execution without logging the awsRequestMetrics.
  - endClientExecution
```
@Deprecated
protected final void endClientExecution(AWSRequestMetrics awsRequestMetrics,
                                                    Request<?> request,
                                                    Response<?> response,
                                                    boolean loggingAwsRequestMetrics)
```
    Deprecated. metrics is deprecated
    
    Common routine to end a client AWS request/response execution and collect the request metrics. Caller of this routine is responsible for starting the event for AWSRequestMetrics.Field.ClientExecuteTime and call this method in a try-finally block.
    
    Parameters:
    
    loggingAwsRequestMetrics - true to LOG the awsRequestMetrics; false otherwise.
  - getServiceAbbreviation
```
@Deprecated
protected java.lang.String getServiceAbbreviation()
```
    Deprecated. by getServiceName().
  - getServiceName
```
public java.lang.String getServiceName()
```
    Returns:
    
    the service abbreviation for this service, used for identifying service endpoints by region, identifying the necessary signer, etc. Used to be call "getServiceAbbreviation".
  - getServiceNameIntern
```
protected java.lang.String getServiceNameIntern()
```
    Internal method for implementing getServiceName(). Method is protected by intent so peculiar subclass that don't follow the class naming convention can choose to return whatever service name as needed.
  - setServiceNameIntern
```
public final void setServiceNameIntern(java.lang.String serviceName)
```
    An internal method used to explicitly override the service name computed by the default implementation. This method is not expected to be normally called except for AWS internal development purposes.
    
    Parameters:
    
    serviceName - the service name.
  - getSignerRegionOverride
```
public final java.lang.String getSignerRegionOverride()
```
    Returns:
    
    the signer region override.
    
    See Also:
    
    setSignerRegionOverride(String).
  - setSignerRegionOverride
```
public final void setSignerRegionOverride(java.lang.String signerRegionOverride)
```
    An internal method used to explicitly override the internal signer region computed by the default implementation. This method is not expected to be normally called except for AWS internal development purposes.
    
    Parameters:
    
    signerRegionOverride - the signer region override.

Class AmazonWebServiceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGING_AWS_REQUEST_METRIC

endpoint

clientConfiguration

client

requestHandler2s

timeOffset

endpointPrefix

Constructor Detail

AmazonWebServiceClient

AmazonWebServiceClient

AmazonWebServiceClient

AmazonWebServiceClient

Method Detail

getSigner

setEndpoint

getEndpoint

getEndpointPrefix

setEndpoint

configSigner

configSigner

getSignerByURI

setRegion

getRegions

setConfiguration

shutdown

addRequestHandler

addRequestHandler

removeRequestHandler

removeRequestHandler

createExecutionContext

createExecutionContext

createExecutionContext

isProfilingEnabled

isRequestMetricsEnabled

setTimeOffset

withTimeOffset

getTimeOffset

getRequestMetricsCollector

requestMetricCollector

findRequestMetricCollector

endClientExecution

endClientExecution

getServiceAbbreviation

getServiceName

getServiceNameIntern

setServiceNameIntern

getSignerRegionOverride

setSignerRegionOverride