Class SnsAsyncTemplate

java.lang.Object

io.awspring.cloud.sns.core.async.SnsAsyncTemplate

All Implemented Interfaces:

SnsAsyncOperations

public class SnsAsyncTemplate
extends Object
implements SnsAsyncOperations

Asynchronous template for SNS operations.

Since:

4.1.0

Author:

Matej Nedic

Constructor Summary

Constructors

Constructor	Description
SnsAsyncTemplate(software.amazon.awssdk.services.sns.SnsAsyncClient snsAsyncClient)
SnsAsyncTemplate(software.amazon.awssdk.services.sns.SnsAsyncClient snsAsyncClient, @Nullable SnsPublishMessageConverter messageConverter)
SnsAsyncTemplate(software.amazon.awssdk.services.sns.SnsAsyncClient snsAsyncClient, TopicArnResolver topicArnResolver, @Nullable SnsPublishMessageConverter messageConverter)

Method Summary

Modifier and Type	Method	Description
<T> CompletableFuture<PublishMessageResult<T>>	convertAndSend(String destination, T payload)	Converts and sends a payload to a destination.
<T> CompletableFuture<PublishMessageResult<T>>	convertAndSend(String destination, T payload, @Nullable Map<String,Object> headers)	Converts and sends a payload with headers to a destination.
<T> CompletableFuture<PublishMessageResult<T>>	convertAndSend(String destination, T payload, @Nullable Map<String,Object> headers, @Nullable MessagePostProcessor postProcessor)	Converts and sends a payload with headers and a post processor to a destination.
<T> CompletableFuture<PublishMessageResult<T>>	convertAndSend(String destination, T payload, @Nullable MessagePostProcessor postProcessor)	Converts and sends a payload with a post processor to a destination.
<T> CompletableFuture<PublishMessageResult<T>>	send(String destination, Message<T> message)	Sends a message to a destination.
<T> CompletableFuture<PublishMessageResult<T>>	sendNotification(String topic, SnsNotification<T> notification)	Sends a notification to a topic.
CompletableFuture<PublishMessageResult<Object>>	sendNotification(String destinationName, Object message, @Nullable String subject)	Sends a notification with a message and subject to a destination.
CompletableFuture<Boolean>	topicExists(String topicArn)	Checks if a topic with the given ARN exists.

Methods inherited from class Object

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

Constructor Details

SnsAsyncTemplate

public SnsAsyncTemplate(software.amazon.awssdk.services.sns.SnsAsyncClient snsAsyncClient)

SnsAsyncTemplate

public SnsAsyncTemplate(software.amazon.awssdk.services.sns.SnsAsyncClient snsAsyncClient,
 @Nullable SnsPublishMessageConverter messageConverter)

SnsAsyncTemplate

public SnsAsyncTemplate(software.amazon.awssdk.services.sns.SnsAsyncClient snsAsyncClient,
 TopicArnResolver topicArnResolver,
 @Nullable SnsPublishMessageConverter messageConverter)

Method Details

send

public <T>
CompletableFuture<PublishMessageResult<T>> send(String destination,
 Message<T> message)

Description copied from interface: SnsAsyncOperations

Sends a message to a destination.

Specified by:

send in interface SnsAsyncOperations

Type Parameters:

T - the message payload type

Parameters:

destination - the destination name

message - the message to send

Returns:

a CompletableFuture with the result

convertAndSend

public <T>
CompletableFuture<PublishMessageResult<T>> convertAndSend(String destination,
 T payload)

Description copied from interface: SnsAsyncOperations

Converts and sends a payload to a destination.

Specified by:

convertAndSend in interface SnsAsyncOperations

Type Parameters:

T - the payload type

Parameters:

destination - the destination name

payload - the payload to send

Returns:

a CompletableFuture with the result

convertAndSend

public <T>
CompletableFuture<PublishMessageResult<T>> convertAndSend(String destination,
 T payload,
 @Nullable Map<String,Object> headers)

Description copied from interface: SnsAsyncOperations

Converts and sends a payload with headers to a destination.

Specified by:

convertAndSend in interface SnsAsyncOperations

Type Parameters:

T - the payload type

Parameters:

destination - the destination name

payload - the payload to send

headers - the headers to include

Returns:

a CompletableFuture with the result

convertAndSend

public <T>
CompletableFuture<PublishMessageResult<T>> convertAndSend(String destination,
 T payload,
 @Nullable MessagePostProcessor postProcessor)

Description copied from interface: SnsAsyncOperations

Converts and sends a payload with a post processor to a destination.

Specified by:

convertAndSend in interface SnsAsyncOperations

Type Parameters:

T - the payload type

Parameters:

destination - the destination name

payload - the payload to send

postProcessor - the post processor to apply

Returns:

a CompletableFuture with the result

convertAndSend

public <T>
CompletableFuture<PublishMessageResult<T>> convertAndSend(String destination,
 T payload,
 @Nullable Map<String,Object> headers,
 @Nullable MessagePostProcessor postProcessor)

Description copied from interface: SnsAsyncOperations

Converts and sends a payload with headers and a post processor to a destination.

Specified by:

convertAndSend in interface SnsAsyncOperations

Type Parameters:

T - the payload type

Parameters:

destination - the destination name

payload - the payload to send

headers - the headers to include

postProcessor - the post processor to apply

Returns:

a CompletableFuture with the result

sendNotification

public CompletableFuture<PublishMessageResult<Object>> sendNotification(String destinationName,
 Object message,
 @Nullable String subject)

Description copied from interface: SnsAsyncOperations

Sends a notification with a message and subject to a destination.

Specified by:

sendNotification in interface SnsAsyncOperations

Parameters:

destinationName - the destination name

message - the message to send

subject - the subject (can be null)

Returns:

a CompletableFuture with the result

sendNotification

public <T>
CompletableFuture<PublishMessageResult<T>> sendNotification(String topic,
 SnsNotification<T> notification)

Description copied from interface: SnsAsyncOperations

Sends a notification to a topic.

Specified by:

sendNotification in interface SnsAsyncOperations

Type Parameters:

T - the notification payload type

Parameters:

topic - the topic name

notification - the notification to send

Returns:

a CompletableFuture with the result

topicExists

public CompletableFuture<Boolean> topicExists(String topicArn)

Description copied from interface: SnsAsyncOperations

Checks if a topic with the given ARN exists.

Specified by:

topicExists in interface SnsAsyncOperations

Parameters:

topicArn - the ARN of the topic

Returns:

a CompletableFuture with true if the topic exists, false otherwise