Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.sqs.buffered
Class AmazonSQSBufferedAsyncClient

java.lang.Object
  extended by com.amazonaws.services.sqs.buffered.AmazonSQSBufferedAsyncClient
All Implemented Interfaces:
AmazonSQS, AmazonSQSAsync

public class AmazonSQSBufferedAsyncClient
extends Object
implements AmazonSQSAsync

AmazonSQSBufferedAsyncClient provides client-side batching of outgoing sendMessage, deleteMessage and changeMessageVisibility calls.
After receiving a call, rather than executing it right away, this client waits for a configurable period of time ( default=200ms) for other calls of the same type to come in; if such calls do come in, they are also not executed immediately, but instead are added to the batch. When the batch becomes full or the timeout period expires, the entire batch is executed at once and the results are returned to the callers. This method of operation leads to reduced operating costs (since SQS charges per call and fewer calls are made) and increased overall throughput (since more work is performed per call, and all fixed costs of making a call are amortized over a greater amount of work). The cost of this method is increased latency for individual calls, since calls spend some time waiting on the client side for the potential batch-mates to appear before they are actually executed.
This client also performs pre-fetching of messages from SQS. After the first receiveMessage call is made, the client attempts not only to satisfy that call, but also pre-fetch extra messages to store in a temporary buffer. Future receiveMessage calls will be satisfied from the buffer, and only if the buffer is empty will the calling thread have to wait for the messages to be fetched. The size of the buffer and the maximum number of threads used for prefetching are configurable.
AmazonSQSBufferedAsyncClient is thread-safe.


Field Summary
static String USER_AGENT
           
 
Constructor Summary
AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS)
           
AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS, QueueBufferConfig config)
           
 
Method Summary
 void addPermission(AddPermissionRequest addPermissionRequest)
           
 Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest)
           
 Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,Void> asyncHandler)
           
 void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
           
 Future<Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
           
 Future<Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest, AsyncHandler<ChangeMessageVisibilityRequest,Void> asyncHandler)
           
 ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
           
 Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
           
 Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest, AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
           
 CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
           
 Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest)
           
 Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
           
 void deleteMessage(DeleteMessageRequest deleteMessageRequest)
           
 Future<Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)
           
 Future<Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest, AsyncHandler<DeleteMessageRequest,Void> asyncHandler)
           
 DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
           
 Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)
           
 Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest, AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
           
 void deleteQueue(DeleteQueueRequest deleteQueueRequest)
           
 Future<Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
           
 Future<Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest, AsyncHandler<DeleteQueueRequest,Void> asyncHandler)
           
 ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
          Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
 GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
           
 Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)
           
 Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest, AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
           
 GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
           
 Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)
           
 Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest, AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
           
 ListQueuesResult listQueues()
           
 ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
           
 Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest)
           
 Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
           
 ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
           
 Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)
           
 Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest, AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
           
 void removePermission(RemovePermissionRequest removePermissionRequest)
           
 Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
           
 Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,Void> asyncHandler)
           
 SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
           
 Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest)
           
 Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
           
 SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
           
 Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)
           
 Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest, AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
           
 void setEndpoint(String endpoint)
          Overrides the default endpoint for this client ("sqs.us-east-1.amazonaws.com").
 void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
           
 Future<Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)
           
 Future<Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest, AsyncHandler<SetQueueAttributesRequest,Void> asyncHandler)
           
 void setRegion(Region region)
          An alternative to AmazonSQS.setEndpoint(String), sets the regional endpoint for this client's service calls.
 void shutdown()
          Shuts down this client object, releasing any resources that might be held open.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

USER_AGENT

public static final String USER_AGENT
Constructor Detail

AmazonSQSBufferedAsyncClient

public AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS)

AmazonSQSBufferedAsyncClient

public AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS,
                                    QueueBufferConfig config)
Method Detail

setRegion

public void setRegion(Region region)
               throws IllegalArgumentException
Description copied from interface: AmazonSQS
An alternative to AmazonSQS.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.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

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.

Specified by:
setRegion in interface AmazonSQS
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)

setQueueAttributes

public void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
                        throws AmazonServiceException,
                               AmazonClientException
Specified by:
setQueueAttributes in interface AmazonSQS
Parameters:
setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes service method on AmazonSQS.
Throws:
InvalidAttributeNameException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

changeMessageVisibilityBatch

public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
Specified by:
changeMessageVisibilityBatch in interface AmazonSQS
Parameters:
changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method on AmazonSQS.
Returns:
The response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:
BatchEntryIdsNotDistinctException
TooManyEntriesInBatchRequestException
InvalidBatchEntryIdException
EmptyBatchRequestException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

changeMessageVisibility

public void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                             throws AmazonServiceException,
                                    AmazonClientException
Specified by:
changeMessageVisibility in interface AmazonSQS
Parameters:
changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility service method on AmazonSQS.
Throws:
ReceiptHandleIsInvalidException
MessageNotInflightException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

sendMessageBatch

public SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
Specified by:
sendMessageBatch in interface AmazonSQS
Parameters:
sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch service method on AmazonSQS.
Returns:
The response from the SendMessageBatch service method, as returned by AmazonSQS.
Throws:
BatchEntryIdsNotDistinctException
TooManyEntriesInBatchRequestException
BatchRequestTooLongException
InvalidBatchEntryIdException
EmptyBatchRequestException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

sendMessage

public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
Specified by:
sendMessage in interface AmazonSQS
Parameters:
sendMessageRequest - Container for the necessary parameters to execute the SendMessage service method on AmazonSQS.
Returns:
The response from the SendMessage service method, as returned by AmazonSQS.
Throws:
InvalidMessageContentsException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

receiveMessage

public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException
Specified by:
receiveMessage in interface AmazonSQS
Parameters:
receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage service method on AmazonSQS.
Returns:
The response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:
OverLimitException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteMessageBatch

public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException
Specified by:
deleteMessageBatch in interface AmazonSQS
Parameters:
deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch service method on AmazonSQS.
Returns:
The response from the DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:
BatchEntryIdsNotDistinctException
TooManyEntriesInBatchRequestException
InvalidBatchEntryIdException
EmptyBatchRequestException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteMessage

public void deleteMessage(DeleteMessageRequest deleteMessageRequest)
                   throws AmazonServiceException,
                          AmazonClientException
Specified by:
deleteMessage in interface AmazonSQS
Parameters:
deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage service method on AmazonSQS.
Throws:
ReceiptHandleIsInvalidException
InvalidIdFormatException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

shutdown

public void shutdown()
Description copied from interface: AmazonSQS
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.

Specified by:
shutdown in interface AmazonSQS

changeMessageVisibilityBatchAsync

public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException
Specified by:
changeMessageVisibilityBatchAsync in interface AmazonSQSAsync
Parameters:
changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQS.
Returns:
A Java Future object containing the response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

changeMessageVisibilityAsync

public Future<Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException
Specified by:
changeMessageVisibilityAsync in interface AmazonSQSAsync
Parameters:
changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQS.
Returns:
A Java Future object containing the response from the ChangeMessageVisibility service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

sendMessageBatchAsync

public Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException
Specified by:
sendMessageBatchAsync in interface AmazonSQSAsync
Parameters:
sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQS.
Returns:
A Java Future object containing the response from the SendMessageBatch service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

sendMessageAsync

public Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException
Specified by:
sendMessageAsync in interface AmazonSQSAsync
Parameters:
sendMessageRequest - Container for the necessary parameters to execute the SendMessage operation on AmazonSQS.
Returns:
A Java Future object containing the response from the SendMessage service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

receiveMessageAsync

public Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException
Specified by:
receiveMessageAsync in interface AmazonSQSAsync
Parameters:
receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQS.
Returns:
A Java Future object containing the response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteMessageBatchAsync

public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException
Specified by:
deleteMessageBatchAsync in interface AmazonSQSAsync
Parameters:
deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQS.
Returns:
A Java Future object containing the response from the DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

setEndpoint

public void setEndpoint(String endpoint)
                 throws IllegalArgumentException
Description copied from interface: AmazonSQS
Overrides the default endpoint for this client ("sqs.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sqs.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

This method is not threadsafe. An endpoint 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.

Specified by:
setEndpoint in interface AmazonSQS
Parameters:
endpoint - The endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sqs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
Throws:
IllegalArgumentException - If any problems are detected with the specified endpoint.

setQueueAttributesAsync

public Future<Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException
Specified by:
setQueueAttributesAsync in interface AmazonSQSAsync
Parameters:
setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQS.
Returns:
A Java Future object containing the response from the SetQueueAttributes service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getQueueUrlAsync

public Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException
Specified by:
getQueueUrlAsync in interface AmazonSQSAsync
Parameters:
getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQS.
Returns:
A Java Future object containing the response from the GetQueueUrl service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

removePermissionAsync

public Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException
Specified by:
removePermissionAsync in interface AmazonSQSAsync
Parameters:
removePermissionRequest - Container for the necessary parameters to execute the RemovePermission operation on AmazonSQS.
Returns:
A Java Future object containing the response from the RemovePermission service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getQueueUrl

public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
Specified by:
getQueueUrl in interface AmazonSQS
Parameters:
getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl service method on AmazonSQS.
Returns:
The response from the GetQueueUrl service method, as returned by AmazonSQS.
Throws:
QueueDoesNotExistException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

removePermission

public void removePermission(RemovePermissionRequest removePermissionRequest)
                      throws AmazonServiceException,
                             AmazonClientException
Specified by:
removePermission in interface AmazonSQS
Parameters:
removePermissionRequest - Container for the necessary parameters to execute the RemovePermission service method on AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getQueueAttributesAsync

public Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException
Specified by:
getQueueAttributesAsync in interface AmazonSQSAsync
Parameters:
getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQS.
Returns:
A Java Future object containing the response from the GetQueueAttributes service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getQueueAttributes

public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException
Specified by:
getQueueAttributes in interface AmazonSQS
Parameters:
getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes service method on AmazonSQS.
Returns:
The response from the GetQueueAttributes service method, as returned by AmazonSQS.
Throws:
InvalidAttributeNameException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteQueueAsync

public Future<Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
Specified by:
deleteQueueAsync in interface AmazonSQSAsync
Parameters:
deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQS.
Returns:
A Java Future object containing the response from the DeleteQueue service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteQueue

public void deleteQueue(DeleteQueueRequest deleteQueueRequest)
                 throws AmazonServiceException,
                        AmazonClientException
Specified by:
deleteQueue in interface AmazonSQS
Parameters:
deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue service method on AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

listQueuesAsync

public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException
Specified by:
listQueuesAsync in interface AmazonSQSAsync
Parameters:
listQueuesRequest - Container for the necessary parameters to execute the ListQueues operation on AmazonSQS.
Returns:
A Java Future object containing the response from the ListQueues service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

listQueues

public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
                            throws AmazonServiceException,
                                   AmazonClientException
Specified by:
listQueues in interface AmazonSQS
Parameters:
listQueuesRequest - Container for the necessary parameters to execute the ListQueues service method on AmazonSQS.
Returns:
The response from the ListQueues service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

createQueueAsync

public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException
Specified by:
createQueueAsync in interface AmazonSQSAsync
Parameters:
createQueueRequest - Container for the necessary parameters to execute the CreateQueue operation on AmazonSQS.
Returns:
A Java Future object containing the response from the CreateQueue service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

createQueue

public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
Specified by:
createQueue in interface AmazonSQS
Parameters:
createQueueRequest - Container for the necessary parameters to execute the CreateQueue service method on AmazonSQS.
Returns:
The response from the CreateQueue service method, as returned by AmazonSQS.
Throws:
QueueNameExistsException
QueueDeletedRecentlyException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

addPermissionAsync

public Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest)
                                throws AmazonServiceException,
                                       AmazonClientException
Specified by:
addPermissionAsync in interface AmazonSQSAsync
Parameters:
addPermissionRequest - Container for the necessary parameters to execute the AddPermission operation on AmazonSQS.
Returns:
A Java Future object containing the response from the AddPermission service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

addPermission

public void addPermission(AddPermissionRequest addPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException
Specified by:
addPermission in interface AmazonSQS
Parameters:
addPermissionRequest - Container for the necessary parameters to execute the AddPermission service method on AmazonSQS.
Throws:
OverLimitException
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

listQueues

public ListQueuesResult listQueues()
                            throws AmazonServiceException,
                                   AmazonClientException
Specified by:
listQueues in interface AmazonSQS
Returns:
The response from the ListQueues service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface: AmazonSQS
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:
getCachedResponseMetadata in interface AmazonSQS
Parameters:
request - The originally executed request.
Returns:
The response metadata for the specified request, or null if none is available.

deleteMessageAsync

public Future<Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)
                                throws AmazonServiceException,
                                       AmazonClientException
Specified by:
deleteMessageAsync in interface AmazonSQSAsync
Parameters:
deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQS.
Returns:
A Java Future object containing the response from the DeleteMessage service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

changeMessageVisibilityAsync

public Future<Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest,
                                                 AsyncHandler<ChangeMessageVisibilityRequest,Void> asyncHandler)
                                          throws AmazonServiceException,
                                                 AmazonClientException
Specified by:
changeMessageVisibilityAsync in interface AmazonSQSAsync
Parameters:
changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQS.
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 ChangeMessageVisibility service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

sendMessageAsync

public Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest,
                                                  AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException
Specified by:
sendMessageAsync in interface AmazonSQSAsync
Parameters:
sendMessageRequest - Container for the necessary parameters to execute the SendMessage operation on AmazonSQS.
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 SendMessage service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

receiveMessageAsync

public Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest,
                                                        AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
                                                 throws AmazonServiceException,
                                                        AmazonClientException
Specified by:
receiveMessageAsync in interface AmazonSQSAsync
Parameters:
receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQS.
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 ReceiveMessage service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteMessageAsync

public Future<Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest,
                                       AsyncHandler<DeleteMessageRequest,Void> asyncHandler)
                                throws AmazonServiceException,
                                       AmazonClientException
Specified by:
deleteMessageAsync in interface AmazonSQSAsync
Parameters:
deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQS.
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 DeleteMessage service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

setQueueAttributesAsync

public Future<Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest,
                                            AsyncHandler<SetQueueAttributesRequest,Void> asyncHandler)
                                     throws AmazonServiceException,
                                            AmazonClientException
Specified by:
setQueueAttributesAsync in interface AmazonSQSAsync
Parameters:
setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQS.
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 SetQueueAttributes service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

changeMessageVisibilityBatchAsync

public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest,
                                                                                    AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException
Specified by:
changeMessageVisibilityBatchAsync in interface AmazonSQSAsync
Parameters:
changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQS.
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 ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getQueueUrlAsync

public Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest,
                                                  AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException
Specified by:
getQueueUrlAsync in interface AmazonSQSAsync
Parameters:
getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQS.
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 GetQueueUrl service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

removePermissionAsync

public Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest,
                                          AsyncHandler<RemovePermissionRequest,Void> asyncHandler)
                                   throws AmazonServiceException,
                                          AmazonClientException
Specified by:
removePermissionAsync in interface AmazonSQSAsync
Parameters:
removePermissionRequest - Container for the necessary parameters to execute the RemovePermission operation on AmazonSQS.
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 RemovePermission service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

getQueueAttributesAsync

public Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest,
                                                                AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
                                                         throws AmazonServiceException,
                                                                AmazonClientException
Specified by:
getQueueAttributesAsync in interface AmazonSQSAsync
Parameters:
getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQS.
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 GetQueueAttributes service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

sendMessageBatchAsync

public Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest,
                                                            AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
                                                     throws AmazonServiceException,
                                                            AmazonClientException
Specified by:
sendMessageBatchAsync in interface AmazonSQSAsync
Parameters:
sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQS.
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 SendMessageBatch service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteQueueAsync

public Future<Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest,
                                     AsyncHandler<DeleteQueueRequest,Void> asyncHandler)
                              throws AmazonServiceException,
                                     AmazonClientException
Specified by:
deleteQueueAsync in interface AmazonSQSAsync
Parameters:
deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQS.
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 DeleteQueue service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

listQueuesAsync

public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest,
                                                AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
                                         throws AmazonServiceException,
                                                AmazonClientException
Specified by:
listQueuesAsync in interface AmazonSQSAsync
Parameters:
listQueuesRequest - Container for the necessary parameters to execute the ListQueues operation on AmazonSQS.
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 ListQueues service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

deleteMessageBatchAsync

public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest,
                                                                AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
                                                         throws AmazonServiceException,
                                                                AmazonClientException
Specified by:
deleteMessageBatchAsync in interface AmazonSQSAsync
Parameters:
deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQS.
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 DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

createQueueAsync

public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest,
                                                  AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException
Specified by:
createQueueAsync in interface AmazonSQSAsync
Parameters:
createQueueRequest - Container for the necessary parameters to execute the CreateQueue operation on AmazonSQS.
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 CreateQueue service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.

addPermissionAsync

public Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest,
                                       AsyncHandler<AddPermissionRequest,Void> asyncHandler)
                                throws AmazonServiceException,
                                       AmazonClientException
Specified by:
addPermissionAsync in interface AmazonSQSAsync
Parameters:
addPermissionRequest - Container for the necessary parameters to execute the AddPermission operation on AmazonSQS.
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 AddPermission service method, as returned by AmazonSQS.
Throws:
AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
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.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.