org.springframework.cloud.aws.messaging.core

Class QueueMessagingTemplate

java.lang.Object

org.springframework.messaging.core.AbstractMessageSendingTemplate<D>

org.springframework.cloud.aws.messaging.core.support.AbstractMessageChannelMessagingSendingTemplate<QueueMessageChannel>

org.springframework.cloud.aws.messaging.core.QueueMessagingTemplate

All Implemented Interfaces:

org.springframework.messaging.core.DestinationResolvingMessageReceivingOperations<QueueMessageChannel>, org.springframework.messaging.core.DestinationResolvingMessageSendingOperations<QueueMessageChannel>, org.springframework.messaging.core.MessageReceivingOperations<QueueMessageChannel>, org.springframework.messaging.core.MessageSendingOperations<QueueMessageChannel>

public class QueueMessagingTemplate
extends AbstractMessageChannelMessagingSendingTemplate<QueueMessageChannel>
implements org.springframework.messaging.core.DestinationResolvingMessageReceivingOperations<QueueMessageChannel>

IMPORTANT: For the message conversion this class always tries to first use the StringMessageConverter as it fits the underlying message channel type. If a message converter is set through the constructor then it is added to a composite converter already containing the StringMessageConverter. If AbstractMessageSendingTemplate.setMessageConverter(MessageConverter) is used, then the CompositeMessageConverter containing the StringMessageConverter will not be used anymore and the String payloads are also going to be converted with the set converter.

Since:

1.0

Author:

Agim Emruli, Alain Sahli

Field Summary

Fields inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

CONVERSION_HINT_HEADER, logger

Constructor Summary

Constructors

Constructor and Description
QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs)
QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs, org.springframework.messaging.core.DestinationResolver<String> destinationResolver, org.springframework.messaging.converter.MessageConverter messageConverter) Initializes the messaging template by configuring the destination resolver as well as the message converter.
QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs, org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver)
QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs, org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver, org.springframework.messaging.converter.MessageConverter messageConverter) Initializes the messaging template by configuring the resource Id resolver as well as the message converter.

Method Summary

Modifier and Type	Method and Description
org.springframework.messaging.Message<?>	receive()
org.springframework.messaging.Message<?>	receive(QueueMessageChannel destination)
org.springframework.messaging.Message<?>	receive(String destinationName)
<T> T	receiveAndConvert(Class<T> targetClass)
<T> T	receiveAndConvert(QueueMessageChannel destination, Class<T> targetClass)
<T> T	receiveAndConvert(String destinationName, Class<T> targetClass)
protected QueueMessageChannel	resolveMessageChannel(String physicalResourceIdentifier)

Methods inherited from class org.springframework.cloud.aws.messaging.core.support.AbstractMessageChannelMessagingSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, doSend, initMessageConverter, resolveMessageChannelByLogicalName, send, setDefaultDestinationName

Methods inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, doConvert, getDefaultDestination, getMessageConverter, getRequiredDefaultDestination, processHeadersToSend, send, send, setDefaultDestination, setMessageConverter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.core.MessageSendingOperations

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, send, send

Constructor Detail

QueueMessagingTemplate

public QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs)

QueueMessagingTemplate

public QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs,
                              org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver)

QueueMessagingTemplate

public QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs,
                              org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver,
                              org.springframework.messaging.converter.MessageConverter messageConverter)

Initializes the messaging template by configuring the resource Id resolver as well as the message converter. Uses the DynamicQueueUrlDestinationResolver with the default configuration to resolve destination names.

Parameters:

amazonSqs - The AmazonSQS client, cannot be null.

resourceIdResolver - The ResourceIdResolver to be used for resolving logical queue names.

messageConverter - A MessageConverter that is going to be added to the composite converter.

QueueMessagingTemplate

public QueueMessagingTemplate(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs,
                              org.springframework.messaging.core.DestinationResolver<String> destinationResolver,
                              org.springframework.messaging.converter.MessageConverter messageConverter)

Initializes the messaging template by configuring the destination resolver as well as the message converter. Uses the DynamicQueueUrlDestinationResolver with the default configuration to resolve destination names.

Parameters:

amazonSqs - The AmazonSQS client, cannot be null.

destinationResolver - A destination resolver implementation to resolve queue names into queue urls. The destination resolver will be wrapped into a CachingDestinationResolverProxy to avoid duplicate queue url resolutions.

messageConverter - A MessageConverter that is going to be added to the composite converter.

Method Detail

resolveMessageChannel

protected QueueMessageChannel resolveMessageChannel(String physicalResourceIdentifier)

Specified by:

resolveMessageChannel in class AbstractMessageChannelMessagingSendingTemplate<QueueMessageChannel>

receive

public org.springframework.messaging.Message<?> receive()
                                                 throws org.springframework.messaging.MessagingException

Specified by:

receive in interface org.springframework.messaging.core.MessageReceivingOperations<QueueMessageChannel>

Throws:

org.springframework.messaging.MessagingException

receive

public org.springframework.messaging.Message<?> receive(QueueMessageChannel destination)
                                                 throws org.springframework.messaging.MessagingException

Specified by:

receive in interface org.springframework.messaging.core.MessageReceivingOperations<QueueMessageChannel>

Throws:

org.springframework.messaging.MessagingException

receiveAndConvert

public <T> T receiveAndConvert(Class<T> targetClass)
                        throws org.springframework.messaging.MessagingException

Specified by:

receiveAndConvert in interface org.springframework.messaging.core.MessageReceivingOperations<QueueMessageChannel>

Throws:

org.springframework.messaging.MessagingException

receiveAndConvert

public <T> T receiveAndConvert(QueueMessageChannel destination,
                               Class<T> targetClass)
                        throws org.springframework.messaging.MessagingException

Specified by:

receiveAndConvert in interface org.springframework.messaging.core.MessageReceivingOperations<QueueMessageChannel>

Throws:

org.springframework.messaging.MessagingException

receive

public org.springframework.messaging.Message<?> receive(String destinationName)
                                                 throws org.springframework.messaging.MessagingException

Specified by:

receive in interface org.springframework.messaging.core.DestinationResolvingMessageReceivingOperations<QueueMessageChannel>

Throws:

org.springframework.messaging.MessagingException

receiveAndConvert

public <T> T receiveAndConvert(String destinationName,
                               Class<T> targetClass)
                        throws org.springframework.messaging.MessagingException

Specified by:

receiveAndConvert in interface org.springframework.messaging.core.DestinationResolvingMessageReceivingOperations<QueueMessageChannel>

Throws:

org.springframework.messaging.MessagingException