com.amazonaws.services.mobileanalytics

Class AmazonMobileAnalyticsAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mobileanalytics.AmazonMobileAnalyticsClient

com.amazonaws.services.mobileanalytics.AmazonMobileAnalyticsAsyncClient

All Implemented Interfaces:

AmazonMobileAnalytics, AmazonMobileAnalyticsAsync

public class AmazonMobileAnalyticsAsyncClient
extends AmazonMobileAnalyticsClient
implements AmazonMobileAnalyticsAsync

Asynchronous client for accessing AmazonMobileAnalytics. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread.

A service which is used to record Amazon Mobile Analytics events

Field Summary

Fields inherited from class com.amazonaws.services.mobileanalytics.AmazonMobileAnalyticsClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonMobileAnalyticsAsyncClient() Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics.
AmazonMobileAnalyticsAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials.
AmazonMobileAnalyticsAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials, executor service, and client configuration options.
AmazonMobileAnalyticsAsyncClient(AWSCredentials awsCredentials, java.util.concurrent.ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials and executor service.
AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider.
AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider and client configuration options.
AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, java.util.concurrent.ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider and executor service.
AmazonMobileAnalyticsAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.concurrent.ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
java.util.concurrent.Future<java.lang.Void>	putEventsAsync(PutEventsRequest putEventsRequest) Record a batch of events
java.util.concurrent.Future<java.lang.Void>	putEventsAsync(PutEventsRequest putEventsRequest, AsyncHandler<PutEventsRequest,java.lang.Void> asyncHandler) Record a batch of events
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.mobileanalytics.AmazonMobileAnalyticsClient

getCachedResponseMetadata, putEvents, setEndpoint, setEndpoint

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.mobileanalytics.AmazonMobileAnalytics

getCachedResponseMetadata, putEvents, setEndpoint, setRegion

Constructor Detail

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonMobileAnalytics (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentials awsCredentials,
                                java.util.concurrent.ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration,
                                java.util.concurrent.ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                java.util.concurrent.ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AmazonMobileAnalyticsAsyncClient

public AmazonMobileAnalyticsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                java.util.concurrent.ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonMobileAnalytics using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonMobileAnalytics

Overrides:

shutdown in class AmazonWebServiceClient

putEventsAsync

public java.util.concurrent.Future<java.lang.Void> putEventsAsync(PutEventsRequest putEventsRequest)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Record a batch of events

Specified by:

putEventsAsync in interface AmazonMobileAnalyticsAsync

Parameters:

putEventsRequest - Container for the necessary parameters to execute the PutEvents operation on AmazonMobileAnalytics.

Returns:

A Java Future object containing the response from the PutEvents service method, as returned by AmazonMobileAnalytics.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMobileAnalytics indicating either a problem with the data in the request, or a server side issue.

putEventsAsync

public java.util.concurrent.Future<java.lang.Void> putEventsAsync(PutEventsRequest putEventsRequest,
                                                         AsyncHandler<PutEventsRequest,java.lang.Void> asyncHandler)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Record a batch of events

Specified by:

putEventsAsync in interface AmazonMobileAnalyticsAsync

Parameters:

putEventsRequest - Container for the necessary parameters to execute the PutEvents operation on AmazonMobileAnalytics.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the PutEvents service method, as returned by AmazonMobileAnalytics.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMobileAnalytics indicating either a problem with the data in the request, or a server side issue.