AmazonWebServiceClient (IBM COS SDK for Java 2.13.6 API)

java.lang.Object
- com.ibm.cloud.objectstorage.AmazonWebServiceClient

Direct Known Subclasses:

AmazonS3Client
```
public abstract class AmazonWebServiceClient
extends 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 URI`	`endpoint` The service endpoint to which this client will send requests.
`protected boolean`	`isEndpointOverridden` A boolean flag that indicates whether the endpoint has been overridden either on construction or later mutated due to a call to setEndpoint().
`static boolean`	`LOGGING_AWS_REQUEST_METRIC` Deprecated. No longer used.
`protected List<RequestHandler2>`	`requestHandler2s` Optional request handlers for additional request processing.
`protected int`	`timeOffset` Optional offset (in seconds) to use when signing requests

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AmazonWebServiceClient(AwsSyncClientParams clientParams)`
	`AmazonWebServiceClient(ClientConfiguration clientConfiguration)` Constructs a new AmazonWebServiceClient object using the specified configuration.
	`AmazonWebServiceClient(ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new AmazonWebServiceClient object using the specified configuration and request metric collector.
`protected`	`AmazonWebServiceClient(ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector, boolean disableStrictHostNameVerification)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRequestHandler(RequestHandler requestHandler)` Deprecated. by `AmazonWebServiceClient.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)` Deprecated. use `AwsClientBuilder.withRequestHandlers(RequestHandler2...)`
`protected <T extends AmazonWebServiceRequest> T`	`beforeClientExecution(T request)` Notify request handlers that we are about to start execution.
`protected <T extends AmazonWebServiceRequest> T`	`beforeMarshalling(T request)` Runs the `beforeMarshalling` method of any `RequestHandler2`s associated with this client.
`protected boolean`	`calculateCRC32FromCompressedData()` Hook to allow clients to override CRC32 calculation behavior.
`protected void`	`checkMutability()` If the client has been marked as immutable then throw an `UnsupportedOperationException`, otherwise do nothing.
`void`	`configureRegion(Regions region)` Deprecated. use `AwsClientBuilder.setRegion(String)`
`protected ExecutionContext`	`createExecutionContext(AmazonWebServiceRequest req)`
`protected ExecutionContext`	`createExecutionContext(AmazonWebServiceRequest req, SignerProvider signerProvider)`
`protected ExecutionContext`	`createExecutionContext(Request<?> req)`
`protected SignerProvider`	`createSignerProvider(Signer signer)`
`protected void`	`endClientExecution(AWSRequestMetrics awsRequestMetrics, Request<?> request, Response<?> response)` Convenient method to end the client execution without logging the awsRequestMetrics.
`protected void`	`endClientExecution(AWSRequestMetrics awsRequestMetrics, Request<?> request, Response<?> response, boolean loggingAwsRequestMetrics)` Common routine to end a client AWS request/response execution and collect the request metrics.
`ClientConfiguration`	`getClientConfiguration()`
`String`	`getEndpointPrefix()`
`Collection<MonitoringListener>`	`getMonitoringListeners()` Returns `MonitoringListener`; or null if there is none.
`RequestMetricCollector`	`getRequestMetricsCollector()` Returns the client specific `RequestMetricCollector`; or null if there is none.
`protected String`	`getServiceAbbreviation()` Deprecated. by `AmazonWebServiceClient.getServiceName()`.
`String`	`getServiceName()` Returns the service abbreviation for this service, used for identifying service endpoints by region, identifying the necessary signer, etc.
`protected String`	`getServiceNameIntern()` Internal method for implementing `AmazonWebServiceClient.getServiceName()`.
`protected Signer`	`getSigner()` Deprecated.
`Signer`	`getSignerByURI(URI uri)` Returns the signer based on the given URI and the current AWS client configuration.
`String`	`getSignerOverride()`
`protected SignerProvider`	`getSignerProvider()`
`String`	`getSignerRegionOverride()` Returns the signer region override.
`int`	`getTimeOffset()` Returns the optional value for time offset for this client.
`protected boolean`	`isEndpointOverridden()` Returns a flag that indicates whether the endpoint for this client has been overridden or not.
`protected static boolean`	`isProfilingEnabled()`
`protected boolean`	`isRequestMetricsEnabled(AmazonWebServiceRequest req)` Returns true if request metric collection is applicable to the given request; false otherwise.
`void`	`makeImmutable()` Deprecated.
`void`	`removeRequestHandler(RequestHandler requestHandler)` Deprecated. use `AwsClientBuilder.withRequestHandlers(RequestHandler2...)`
`void`	`removeRequestHandler(RequestHandler2 requestHandler2)` Deprecated. use `AwsClientBuilder.withRequestHandlers(RequestHandler2...)`
`protected RequestMetricCollector`	`requestMetricCollector()` Returns the client specific request metric collector if there is one; or the one at the AWS SDK level otherwise.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder.setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`protected void`	`setEndpointPrefix(String endpointPrefix)` An internal method used to explicitly override the service name for region metadata.
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder.setRegion(String)`
`void`	`setServiceNameIntern(String serviceName)` An internal method used to explicitly override the service name computed by the default implementation.
`void`	`setSignerRegionOverride(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.
`protected boolean`	`useStrictHostNameVerification()` Hook to allow S3 client to disable strict hostname verification since it uses wildcard certificates.
`<T extends AmazonWebServiceClient> T`	`withEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder.withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `AmazonSNSClientBuilder.standard().withEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)).build();`
`<T extends AmazonWebServiceClient> T`	`withRegion(Region region)` Deprecated. use `AwsClientBuilder.withRegion(Region)` for example: `AmazonSNSClientBuilder.standard().withRegion(region).build();`
`<T extends AmazonWebServiceClient> T`	`withRegion(Regions region)` Deprecated. use `AwsClientBuilder.withRegion(Regions)` for example: `AmazonSNSClientBuilder.standard().withRegion(region).build();`
`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
```
@Deprecated
public static final boolean LOGGING_AWS_REQUEST_METRIC
```
    Deprecated. No longer used.
    
    See Also:
    
    Constant Field Values
  - endpoint
```
protected volatile 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. If this value is changed to effectively override the endpoint, then the 'isEndpointOverridden' property should also be set to 'true' within the same synchronized block of code.
  - isEndpointOverridden
```
protected volatile boolean isEndpointOverridden
```
    A boolean flag that indicates whether the endpoint has been overridden either on construction or later mutated due to a call to setEndpoint(). If the endpoint property is updated directly then the method doing that update also has the responsibility to update this flag as part of an atomic threadsafe operation.
  - clientConfiguration
```
protected ClientConfiguration clientConfiguration
```
    The client configuration
  - client
```
protected AmazonHttpClient client
```
    Low level client for sending requests to AWS services.
  - requestHandler2s
```
protected final List<RequestHandler2> requestHandler2s
```
    Optional request handlers for additional request processing.
  - timeOffset
```
protected int timeOffset
```
    Optional offset (in seconds) to use when signing requests
- Constructor Detail
  - AmazonWebServiceClient
```
public AmazonWebServiceClient(ClientConfiguration clientConfiguration)
```
    Constructs a new AmazonWebServiceClient object using the specified configuration.
    
    Parameters:
    
    clientConfiguration - The client configuration for this client.
  - AmazonWebServiceClient
```
public AmazonWebServiceClient(ClientConfiguration clientConfiguration,
                              RequestMetricCollector requestMetricCollector)
```
    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,
                                 RequestMetricCollector requestMetricCollector,
                                 boolean disableStrictHostNameVerification)
```
  - AmazonWebServiceClient
```
protected AmazonWebServiceClient(AwsSyncClientParams clientParams)
```
- Method Detail
  - getSigner
```
@Deprecated
protected Signer getSigner()
```
    Deprecated.
    
    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.
  - isEndpointOverridden
```
protected boolean isEndpointOverridden()
```
    Returns a flag that indicates whether the endpoint for this client has been overridden or not.
    
    Returns:
    
    true if the configured endpoint is an override; false if not.
  - getSignerProvider
```
protected SignerProvider getSignerProvider()
```
    Returns:
    
    Current SignerProvider instance.
  - setEndpoint
```
@Deprecated
public void setEndpoint(String endpoint)
                             throws IllegalArgumentException
```
    Deprecated. use AwsClientBuilder.setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-choose-endpoint
    
    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:
    
    IllegalArgumentException - If any problems are detected with the specified endpoint.
  - getSignerByURI
```
public Signer getSignerByURI(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.
  - setRegion
```
@Deprecated
public void setRegion(Region region)
                           throws IllegalArgumentException
```
    Deprecated. use AwsClientBuilder.setRegion(String)
    
    An alternative to AmazonWebServiceClient.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.ibm.cloud.objectstorage.regions.Regions) for accessing a given region.
    
    Throws:
    
    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.ibm.cloud.objectstorage.regions.Regions), Region.createClient(Class, com.ibm.cloud.objectstorage.auth.AWSCredentialsProvider, ClientConfiguration)
  - configureRegion
```
@Deprecated
public final void configureRegion(Regions region)
```
    Deprecated. use AwsClientBuilder.setRegion(String)
    
    Convenient method for setting region.
    
    Parameters:
    
    region - region to set to; must not be null.
    
    See Also:
    
    AmazonWebServiceClient.setRegion(Region)
  - shutdown
```
public void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. 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 AmazonWebServiceClient.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
```
@Deprecated
public void addRequestHandler(RequestHandler2 requestHandler2)
```
    Deprecated. use AwsClientBuilder.withRequestHandlers(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. use AwsClientBuilder.withRequestHandlers(RequestHandler2...)
    
    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
```
@Deprecated
public void removeRequestHandler(RequestHandler2 requestHandler2)
```
    Deprecated. use AwsClientBuilder.withRequestHandlers(RequestHandler2...)
  - beforeMarshalling
```
protected final <T extends AmazonWebServiceRequest> T beforeMarshalling(T request)
```
    Runs the beforeMarshalling method of any RequestHandler2s associated with this client.
    
    Parameters:
    
    request - the request passed in from the user
    
    Returns:
    
    the (possibly different) request to marshal
  - createExecutionContext
```
protected ExecutionContext createExecutionContext(AmazonWebServiceRequest req)
```
  - createExecutionContext
```
protected ExecutionContext createExecutionContext(AmazonWebServiceRequest req,
                                                  SignerProvider signerProvider)
```
  - createExecutionContext
```
protected final ExecutionContext createExecutionContext(Request<?> req)
```
  - createSignerProvider
```
protected SignerProvider createSignerProvider(Signer signer)
```
  - isProfilingEnabled
```
protected static boolean isProfilingEnabled()
```
  - isRequestMetricsEnabled
```
protected final boolean isRequestMetricsEnabled(AmazonWebServiceRequest req)
```
    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 int 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
```
public RequestMetricCollector getRequestMetricsCollector()
```
    Returns the client specific RequestMetricCollector; or null if there is none.
  - getMonitoringListeners
```
public Collection<MonitoringListener> getMonitoringListeners()
```
    Returns MonitoringListener; or null if there is none.
  - requestMetricCollector
```
protected RequestMetricCollector requestMetricCollector()
```
    Returns the client specific request metric collector if there is one; or the one at the AWS SDK level otherwise.
  - beforeClientExecution
```
protected final <T extends AmazonWebServiceRequest> T beforeClientExecution(T request)
```
    Notify request handlers that we are about to start execution.
  - endClientExecution
```
protected final void endClientExecution(AWSRequestMetrics awsRequestMetrics,
                                        Request<?> request,
                                        Response<?> response)
```
    Convenient method to end the client execution without logging the awsRequestMetrics.
  - endClientExecution
```
protected final void endClientExecution(AWSRequestMetrics awsRequestMetrics,
                                        Request<?> request,
                                        Response<?> response,
                                        @Deprecated
                                        boolean loggingAwsRequestMetrics)
```
    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 - deprecated and ignored
  - getServiceAbbreviation
```
@Deprecated
protected String getServiceAbbreviation()
```
    Deprecated. by AmazonWebServiceClient.getServiceName().
  - getServiceName
```
public 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".
  - getEndpointPrefix
```
public String getEndpointPrefix()
```
    Returns:
    
    the service name that should be used when computing the region endpoints. This method returns the value of the regionMetadataServiceName configuration in the internal config file if such configuration is specified for the current client, otherwise it returns the same service name that is used for request signing.
  - setEndpointPrefix
```
protected void setEndpointPrefix(String endpointPrefix)
```
    An internal method used to explicitly override the service name for region metadata. This service name is used to compute the region endpoints.
  - getServiceNameIntern
```
protected String getServiceNameIntern()
```
    Internal method for implementing AmazonWebServiceClient.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(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.
  - getSignerRegionOverride
```
public final String getSignerRegionOverride()
```
    Returns the signer region override.
    
    See Also:
    
    AmazonWebServiceClient.setSignerRegionOverride(String).
  - setSignerRegionOverride
```
public final void setSignerRegionOverride(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.
  - withRegion
```
@Deprecated
public <T extends AmazonWebServiceClient> T withRegion(Region region)
```
    Deprecated. use AwsClientBuilder.withRegion(Region) for example: AmazonSNSClientBuilder.standard().withRegion(region).build();
    Fluent method for AmazonWebServiceClient.setRegion(Region).
```
 Example:

   AmazonDynamoDBClient client = new AmazonDynamoDBClient(...).withRegion(...);
```
    See Also:
    
    AmazonWebServiceClient.setRegion(Region)
  - withRegion
```
@Deprecated
public <T extends AmazonWebServiceClient> T withRegion(Regions region)
```
    Deprecated. use AwsClientBuilder.withRegion(Regions) for example: AmazonSNSClientBuilder.standard().withRegion(region).build();
    
    Convenient fluent method for setting region.
    
    Parameters:
    
    region - region to set to; must not be null.
    
    See Also:
    
    AmazonWebServiceClient.withRegion(Region)
  - withEndpoint
```
@Deprecated
public <T extends AmazonWebServiceClient> T withEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder.withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: AmazonSNSClientBuilder.standard().withEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)).build();
    Fluent method for AmazonWebServiceClient.setEndpoint(String).
```
 Example:

   AmazonDynamoDBClient client = new AmazonDynamoDBClient(...).withEndPoint(...);
```
    See Also:
    
    AmazonWebServiceClient.setEndpoint(String)
  - makeImmutable
```
@Deprecated
public final void makeImmutable()
```
    Deprecated.
    
    Internal only API to lock a client's mutable methods. Only intended for use by the fluent builders.
  - checkMutability
```
protected final void checkMutability()
```
    If the client has been marked as immutable then throw an UnsupportedOperationException, otherwise do nothing. Should be called by each mutating method.
  - useStrictHostNameVerification
```
protected boolean useStrictHostNameVerification()
```
    Hook to allow S3 client to disable strict hostname verification since it uses wildcard certificates.
    
    Returns:
    
    True if strict hostname verification should be used, false otherwise.
  - calculateCRC32FromCompressedData
```
protected boolean calculateCRC32FromCompressedData()
```
    Hook to allow clients to override CRC32 calculation behavior. Currently, only exercised by DynamoDB.
    
    Returns:
    
    True if the service returns CRC32 checksum from the compressed data, false otherwise.
  - getSignerOverride
```
public String getSignerOverride()
```
  - getClientConfiguration
```
public ClientConfiguration getClientConfiguration()
```

Class AmazonWebServiceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGING_AWS_REQUEST_METRIC

endpoint

isEndpointOverridden

clientConfiguration

client

requestHandler2s

timeOffset

Constructor Detail

AmazonWebServiceClient

AmazonWebServiceClient

AmazonWebServiceClient

AmazonWebServiceClient

Method Detail

getSigner

isEndpointOverridden

getSignerProvider

setEndpoint

getSignerByURI

setRegion

configureRegion

shutdown

addRequestHandler

addRequestHandler

removeRequestHandler

removeRequestHandler

beforeMarshalling

createExecutionContext

createExecutionContext

createExecutionContext

createSignerProvider

isProfilingEnabled

isRequestMetricsEnabled

setTimeOffset

withTimeOffset

getTimeOffset

getRequestMetricsCollector

getMonitoringListeners

requestMetricCollector

beforeClientExecution

endClientExecution

endClientExecution

getServiceAbbreviation

getServiceName

getEndpointPrefix

setEndpointPrefix

getServiceNameIntern

setServiceNameIntern

getSignerRegionOverride

setSignerRegionOverride

withRegion

withRegion

withEndpoint

makeImmutable

checkMutability

useStrictHostNameVerification

calculateCRC32FromCompressedData

getSignerOverride

getClientConfiguration