com.amazonaws.services.sns.AmazonSNSAsyncClient Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.sns;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.services.sns.model.*;
/**
* Client for accessing AmazonSNS. All calls made
* using this client are non-blocking and will immediately return a Java Future.
* Callers must use the Future object to determine when the service call has actually
* completed.
* Amazon Simple Notification Service
*/
public class AmazonSNSAsyncClient extends AmazonSNSClient
implements AmazonSNSAsync {
/**
* Executor service for executing asynchronous requests.
*/
private ExecutorService executorService;
/**
* Constructs a new asynchronous client to invoke service methods on
* AmazonSNS using the specified AWS account credentials.
* Default client settings will be used, and a default cached 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.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
*/
public AmazonSNSAsyncClient(AWSCredentials awsCredentials) {
this(awsCredentials, Executors.newCachedThreadPool());
}
/**
* Constructs a new asynchronous client to invoke service methods on
* AmazonSNS 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.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
* @param executorService
* The executor service by which all asynchronous requests will
* be executed.
*/
public AmazonSNSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) {
super(awsCredentials);
this.executorService = executorService;
}
/**
* Constructs a new asynchronous client to invoke service methods on
* AmazonSNS 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.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
* @param clientConfiguration
* Client configuration options (ex: max retry limit, proxy
* settings, etc).
* @param executorService
* The executor service by which all asynchronous requests will
* be executed.
*/
public AmazonSNSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration, ExecutorService executorService) {
super(awsCredentials, clientConfiguration);
this.executorService = executorService;
}
/**
* Returns the executor service used by this async client to execute
* requests.
*
* @return The executor service used by this async client to execute
* requests.
*/
public ExecutorService getExecutorService() {
return executorService;
}
/**
*
* The ConfirmSubscription action verifies an endpoint owner's intent to
* receive messages by validating the token sent to the endpoint by an
* earlier Subscribe action. If the token is valid, the action creates a
* new subscription and returns its Amazon Resource Name (ARN). This call
* requires an AWS signature only when the AuthenticateOnUnsubscribe flag
* is set to "true".
*
*
* @param confirmSubscriptionRequest Container for the necessary
* parameters to execute the ConfirmSubscription operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* ConfirmSubscription service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future confirmSubscriptionAsync(final ConfirmSubscriptionRequest confirmSubscriptionRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public ConfirmSubscriptionResult call() throws Exception {
return confirmSubscription(confirmSubscriptionRequest);
}
});
}
/**
*
* The GetTopicAttribtues action returns all of the properties of a topic
* customers have created. Topic properties returned might differ based
* on the authorization of the user.
*
*
* @param getTopicAttributesRequest Container for the necessary
* parameters to execute the GetTopicAttributes operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* GetTopicAttributes service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getTopicAttributesAsync(final GetTopicAttributesRequest getTopicAttributesRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public GetTopicAttributesResult call() throws Exception {
return getTopicAttributes(getTopicAttributesRequest);
}
});
}
/**
*
* The Subscribe action prepares to subscribe an endpoint by sending the
* endpoint a confirmation message. To actually create a subscription,
* the endpoint owner must call the ConfirmSubscription action with the
* token from the confirmation message. Confirmation tokens are valid for
* twenty-four hours.
*
*
* @param subscribeRequest Container for the necessary parameters to
* execute the Subscribe operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* Subscribe service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future subscribeAsync(final SubscribeRequest subscribeRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public SubscribeResult call() throws Exception {
return subscribe(subscribeRequest);
}
});
}
/**
*
* The SetTopicAttributes action allows a topic owner to set an attribute
* of the topic to a new value.
*
*
* @param setTopicAttributesRequest Container for the necessary
* parameters to execute the SetTopicAttributes operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* SetTopicAttributes service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setTopicAttributesAsync(final SetTopicAttributesRequest setTopicAttributesRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public Void call() throws Exception {
setTopicAttributes(setTopicAttributesRequest);
return null;
}
});
}
/**
*
* The DeleteTopic action deletes a topic and all its subscriptions.
* Deleting a topic might prevent some messages previously sent to the
* topic from being delivered to subscribers. This action is idempotent,
* so deleting a topic that does not exist will not result in an error.
*
*
* @param deleteTopicRequest Container for the necessary parameters to
* execute the DeleteTopic operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* DeleteTopic service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deleteTopicAsync(final DeleteTopicRequest deleteTopicRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public Void call() throws Exception {
deleteTopic(deleteTopicRequest);
return null;
}
});
}
/**
*
* The RemovePermission action removes a statement from a topic's access
* control policy.
*
*
* @param removePermissionRequest Container for the necessary parameters
* to execute the RemovePermission operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* RemovePermission service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future removePermissionAsync(final RemovePermissionRequest removePermissionRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public Void call() throws Exception {
removePermission(removePermissionRequest);
return null;
}
});
}
/**
*
* The ListSubscriptions action returns a list of the requester's
* subscriptions. Each call returns a limited list of subscriptions. If
* there are more subscriptions, a NextToken is also returned. Use the
* NextToken parameter in a new ListSubscriptions call to get further
* results.
*
*
* @param listSubscriptionsRequest Container for the necessary parameters
* to execute the ListSubscriptions operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* ListSubscriptions service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listSubscriptionsAsync(final ListSubscriptionsRequest listSubscriptionsRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public ListSubscriptionsResult call() throws Exception {
return listSubscriptions(listSubscriptionsRequest);
}
});
}
/**
*
* The AddPermission action adds a statement to a topic's access control
* policy, granting access for the specified AWS accounts to the
* specified actions.
*
*
* @param addPermissionRequest Container for the necessary parameters to
* execute the AddPermission operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* AddPermission service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future addPermissionAsync(final AddPermissionRequest addPermissionRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public Void call() throws Exception {
addPermission(addPermissionRequest);
return null;
}
});
}
/**
*
* The CreateTopic action creates a topic to which notifications can be
* published. Users can create at most 25 topics. This action is
* idempotent, so if the requester already owns a topic with the
* specified name, that topic's ARN will be returned without creating a
* new topic.
*
*
* @param createTopicRequest Container for the necessary parameters to
* execute the CreateTopic operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* CreateTopic service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createTopicAsync(final CreateTopicRequest createTopicRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public CreateTopicResult call() throws Exception {
return createTopic(createTopicRequest);
}
});
}
/**
*
* The ListTopics action returns a list of the requester's topics. Each
* call returns a limited list of topics. If there are more topics, a
* NextToken is also returned. Use the NextToken parameter in a new
* ListTopics call to get further results.
*
*
* @param listTopicsRequest Container for the necessary parameters to
* execute the ListTopics operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* ListTopics service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listTopicsAsync(final ListTopicsRequest listTopicsRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public ListTopicsResult call() throws Exception {
return listTopics(listTopicsRequest);
}
});
}
/**
*
* The Unsubscribe action deletes a subscription. If the subscription
* requires authentication for deletion, only the owner of the
* subscription or the its topic's owner can unsubscribe, and an AWS
* signature is required. If the Unsubscribe call does not require
* authentication and the requester is not the subscription owner, a
* final cancellation message is delivered to the endpoint, so that the
* endpoint owner can easily resubscribe to the topic if the Unsubscribe
* request was unintended.
*
*
* @param unsubscribeRequest Container for the necessary parameters to
* execute the Unsubscribe operation on AmazonSNS.
*
* @return A Java Future object containing the response from the
* Unsubscribe service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future unsubscribeAsync(final UnsubscribeRequest unsubscribeRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public Void call() throws Exception {
unsubscribe(unsubscribeRequest);
return null;
}
});
}
/**
*
* The ListSubscriptionsByTopic action returns a list of the
* subscriptions to a specific topic. Each call returns a limited list of
* subscriptions. If there are more subscriptions, a NextToken is also
* returned. Use the NextToken parameter in a new
* ListSubscriptionsByTopic call to get further results.
*
*
* @param listSubscriptionsByTopicRequest Container for the necessary
* parameters to execute the ListSubscriptionsByTopic operation on
* AmazonSNS.
*
* @return A Java Future object containing the response from the
* ListSubscriptionsByTopic service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listSubscriptionsByTopicAsync(final ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public ListSubscriptionsByTopicResult call() throws Exception {
return listSubscriptionsByTopic(listSubscriptionsByTopicRequest);
}
});
}
/**
*
* The Publish action sends a message to all of a topic's subscribed
* endpoints. When a messageId is returned, the message has been saved
* and Amazon SNS will attempt to deliver it to the topic's subscribers
* shortly. The format of the outgoing message to each subscribed
* endpoint depends on the notification protocol selected.
*
*
* @param publishRequest Container for the necessary parameters to
* execute the Publish operation on AmazonSNS.
*
* @return A Java Future object containing the response from the Publish
* service method, as returned by AmazonSNS.
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future publishAsync(final PublishRequest publishRequest)
throws AmazonServiceException, AmazonClientException {
return executorService.submit(new Callable() {
public PublishResult call() throws Exception {
return publish(publishRequest);
}
});
}
}