com.agorapulse.micronaut.aws.sqs

Interface SimpleQueueService

public interface SimpleQueueService

Amazon SQS services

See Also:

SimpleQueueServiceConfiguration

Method Summary

Modifier and Type	Method and Description
java.lang.String	createQueue(QueueConfiguration queueConfiguration)
java.lang.String	createQueue(java.lang.String queueName) Creates new queue with given name.
default void	deleteMessage(java.lang.String receiptHandle) Deletes message from the default queue.
void	deleteMessage(java.lang.String queueName, java.lang.String receiptHandle) Deletes message from the queue.
void	deleteQueue(java.lang.String queueName) Deletes queue by name.
java.lang.String	getDefaultQueueName()
default java.lang.String	getQueueArn()
java.lang.String	getQueueArn(java.lang.String queueName)
default java.util.Map<java.lang.String,java.lang.String>	getQueueAttributes()
java.util.Map<java.lang.String,java.lang.String>	getQueueAttributes(java.lang.String queueName)
default java.lang.String	getQueueUrl()
java.lang.String	getQueueUrl(java.lang.String queueName)
boolean	isCaching()
default java.util.List<java.lang.String>	listQueueNames()
java.util.List<java.lang.String>	listQueueNames(boolean reload)
default java.util.List<java.lang.String>	listQueueUrls()
java.util.List<java.lang.String>	listQueueUrls(boolean reload)
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages()
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(int maxNumberOfMessages)
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(int maxNumberOfMessages, int visibilityTimeout)
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(int maxNumberOfMessages, int visibilityTimeout, int waitTimeSeconds)
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(java.lang.String queueName)
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(java.lang.String queueName, int maxNumberOfMessages)
default java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(java.lang.String queueName, int maxNumberOfMessages, int visibilityTimeout)
java.util.List<com.amazonaws.services.sqs.model.Message>	receiveMessages(java.lang.String queueName, int maxNumberOfMessages, int visibilityTimeout, int waitTimeSeconds)
default java.lang.String	sendMessage(java.lang.String messageBody) Send message in default queue immediately
default java.lang.String	sendMessage(java.lang.String messageBody, groovy.lang.Closure messageConfiguration) Sends message with additional configuration into the default queue.
default java.lang.String	sendMessage(java.lang.String messageBody, java.util.function.Consumer<com.amazonaws.services.sqs.model.SendMessageRequest> messageConfiguration) Sends message with additional configuration into the default queue.
default java.lang.String	sendMessage(java.lang.String messageBody, int delaySeconds) Send message in the default queue with given delay.
default java.lang.String	sendMessage(java.lang.String messageBody, int delaySeconds, java.lang.String groupId) Send message with given delay.
default java.lang.String	sendMessage(java.lang.String queueName, java.lang.String messageBody) Send message immediately
default java.lang.String	sendMessage(java.lang.String queueName, java.lang.String messageBody, groovy.lang.Closure messageConfiguration) Sends message with additional configuration into the given queue.
java.lang.String	sendMessage(java.lang.String queueName, java.lang.String messageBody, java.util.function.Consumer<com.amazonaws.services.sqs.model.SendMessageRequest> messageConfiguration) Sends message with additional configuration into the given queue.
default java.lang.String	sendMessage(java.lang.String queueName, java.lang.String messageBody, int delaySeconds) Send message with given delay.
java.lang.String	sendMessage(java.lang.String queueName, java.lang.String messageBody, int delaySeconds, java.lang.String groupId) Send message with given delay.

Method Detail

getDefaultQueueName

java.lang.String getDefaultQueueName()

Returns:

the default queue name from the configuration

Throws:

java.lang.AssertionError - if the default queue name is not set (aws.sqs.queue configuration value)

isCaching

boolean isCaching()

Returns:

true if the service is caching queues urls, useful for longer running applications

createQueue

java.lang.String createQueue(QueueConfiguration queueConfiguration)

createQueue

java.lang.String createQueue(java.lang.String queueName)

Creates new queue with given name.

Parameters:

queueName - the queue name

Returns:

url of the new queue

deleteMessage

void deleteMessage(java.lang.String queueName,
                   java.lang.String receiptHandle)

Deletes message from the queue.

Parameters:

queueName - the queue name

receiptHandle - message id

deleteMessage

default void deleteMessage(java.lang.String receiptHandle)

Deletes message from the default queue.

Parameters:

receiptHandle - message id

deleteQueue

void deleteQueue(java.lang.String queueName)

Deletes queue by name.

Parameters:

queueName - the name of the queue

getQueueAttributes

java.util.Map<java.lang.String,java.lang.String> getQueueAttributes(java.lang.String queueName)

Parameters:

queueName - the name of the queue

Returns:

the attributes of the queue

getQueueAttributes

default java.util.Map<java.lang.String,java.lang.String> getQueueAttributes()

Returns:

the attributes of the default queue

getQueueUrl

java.lang.String getQueueUrl(java.lang.String queueName)

Parameters:

queueName - the queue name

Returns:

the queue url

getQueueUrl

default java.lang.String getQueueUrl()

Returns:

the default queue url

getQueueArn

java.lang.String getQueueArn(java.lang.String queueName)

Parameters:

queueName - the queue name

Returns:

the queue arn

getQueueArn

default java.lang.String getQueueArn()

Returns:

the default queue arn

listQueueNames

default java.util.List<java.lang.String> listQueueNames()

Returns:

list of all queues' names

listQueueNames

java.util.List<java.lang.String> listQueueNames(boolean reload)

Parameters:

reload - whether to reload the list of the queue

Returns:

the list of all queues' names

listQueueUrls

default java.util.List<java.lang.String> listQueueUrls()

Returns:

the list of all queues' urls

listQueueUrls

java.util.List<java.lang.String> listQueueUrls(boolean reload)

Parameters:

reload - whether to reload the list of the queue

Returns:

the list of all queues' urls

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(java.lang.String queueName,
                                                                                 int maxNumberOfMessages,
                                                                                 int visibilityTimeout)

Parameters:

queueName - the queue name

maxNumberOfMessages - the maximum number of messages to retrieve

visibilityTimeout - the visibility timeout of the messages

Returns:

the list of received messages from the given queue

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(java.lang.String queueName,
                                                                                 int maxNumberOfMessages)

Parameters:

queueName - the queue name

maxNumberOfMessages - the maximum number of messages to retrieve

Returns:

the list of received messages from the given queue

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(java.lang.String queueName)

Parameters:

queueName - the queue name

Returns:

the list of received messages from the given queue

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(int maxNumberOfMessages,
                                                                                 int visibilityTimeout,
                                                                                 int waitTimeSeconds)

Parameters:

maxNumberOfMessages - the maximum number of messages to retrieve

visibilityTimeout - the visibility timeout of the messages

waitTimeSeconds - the time to wait for the messages to arrive

Returns:

the list of received messages from the default queue

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(int maxNumberOfMessages,
                                                                                 int visibilityTimeout)

Parameters:

maxNumberOfMessages - the maximum number of messages to retrieve

visibilityTimeout - the visibility timeout of the messages

Returns:

the list of received messages from the default queue

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(int maxNumberOfMessages)

Parameters:

maxNumberOfMessages - the maximum number of messages to retrieve

Returns:

the list of received messages from the default queue

receiveMessages

default java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages()

Returns:

the list of received messages from the default queue

receiveMessages

java.util.List<com.amazonaws.services.sqs.model.Message> receiveMessages(java.lang.String queueName,
                                                                         int maxNumberOfMessages,
                                                                         int visibilityTimeout,
                                                                         int waitTimeSeconds)

Parameters:

queueName - the queue name

maxNumberOfMessages - the maximum number of messages to retrieve

visibilityTimeout - the visibility timeout of the messages

waitTimeSeconds - the time to wait for the messages to arrive

Returns:

the list of received messages from the given queue

sendMessage

default java.lang.String sendMessage(java.lang.String queueName,
                                     java.lang.String messageBody)

Send message immediately

Parameters:

queueName - the name of the queue

messageBody - the body of the message

Returns:

the message id of the message sent

sendMessage

java.lang.String sendMessage(java.lang.String queueName,
                             java.lang.String messageBody,
                             int delaySeconds,
                             java.lang.String groupId)

Send message with given delay.

Parameters:

queueName - the name of the queue

messageBody - the body of the message

delaySeconds - the delay in seconds

groupId - group id for FIFO queues

Returns:

the message id of the message sent

sendMessage

default java.lang.String sendMessage(java.lang.String queueName,
                                     java.lang.String messageBody,
                                     int delaySeconds)

Send message with given delay.

Parameters:

queueName - the name of the queue

messageBody - the body of the message

delaySeconds - the delay in seconds

Returns:

the message id of the message sent

sendMessage

default java.lang.String sendMessage(java.lang.String messageBody)

Send message in default queue immediately

Parameters:

messageBody - the body of the message

Returns:

the message id of the message sent

sendMessage

default java.lang.String sendMessage(java.lang.String messageBody,
                                     int delaySeconds)

Send message in the default queue with given delay.

Parameters:

messageBody - the body of the message

delaySeconds - the delay in seconds

Returns:

the message id of the message sent

sendMessage

default java.lang.String sendMessage(java.lang.String messageBody,
                                     int delaySeconds,
                                     java.lang.String groupId)

Send message with given delay.

Parameters:

messageBody - the body of the message

delaySeconds - the delay in seconds

groupId - group id for FIFO queues

Returns:

the message id of the message sent

sendMessage

default java.lang.String sendMessage(java.lang.String messageBody,
                                     java.util.function.Consumer<com.amazonaws.services.sqs.model.SendMessageRequest> messageConfiguration)

Sends message with additional configuration into the default queue.

Parameters:

messageBody - message body

messageConfiguration - additional configuration

Returns:

message id

sendMessage

default java.lang.String sendMessage(java.lang.String messageBody,
                                     @DelegatesTo(value=com.amazonaws.services.sqs.model.SendMessageRequest.class,strategy=1)
                                     groovy.lang.Closure messageConfiguration)

Sends message with additional configuration into the default queue.

Parameters:

messageBody - message body

messageConfiguration - additional configuration

Returns:

message id

sendMessage

default java.lang.String sendMessage(java.lang.String queueName,
                                     java.lang.String messageBody,
                                     @DelegatesTo(value=com.amazonaws.services.sqs.model.SendMessageRequest.class,strategy=1)
                                     groovy.lang.Closure messageConfiguration)

Sends message with additional configuration into the given queue.

Parameters:

queueName - name of the queue

messageBody - message body

messageConfiguration - additional configuration

Returns:

message id

sendMessage

java.lang.String sendMessage(java.lang.String queueName,
                             java.lang.String messageBody,
                             java.util.function.Consumer<com.amazonaws.services.sqs.model.SendMessageRequest> messageConfiguration)

Sends message with additional configuration into the given queue.

Parameters:

queueName - name of the queue

messageBody - message body

messageConfiguration - additional configuration

Returns:

message id