org.mule.modules.sqs

Class SQSConnector

java.lang.Object

org.mule.modules.sqs.SQSConnector

@RequiresEnterpriseLicense(allowEval=true)
@Connector(name="sqs",
           friendlyName="Amazon SQS")
public class SQSConnector
extends Object

Amazon Simple Queue Service (Amazon SQS) is a distributed queue messaging service introduced by Amazon.com in April of 2006. It supports programmatic sending of messages via web service applications as a way to communicate over the internet. The intent of SQS is to provide a highly scalable hosted message queue that resolves issues arising from the common producer-consumer problem or connectivity between producer and consumer.

Author:

MuleSoft, Inc.

Constructor Summary

Constructors

Constructor and Description
SQSConnector()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermission(String label, List<String> accountIds, List<String> actions, String queueUrl) Adds a permission to this message queue.
void	changeMessageVisibility(String receiptHandle, Integer visibilityTimeout, String queueUrl) Changes the visibility timeout of a specified message in a queue to a new value.
ChangeMessageVisibilityBatchResult	changeMessageVisibilityBatch(List<ChangeMessageVisibilityBatchRequestEntry> receiptHandles, String queueUrl) Changes the visibility timeout of multiple messages.
CreateQueueResult	createQueue(String queueName, RegionEndpoint region, Map<String,String> attributes) Creates a new queue, or returns the URL of an existing one.
void	deleteMessage(String receiptHandle, String queueUrl) Deletes the message identified by message object on the queue this object represents.
DeleteMessageBatchResult	deleteMessageBatch(List<DeleteMessageBatchRequestEntry> receiptHandles, String queueUrl) Deletes up to ten messages from the specified queue.
void	deleteQueue(String queueUrl) Deletes the message queue represented by this object.
int	getApproximateNumberOfMessages(String queueUrl) Gets an approximate number of visible messages for a queue.
Config	getConfig()
GetQueueAttributesResult	getQueueAttributes(List<String> attributeNames, String queueUrl) Gets queue attributes.
GetQueueUrlResult	getQueueUrl(String queueName, String queueOwnerAWSAccountId) Returns the URL of an existing queue.
ListDeadLetterSourceQueuesResult	listDeadLetterSourceQueues(String queueUrl) Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
ListQueuesResult	listQueues(String queueNamePrefix) Returns a list of your queues.
void	purgeQueue(String queueUrl) Deletes the messages in a queue specified by the queue URL.
void	receiveMessages(org.mule.api.callback.SourceCallback callback, Integer visibilityTimeout, Boolean preserveMessages, Integer numberOfMessages, String queueUrl) Attempts to receive messages from a queue.
void	removePermission(String label, String queueUrl) Removes a permission from this message queue.
SendMessageResult	sendMessage(Message message, String queueUrl) Sends a message to a specified queue.
SendMessageBatchResult	sendMessageBatch(List<SendMessageBatchRequestEntry> messages, String queueUrl) Delivers up to ten messages to the specified queue.
void	setConfig(Config config)
void	setQueueAttributes(Map<String,String> attributes, String queueUrl) Sets the value of one or more queue attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQSConnector

public SQSConnector()

Method Detail

addPermission

@Processor
public void addPermission(@NotNull
                           String label,
                           @NotNull
                           List<String> accountIds,
                           @NotNull
                           List<String> actions,
                           @Optional
                           String queueUrl)
                   throws SQSConnectorException

Adds a permission to this message queue.

Parameters:

label - a name for this permission

accountIds - the AWS account ID's for the account to share this queue with

actions - a list to indicate how much to share (SendMessage, ReceiveMessage, ChangeMessageVisibility, DeleteMessage, GetQueueAttributes)

queueUrl - Permissions will be added to the queue represented by this URL.

Throws:

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

changeMessageVisibility

@Processor
public void changeMessageVisibility(@Default(value="#[header:inbound:sqs.message.receipt.handle]")
                                     String receiptHandle,
                                     @NotNull
                                     Integer visibilityTimeout,
                                     @Optional
                                     String queueUrl)
                             throws SQSConnectorException

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.

Parameters:

receiptHandle - The receipt handle associated with the message whose visibility timeout should be changed.

visibilityTimeout - The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.

queueUrl - The URL of the Amazon SQS queue to take action on.

Throws:

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

changeMessageVisibilityBatch

@Processor
public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(@Default(value="#[payload]")
                                                                        List<ChangeMessageVisibilityBatchRequestEntry> receiptHandles,
                                                                        @Optional
                                                                        String queueUrl)
                                                                throws SQSConnectorException

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

Parameters:

receiptHandles - A list of receipt handles of the messages for which the visibility timeout must be changed.

queueUrl - The URL of the Amazon SQS queue to take action on.

Returns:

ChangeMessageVisibilityBatchResult list items.

Throws:

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

createQueue

@Processor
public CreateQueueResult createQueue(@NotNull
                                      String queueName,
                                      @Optional
                                      RegionEndpoint region,
                                      @Default(value="#[payload]")
                                      Map<String,String> attributes)
                              throws SQSConnectorException

Creates a new queue, or returns the URL of an existing one.

Parameters:

queueName - The name for the queue to be created.

region - The region in which the queue to be created.

attributes - A map of attributes with their corresponding values. Valid Map Keys: Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy

Returns:

CreateQueueResult object containing the URL of the created Amazon SQS queue.

Throws:

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

deleteMessage

@Processor
public void deleteMessage(@Default(value="#[header:inbound:sqs.message.receipt.handle]")
                           String receiptHandle,
                           @Optional
                           String queueUrl)
                   throws SQSConnectorException

Deletes the message identified by message object on the queue this object represents.

Parameters:

receiptHandle - Receipt handle of the message to be deleted

queueUrl - The URL of the queue to delete messages from

Throws:

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

deleteMessageBatch

@Processor
public DeleteMessageBatchResult deleteMessageBatch(@Default(value="#[payload]")
                                                    List<DeleteMessageBatchRequestEntry> receiptHandles,
                                                    @Optional
                                                    String queueUrl)
                                            throws SQSConnectorException

Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage.

Parameters:

receiptHandles - A list of receipt handles for the messages to be deleted.

queueUrl - The URL of the queue to delete messages as a batch from.

Returns:

DeleteMessageBatchResult

Throws:

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

deleteQueue

@Processor
public void deleteQueue(@Optional
                         String queueUrl)
                 throws SQSConnectorException

Deletes the message queue represented by this object. Will delete non-empty queue.

Parameters:

queueUrl - The URL of the queue to delete.

Throws:

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

getQueueAttributes

@Processor
public GetQueueAttributesResult getQueueAttributes(@Default(value="#[payload]")
                                                    List<String> attributeNames,
                                                    @Optional
                                                    String queueUrl)
                                            throws SQSConnectorException

Gets queue attributes. This is provided to expose the underlying functionality.

Parameters:

attributeNames - A list of attribute retrieve information for.

queueUrl - The URL of the Amazon SQS queue to take action on.

Returns:

GetQueueAttributesResult object map containing attributes and their values

Throws:

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

getQueueUrl

@Processor
public GetQueueUrlResult getQueueUrl(@NotNull
                                      String queueName,
                                      @Optional
                                      String queueOwnerAWSAccountId)
                              throws SQSConnectorException

Returns the URL of an existing queue.

Parameters:

queueName - The name of the queue whose URL must be fetched.

queueOwnerAWSAccountId - The AWS account ID of the owner that created the queue.

Returns:

GetQueueUrlResult object containing the generated queue service url

Throws:

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

listDeadLetterSourceQueues

@Processor
public ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(@Optional
                                                                    String queueUrl)
                                                            throws SQSConnectorException

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

Parameters:

queueUrl - The queue URL of a dead letter queue.

Returns:

ListDeadLetterSourceQueuesResult object containing a list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.

Throws:

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

listQueues

@Processor
public ListQueuesResult listQueues(@Optional
                                    String queueNamePrefix)
                            throws SQSConnectorException

Returns a list of your queues. The maximum number of queues that can be returned is 1000.

Parameters:

queueNamePrefix - A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Returns:

ListQueuesResult object containing list of queue URLs.

Throws:

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

purgeQueue

@Processor
public void purgeQueue(@Optional
                        String queueUrl)
                throws SQSConnectorException

Deletes the messages in a queue specified by the queue URL.

Parameters:

queueUrl - the queue URL where messages are to be fetched from.

Throws:

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

receiveMessages

@Source(sourceStrategy=POLLING,
        pollingPeriod=5000L)
@ReconnectOn(exceptions=SQSConnectionException.class)
public void receiveMessages(org.mule.api.callback.SourceCallback callback,
                                                                  @Default(value="30")
                                                                  Integer visibilityTimeout,
                                                                  @Default(value="false")
                                                                  Boolean preserveMessages,
                                                                  @Default(value="1")
                                                                  Integer numberOfMessages,
                                                                  @Optional
                                                                  String queueUrl)
                     throws SQSConnectorException,
                            org.mule.api.MessagingException

Attempts to receive messages from a queue. Every attribute of the incoming messages will be added as inbound properties. Also the following properties will also be added:

sqs.message.id = containing the message identification sqs.message.receipt.handle = containing the message identification

Parameters:

callback - Callback to call when new messages are available.

visibilityTimeout - the duration (in seconds) the retrieved messages are hidden from subsequent calls to retrieve.

preserveMessages - Flag that indicates if you want to preserve the messages in the queue. False by default, so the messages are going to be deleted.

numberOfMessages - the number of messages to be retrieved on each call (10 messages max). By default, 1 message will be retrieved.

queueUrl - the queue URL where messages are to be fetched from.

Throws:

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

SQSConnectionException

org.mule.api.MessagingException

removePermission

@Processor
public void removePermission(@NotNull
                              String label,
                              @Optional
                              String queueUrl)
                      throws SQSConnectorException

Removes a permission from this message queue.

Parameters:

label - a name for the permission to be removed

queueUrl - Permissions will be deleted from the queue represented by this URL.

Throws:

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

sendMessage

@Processor
public SendMessageResult sendMessage(@Default(value="#[payload]")
                                      Message message,
                                      @Optional
                                      String queueUrl)
                              throws SQSConnectorException

Sends a message to a specified queue. The message must be between 1 and 256K bytes long.

Parameters:

message - Container for the parameters to the sendmessage operation.

queueUrl - the queue where the message is to be sent.

Returns:

The queue response of the sent message.

Throws:

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

sendMessageBatch

@Processor
public SendMessageBatchResult sendMessageBatch(@Default(value="#[payload]")
                                                List<SendMessageBatchRequestEntry> messages,
                                                @Optional
                                                String queueUrl)
                                        throws SQSConnectorException

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage

Parameters:

queueUrl - the queue where the message is to be sent.

messages - A list of SendMessageBatchRequestEntry items.

Returns:

SendMessageBatchResult list items.

Throws:

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

setQueueAttributes

@Processor
public void setQueueAttributes(@Default(value="#[payload]")
                                Map<String,String> attributes,
                                @Optional
                                String queueUrl)
                        throws SQSConnectorException

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

Parameters:

attributes - A map of attributes to set.

queueUrl - The URL of the queue.

Throws:

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

getApproximateNumberOfMessages

@Processor
public int getApproximateNumberOfMessages(@Optional
                                           String queueUrl)
                                   throws SQSConnectorException

Gets an approximate number of visible messages for a queue.

Parameters:

queueUrl - The URL of the queue

Returns:

the approximate number of messages in the queue

Throws:

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

getConfig

@NotNull
public Config getConfig()

setConfig

public void setConfig(@NotNull
             Config config)