com.amazon.sqs.javamessaging

Class AmazonSQSMessagingClientWrapper

java.lang.Object

com.amazon.sqs.javamessaging.AmazonSQSMessagingClientWrapper

public class AmazonSQSMessagingClientWrapper
extends java.lang.Object

This is a JMS Wrapper of AmazonSQSClient. This class changes all AmazonServiceException and AmazonClientException into JMSException/JMSSecurityException.

Constructor Summary

Constructors

Constructor and Description
AmazonSQSMessagingClientWrapper(AmazonSQS amazonSQSClient)

Method Summary

Methods

Modifier and Type	Method and Description
void	changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest) Calls changeMessageVisibility and wraps AmazonClientException.
ChangeMessageVisibilityBatchResult	changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) Calls changeMessageVisibilityBatch and wraps AmazonClientException.
CreateQueueResult	createQueue(CreateQueueRequest createQueueRequest) Calls createQueue to create the queue with the provided queue attributes if any, and wraps AmazonClientException
CreateQueueResult	createQueue(java.lang.String queueName) Calls createQueue to create the queue with the default queue attributes, and wraps AmazonClientException
void	deleteMessage(DeleteMessageRequest deleteMessageRequest) Calls deleteMessage and wraps AmazonClientException.
DeleteMessageBatchResult	deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest) Calls deleteMessageBatch and wraps AmazonClientException.
AmazonSQS	getAmazonSQSClient() If one uses any other AWS SDK operations other than explicitly listed here, the exceptions thrown by those operations will not be wrapped as JMSException.
GetQueueUrlResult	getQueueUrl(GetQueueUrlRequest getQueueUrlRequest) Calls getQueueUrl and wraps AmazonClientException
GetQueueUrlResult	getQueueUrl(java.lang.String queueName) Gets the queueUrl of a queue given a queue name.
GetQueueUrlResult	getQueueUrl(java.lang.String queueName, java.lang.String queueOwnerAccountId) Gets the queueUrl of a queue given a queue name owned by the provided accountId.
boolean	queueExists(java.lang.String queueName) Check if the requested queue exists.
boolean	queueExists(java.lang.String queueName, java.lang.String queueOwnerAccountId) Check if the requested queue exists.
ReceiveMessageResult	receiveMessage(ReceiveMessageRequest receiveMessageRequest) Calls receiveMessage and wraps AmazonClientException.
SendMessageResult	sendMessage(SendMessageRequest sendMessageRequest) Calls sendMessage and wraps AmazonClientException.
void	setEndpoint(java.lang.String endpoint) Sets SQS endpoint and wraps IllegalArgumentException.
void	setRegion(Region region) Sets SQS region and wraps IllegalArgumentException.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonSQSMessagingClientWrapper

public AmazonSQSMessagingClientWrapper(AmazonSQS amazonSQSClient)
                                throws JMSException

Parameters:

amazonSQSClient - The AWS SDK Client for SQS.

Throws:

JMSException - if the client is null

Method Detail

getAmazonSQSClient

public AmazonSQS getAmazonSQSClient()

If one uses any other AWS SDK operations other than explicitly listed here, the exceptions thrown by those operations will not be wrapped as JMSException.

Returns:

amazonSQSClient

setEndpoint

public void setEndpoint(java.lang.String endpoint)
                 throws JMSException

Sets SQS endpoint and wraps IllegalArgumentException.

Parameters:

endpoint - The endpoint (ex: "sqs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

JMSException

setRegion

public void setRegion(Region region)
               throws JMSException

Sets SQS region and wraps IllegalArgumentException. This is the recommend way to set-up the SQS end-points.

Parameters:

region - The region this client will communicate with. See Region#getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

JMSException

deleteMessage

public void deleteMessage(DeleteMessageRequest deleteMessageRequest)
                   throws JMSException

Calls deleteMessage and wraps AmazonClientException. This is used to acknowledge single messages, so that they can be deleted from SQS queue.

Parameters:

deleteMessageRequest - Container for the necessary parameters to execute the deleteMessage service method on AmazonSQS.

Throws:

JMSException

deleteMessageBatch

public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                            throws JMSException

Calls deleteMessageBatch and wraps AmazonClientException. This is used to acknowledge multiple messages on client_acknowledge mode, so that they can be deleted from SQS queue.

Parameters:

deleteMessageBatchRequest - Container for the necessary parameters to execute the deleteMessageBatch service method on AmazonSQS. This is the batch version of deleteMessage. Max batch size is 10.

Returns:

The response from the deleteMessageBatch service method, as returned by AmazonSQS

Throws:

JMSException

sendMessage

public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                              throws JMSException

Calls sendMessage and wraps AmazonClientException.

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:

JMSException

queueExists

public boolean queueExists(java.lang.String queueName)
                    throws JMSException

Check if the requested queue exists. This function calls GetQueueUrl for the given queue name, returning true on success, false if it gets QueueDoesNotExistException.

Parameters:

queueName - the queue to check

Returns:

true if the queue exists, false if it doesn't.

Throws:

JMSException

queueExists

public boolean queueExists(java.lang.String queueName,
                  java.lang.String queueOwnerAccountId)
                    throws JMSException

Check if the requested queue exists. This function calls GetQueueUrl for the given queue name with the given owner accountId, returning true on success, false if it gets QueueDoesNotExistException.

Parameters:

queueName - the queue to check

queueOwnerAccountId - The AWS accountId of the account that created the queue

Returns:

true if the queue exists, false if it doesn't.

Throws:

JMSException

getQueueUrl

public GetQueueUrlResult getQueueUrl(java.lang.String queueName)
                              throws JMSException

Gets the queueUrl of a queue given a queue name.

Parameters:

queueName -

Returns:

The response from the GetQueueUrl service method, as returned by AmazonSQS, which will include queue`s URL

Throws:

JMSException

getQueueUrl

public GetQueueUrlResult getQueueUrl(java.lang.String queueName,
                            java.lang.String queueOwnerAccountId)
                              throws JMSException

Gets the queueUrl of a queue given a queue name owned by the provided accountId.

Parameters:

queueName -

queueOwnerAccountId - The AWS accountId of the account that created the queue

Returns:

The response from the GetQueueUrl service method, as returned by AmazonSQS, which will include queue`s URL

Throws:

JMSException

getQueueUrl

public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
                              throws JMSException

Calls getQueueUrl and wraps AmazonClientException

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, which will include queue`s URL

Throws:

JMSException

createQueue

public CreateQueueResult createQueue(java.lang.String queueName)
                              throws JMSException

Calls createQueue to create the queue with the default queue attributes, and wraps AmazonClientException

Parameters:

queueName -

Returns:

The response from the createQueue service method, as returned by AmazonSQS. This call creates a new queue, or returns the URL of an existing one.

Throws:

JMSException

createQueue

public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
                              throws JMSException

Calls createQueue to create the queue with the provided queue attributes if any, and wraps AmazonClientException

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. This call creates a new queue, or returns the URL of an existing one.

Throws:

JMSException

receiveMessage

public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                    throws JMSException

Calls receiveMessage and wraps AmazonClientException. Used by SQSMessageConsumerPrefetch to receive up to minimum of (numberOfMessagesToPrefetch,10) messages from SQS queue into consumer prefetch buffers.

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:

JMSException

changeMessageVisibility

public void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                             throws JMSException

Calls changeMessageVisibility and wraps AmazonClientException. This is used to for negative acknowledge of a single message, so that messages can be received again without any delay.

Parameters:

changeMessageVisibilityRequest - Container for the necessary parameters to execute the changeMessageVisibility service method on AmazonSQS.

Throws:

JMSException

changeMessageVisibilityBatch

public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                throws JMSException

Calls changeMessageVisibilityBatch and wraps AmazonClientException. This is used to for negative acknowledge of messages in batch, so that messages can be received again without any delay.

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:

JMSException