Package io.awspring.cloud.sqs.operations

Class SqsTemplate

java.lang.Object

io.awspring.cloud.sqs.operations.AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

io.awspring.cloud.sqs.operations.SqsTemplate

All Implemented Interfaces:

AsyncMessagingOperations, MessagingOperations, SqsAsyncOperations, SqsOperations

public class SqsTemplate
extends AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>
implements SqsOperations, SqsAsyncOperations

Sqs-specific implementation of AbstractMessagingTemplate

Since:

3.0

Author:

Tomaz Fernandes, Zhong Xi Lu

Nested Class Summary

Nested classes/interfaces inherited from class io.awspring.cloud.sqs.operations.AbstractMessagingTemplate

AbstractMessagingTemplate.AbstractMessagingTemplateOptions<O extends MessagingTemplateOptions<O>>

Method Summary

Modifier and Type	Method	Description
static SqsTemplateBuilder	builder()	Create a new SqsTemplateBuilder.
protected CompletableFuture<Void>	doAcknowledgeMessages(String endpointName, Collection<Message<?>> messages)
protected CompletableFuture<Collection<software.amazon.awssdk.services.sqs.model.Message>>	doReceiveAsync(String endpointName, Duration pollTimeout, Integer maxNumberOfMessages, Map<String,Object> additionalHeaders)
protected <T> CompletableFuture<SendResult<T>>	doSendAsync(String endpointName, software.amazon.awssdk.services.sqs.model.Message message, Message<T> originalMessage)
protected <T> CompletableFuture<SendResult.Batch<T>>	doSendBatchAsync(String endpointName, Collection<software.amazon.awssdk.services.sqs.model.Message> messages, Collection<Message<T>> originalMessages)
protected <T> MessageConversionContext	getReceiveMessageConversionContext(String endpointName, Class<T> payloadClass)
protected Map<String,Object>	handleAdditionalHeaders(Map<String,Object> additionalHeaders)
static SqsAsyncOperations	newAsyncTemplate(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)	Create a new SqsTemplate instance with the provided SqsAsyncClient, only exposing the async methods contained in SqsAsyncOperations.
static SqsOperations	newSyncTemplate(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)	Create a new SqsTemplate instance with the provided SqsAsyncClient, only exposing the sync methods contained in SqsOperations.
static SqsTemplate	newTemplate(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)	Create a new SqsTemplate instance with the provided SqsAsyncClient and both sync and async operations.
protected Map<String,Object>	preProcessHeadersForReceive(String endpointToUse, Map<String,Object> headers)
protected <T> Message<T>	preProcessMessageForSend(String endpointToUse, Message<T> message)
protected <T> CompletableFuture<Message<T>>	preProcessMessageForSendAsync(String endpointToUse, Message<T> message)
protected <T> Collection<Message<T>>	preProcessMessagesForSend(String endpointToUse, Collection<Message<T>> messages)
protected <T> CompletableFuture<Collection<Message<T>>>	preProcessMessagesForSendAsync(String endpointToUse, Collection<Message<T>> messages)
Optional<Message<?>>	receive(Consumer<SqsReceiveOptions> from)	Receive a message using SqsReceiveOptions.
<T> Optional<Message<T>>	receive(Consumer<SqsReceiveOptions> from, Class<T> payloadClass)	Receive a message using SqsReceiveOptions and convert the payload to the provided class.
CompletableFuture<Optional<Message<?>>>	receiveAsync(Consumer<SqsReceiveOptions> from)	Receive a message using the SqsReceiveOptions options.
<T> CompletableFuture<Optional<Message<T>>>	receiveAsync(Consumer<SqsReceiveOptions> from, Class<T> payloadClass)	Receive a message using the SqsReceiveOptions options and convert the payload to the provided class.
Collection<Message<?>>	receiveMany(Consumer<SqsReceiveOptions> from)	Receive a batch of messages using SqsReceiveOptions.
<T> Collection<Message<T>>	receiveMany(Consumer<SqsReceiveOptions> from, Class<T> payloadClass)	Receive a batch of messages using SqsReceiveOptions and convert the payloads to the provided class.
CompletableFuture<Collection<Message<?>>>	receiveManyAsync(Consumer<SqsReceiveOptions> from)	Receive a batch of messages using the SqsReceiveOptions options.
<T> CompletableFuture<Collection<Message<T>>>	receiveManyAsync(Consumer<SqsReceiveOptions> from, Class<T> payloadClass)	Receive a batch of messages using the SqsReceiveOptions options and convert the payloads to the provided class.
<T> SendResult<T>	send(Consumer<SqsSendOptions<T>> to)	Send a message using the SqsSendOptions options.
<T> CompletableFuture<SendResult<T>>	sendAsync(Consumer<SqsSendOptions<T>> to)	Send a message using SqsSendOptions.

Methods inherited from class io.awspring.cloud.sqs.operations.AbstractMessagingTemplate

addAdditionalHeaders, addTypeToMessages, castFromCollection, castFromOptional, getSendMessageConversionContext, receive, receive, receiveAsync, receiveAsync, receiveAsync, receiveMany, receiveMany, receiveManyAsync, receiveManyAsync, receiveManyAsync, send, send, send, sendAsync, sendAsync, sendAsync, sendMany, sendManyAsync, unwrapCompletionException

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.awspring.cloud.sqs.operations.AsyncMessagingOperations

receiveAsync, receiveAsync, receiveManyAsync, receiveManyAsync, sendAsync, sendAsync, sendAsync, sendManyAsync

Methods inherited from interface io.awspring.cloud.sqs.operations.MessagingOperations

receive, receive, receiveMany, receiveMany, send, send, send, sendMany

Method Details

builder

public static SqsTemplateBuilder builder()

Create a new SqsTemplateBuilder.

Returns:

the builder.

newTemplate

public static SqsTemplate newTemplate(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)

Create a new SqsTemplate instance with the provided SqsAsyncClient and both sync and async operations.

Parameters:

sqsAsyncClient - the client to be used by the template.

Returns:

the SqsTemplate instance.

newSyncTemplate

public static SqsOperations newSyncTemplate(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)

Create a new SqsTemplate instance with the provided SqsAsyncClient, only exposing the sync methods contained in SqsOperations.

Parameters:

sqsAsyncClient - the client.

Returns:

the new template instance.

newAsyncTemplate

public static SqsAsyncOperations newAsyncTemplate(software.amazon.awssdk.services.sqs.SqsAsyncClient sqsAsyncClient)

Create a new SqsTemplate instance with the provided SqsAsyncClient, only exposing the async methods contained in SqsAsyncOperations.

Parameters:

sqsAsyncClient - the client.

Returns:

the new template instance.

send

public <T> SendResult<T> send(Consumer<SqsSendOptions<T>> to)

Description copied from interface: SqsOperations

Send a message using the SqsSendOptions options.

Specified by:

send in interface SqsOperations

Parameters:

to - a SqsSendOptions consumer.

Returns:

The UUID of the message.

sendAsync

public <T> CompletableFuture<SendResult<T>> sendAsync(Consumer<SqsSendOptions<T>> to)

Description copied from interface: SqsAsyncOperations

Send a message using SqsSendOptions.

Specified by:

sendAsync in interface SqsAsyncOperations

Parameters:

to - a SqsSendOptions consumer.

Returns:

a CompletableFuture to be completed with the UUID of the message.

receive

public Optional<Message<?>> receive(Consumer<SqsReceiveOptions> from)

Description copied from interface: SqsOperations

Receive a message using SqsReceiveOptions.

Specified by:

receive in interface SqsOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

The message, or an empty collection if none is returned.

receive

public <T> Optional<Message<T>> receive(Consumer<SqsReceiveOptions> from,
 Class<T> payloadClass)

Description copied from interface: SqsOperations

Receive a message using SqsReceiveOptions and convert the payload to the provided class.

Specified by:

receive in interface SqsOperations

Parameters:

from - a SqsReceiveOptions consumer.

payloadClass - to class to convert the payload to.

Returns:

The message, or an empty collection if none is returned.

receiveMany

public Collection<Message<?>> receiveMany(Consumer<SqsReceiveOptions> from)

Description copied from interface: SqsOperations

Receive a batch of messages using SqsReceiveOptions.

Specified by:

receiveMany in interface SqsOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

The message, or an empty collection if none is returned.

receiveMany

public <T> Collection<Message<T>> receiveMany(Consumer<SqsReceiveOptions> from,
 Class<T> payloadClass)

Description copied from interface: SqsOperations

Receive a batch of messages using SqsReceiveOptions and convert the payloads to the provided class.

Specified by:

receiveMany in interface SqsOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

The message, or an empty collection if none is returned.

receiveAsync

public CompletableFuture<Optional<Message<?>>> receiveAsync(Consumer<SqsReceiveOptions> from)

Description copied from interface: SqsAsyncOperations

Receive a message using the SqsReceiveOptions options.

Specified by:

receiveAsync in interface SqsAsyncOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the message, or Optional.empty() if none is returned.

receiveAsync

public <T> CompletableFuture<Optional<Message<T>>> receiveAsync(Consumer<SqsReceiveOptions> from,
 Class<T> payloadClass)

Description copied from interface: SqsAsyncOperations

Receive a message using the SqsReceiveOptions options and convert the payload to the provided class.

Specified by:

receiveAsync in interface SqsAsyncOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the message, or Optional.empty() if none is returned.

receiveManyAsync

public CompletableFuture<Collection<Message<?>>> receiveManyAsync(Consumer<SqsReceiveOptions> from)

Description copied from interface: SqsAsyncOperations

Receive a batch of messages using the SqsReceiveOptions options.

Specified by:

receiveManyAsync in interface SqsAsyncOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the messages, or an empty collection if none is returned.

receiveManyAsync

public <T>
CompletableFuture<Collection<Message<T>>> receiveManyAsync(Consumer<SqsReceiveOptions> from,
 Class<T> payloadClass)

Description copied from interface: SqsAsyncOperations

Receive a batch of messages using the SqsReceiveOptions options and convert the payloads to the provided class.

Specified by:

receiveManyAsync in interface SqsAsyncOperations

Parameters:

from - a SqsReceiveOptions consumer.

Returns:

a CompletableFuture to be completed with the messages, or an empty collection if none is returned.

preProcessMessageForSend

protected <T> Message<T> preProcessMessageForSend(String endpointToUse,
 Message<T> message)

Specified by:

preProcessMessageForSend in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

preProcessMessagesForSend

protected <T> Collection<Message<T>> preProcessMessagesForSend(String endpointToUse,
 Collection<Message<T>> messages)

Specified by:

preProcessMessagesForSend in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

preProcessMessageForSendAsync

protected <T> CompletableFuture<Message<T>> preProcessMessageForSendAsync(String endpointToUse,
 Message<T> message)

Overrides:

preProcessMessageForSendAsync in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

preProcessMessagesForSendAsync

protected <T>
CompletableFuture<Collection<Message<T>>> preProcessMessagesForSendAsync(String endpointToUse,
 Collection<Message<T>> messages)

Overrides:

preProcessMessagesForSendAsync in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

doSendAsync

protected <T> CompletableFuture<SendResult<T>> doSendAsync(String endpointName,
 software.amazon.awssdk.services.sqs.model.Message message,
 Message<T> originalMessage)

Specified by:

doSendAsync in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

doSendBatchAsync

protected <T>
CompletableFuture<SendResult.Batch<T>> doSendBatchAsync(String endpointName,
 Collection<software.amazon.awssdk.services.sqs.model.Message> messages,
 Collection<Message<T>> originalMessages)

Specified by:

doSendBatchAsync in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

getReceiveMessageConversionContext

@Nullable
protected <T> MessageConversionContext getReceiveMessageConversionContext(String endpointName,
 @Nullable
 Class<T> payloadClass)

Overrides:

getReceiveMessageConversionContext in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

handleAdditionalHeaders

protected Map<String,Object> handleAdditionalHeaders(Map<String,Object> additionalHeaders)

Specified by:

handleAdditionalHeaders in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

doAcknowledgeMessages

protected CompletableFuture<Void> doAcknowledgeMessages(String endpointName,
 Collection<Message<?>> messages)

Specified by:

doAcknowledgeMessages in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

doReceiveAsync

protected CompletableFuture<Collection<software.amazon.awssdk.services.sqs.model.Message>> doReceiveAsync(String endpointName,
 Duration pollTimeout,
 Integer maxNumberOfMessages,
 Map<String,Object> additionalHeaders)

Specified by:

doReceiveAsync in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>

preProcessHeadersForReceive

protected Map<String,Object> preProcessHeadersForReceive(String endpointToUse,
 Map<String,Object> headers)

Specified by:

preProcessHeadersForReceive in class AbstractMessagingTemplate<software.amazon.awssdk.services.sqs.model.Message>