com.amazonaws

Class AmazonWebServiceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

Direct Known Subclasses:

AmazonAutoScalingClient, AmazonCloudFormationClient, AmazonCloudFrontClient, AmazonCloudFrontClient, AmazonCloudSearchClient, AmazonCloudWatchClient, AmazonDirectConnectClient, AmazonDynamoDBClient, AmazonDynamoDBClient, AmazonEC2Client, AmazonElastiCacheClient, AmazonElasticLoadBalancingClient, AmazonElasticMapReduceClient, AmazonElasticTranscoderClient, AmazonGlacierClient, AmazonIdentityManagementClient, AmazonImportExportClient, AmazonRDSClient, AmazonRedshiftClient, AmazonRoute53Client, AmazonS3Client, AmazonSimpleDBClient, AmazonSimpleEmailServiceClient, AmazonSimpleWorkflowClient, AmazonSNSClient, AmazonSQSClient, AWSElasticBeanstalkClient, AWSOpsWorksClient, AWSSecurityTokenServiceClient, AWSStorageGatewayClient, AWSSupportClient, DataPipelineClient

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

Constructor Summary

Constructors

Constructor and Description
AmazonWebServiceClient(ClientConfiguration clientConfiguration) Constructs a new AmazonWebServiceClient object using the specified configuration.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestHandler(RequestHandler requestHandler) Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
com.amazonaws.metrics.RequestMetricCollector	getRequestMetricsCollector() Returns the client specific RequestMetricCollector; or null if there is none.
int	getTimeOffset() Returns the optional value for time offset for this client.
void	removeRequestHandler(RequestHandler requestHandler) Removes a request handler from the list of registered handlers that are run as part of a request's lifecycle.
void	setConfiguration(ClientConfiguration clientConfiguration)
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
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

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

Constructor Detail

AmazonWebServiceClient

public AmazonWebServiceClient(ClientConfiguration clientConfiguration)

Constructs a new AmazonWebServiceClient object using the specified configuration.

Parameters:

clientConfiguration - The client configuration for this client.

Method Detail

setEndpoint

public void setEndpoint(String endpoint)
                 throws IllegalArgumentException

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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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.

setRegion

public void setRegion(Region region)
               throws IllegalArgumentException

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:

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)

setConfiguration

public void setConfiguration(ClientConfiguration clientConfiguration)

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

public void addRequestHandler(RequestHandler requestHandler)

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.

removeRequestHandler

public void removeRequestHandler(RequestHandler requestHandler)

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.

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 com.amazonaws.metrics.RequestMetricCollector getRequestMetricsCollector()

Returns the client specific RequestMetricCollector; or null if there is none.