org.springframework.cloud.aws.messaging.core

Class NotificationMessagingTemplate

java.lang.Object

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

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

org.springframework.cloud.aws.messaging.core.NotificationMessagingTemplate

All Implemented Interfaces:

org.springframework.messaging.core.DestinationResolvingMessageSendingOperations<TopicMessageChannel>, org.springframework.messaging.core.MessageSendingOperations<TopicMessageChannel>

public class NotificationMessagingTemplate
extends AbstractMessageChannelMessagingSendingTemplate<TopicMessageChannel>

Since:

1.0

Author:

Alain Sahli

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
NotificationMessagingTemplate(com.amazonaws.services.sns.AmazonSNS amazonSns)
NotificationMessagingTemplate(com.amazonaws.services.sns.AmazonSNS amazonSns, org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver)

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	convertAndSend(String destinationName, T payload) IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload.
<T> void	convertAndSend(String destinationName, T payload, Map<String,Object> headers) IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload.
<T> void	convertAndSend(String destinationName, T payload, Map<String,Object> headers, org.springframework.messaging.core.MessagePostProcessor postProcessor) IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload.
<T> void	convertAndSend(String destinationName, T payload, org.springframework.messaging.core.MessagePostProcessor postProcessor) IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload.
protected TopicMessageChannel	resolveMessageChannel(String physicalResourceIdentifier)
void	sendNotification(String message, String subject) Convenience method that sends a notification with the given message and subject to the destination.
void	sendNotification(String destinationName, String message, String subject) Convenience method that sends a notification with the given message and subject to the destination.

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

doSend, 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

NotificationMessagingTemplate

public NotificationMessagingTemplate(com.amazonaws.services.sns.AmazonSNS amazonSns,
                             org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver)

NotificationMessagingTemplate

public NotificationMessagingTemplate(com.amazonaws.services.sns.AmazonSNS amazonSns)

Method Detail

convertAndSend

public <T> void convertAndSend(String destinationName,
                      T payload)
                    throws org.springframework.messaging.MessagingException

IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload. Therefore only String payloads are accepted.

Specified by:

convertAndSend in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations<TopicMessageChannel>

Overrides:

convertAndSend in class AbstractMessageChannelMessagingSendingTemplate<TopicMessageChannel>

Throws:

org.springframework.messaging.MessagingException

See Also:

MessageSendingOperations.convertAndSend(Object, Object, java.util.Map)

convertAndSend

public <T> void convertAndSend(String destinationName,
                      T payload,
                      Map<String,Object> headers)
                    throws org.springframework.messaging.MessagingException

IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload. Therefore only String payloads are accepted.

Specified by:

convertAndSend in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations<TopicMessageChannel>

Overrides:

convertAndSend in class AbstractMessageChannelMessagingSendingTemplate<TopicMessageChannel>

Throws:

org.springframework.messaging.MessagingException

See Also:

MessageSendingOperations.convertAndSend(Object, Object, java.util.Map)

convertAndSend

public <T> void convertAndSend(String destinationName,
                      T payload,
                      org.springframework.messaging.core.MessagePostProcessor postProcessor)
                    throws org.springframework.messaging.MessagingException

IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload. Therefore only String payloads are accepted.

Specified by:

convertAndSend in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations<TopicMessageChannel>

Overrides:

convertAndSend in class AbstractMessageChannelMessagingSendingTemplate<TopicMessageChannel>

Throws:

org.springframework.messaging.MessagingException

See Also:

MessageSendingOperations.convertAndSend(Object, Object, java.util.Map)

convertAndSend

public <T> void convertAndSend(String destinationName,
                      T payload,
                      Map<String,Object> headers,
                      org.springframework.messaging.core.MessagePostProcessor postProcessor)
                    throws org.springframework.messaging.MessagingException

IMPORTANT: the underlying message channel TopicMessageChannel only supports String as payload. Therefore only String payloads are accepted.

Specified by:

convertAndSend in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations<TopicMessageChannel>

Overrides:

convertAndSend in class AbstractMessageChannelMessagingSendingTemplate<TopicMessageChannel>

Throws:

org.springframework.messaging.MessagingException

See Also:

MessageSendingOperations.convertAndSend(Object, Object, java.util.Map)

resolveMessageChannel

protected TopicMessageChannel resolveMessageChannel(String physicalResourceIdentifier)

Specified by:

resolveMessageChannel in class AbstractMessageChannelMessagingSendingTemplate<TopicMessageChannel>

sendNotification

public void sendNotification(String destinationName,
                    String message,
                    String subject)

Convenience method that sends a notification with the given message and subject to the destination. The subject is sent as header as defined in the SNS message JSON formats.

Parameters:

destinationName - The logical name of the destination

message - The message to send

subject - The subject to send

sendNotification

public void sendNotification(String message,
                    String subject)

Convenience method that sends a notification with the given message and subject to the destination. The subject is sent as header as defined in the SNS message JSON formats. The configured default destination will be used.

Parameters:

message - The message to send

subject - The subject to send