com.agorapulse.micronaut.amazon.awssdk.sns

Interface SimpleNotificationService

All Known Implementing Classes:

DefaultSimpleNotificationService

public interface SimpleNotificationService

Service to simplify interaction with Amazon SNS.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SimpleNotificationService.PlatformType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIFO_SUFFIX
static java.lang.String	MOBILE_PLATFORM_AMAZON Deprecated.
static java.lang.String	MOBILE_PLATFORM_ANDROID Deprecated.
static java.lang.String	MOBILE_PLATFORM_IOS Deprecated.
static java.lang.String	MOBILE_PLATFORM_IOS_SANDBOX Deprecated.
static java.lang.String	PLATFORM_TYPE_AMAZON Deprecated.
static java.lang.String	PLATFORM_TYPE_ANDROID Deprecated.
static java.lang.String	PLATFORM_TYPE_IOS Deprecated.
static java.lang.String	PLATFORM_TYPE_IOS_SANDBOX Deprecated.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	createAmazonApplication(java.lang.String name, java.lang.String clientId, java.lang.String clientSecret) Deprecated. use instead
default java.lang.String	createAndroidApplication(java.lang.String name, java.lang.String apiKey) Deprecated. use instead
default java.lang.String	createIosApplication(java.lang.String name, java.lang.String privateKey, java.lang.String sslCertificate, boolean sandbox) Deprecated. use createPlatformApplication(String, PlatformType, String, String)
java.lang.String	createPlatformApplication(java.lang.String name, SimpleNotificationService.PlatformType platformType, java.lang.String principal, java.lang.String credential) Creates new platform application.
default java.lang.String	createPlatformApplication(java.lang.String name, java.lang.String platformType, java.lang.String principal, java.lang.String credential) Deprecated.
default java.lang.String	createPlatformEndpoint(java.lang.String platformApplicationArn, java.lang.String deviceToken) Creates new application endpoint.
java.lang.String	createPlatformEndpoint(java.lang.String platformApplicationArn, java.lang.String deviceToken, java.lang.String customUserData) Creates new application endpoint.
java.lang.String	createTopic(java.lang.String topicName) Creates new topic with given name.
void	deleteTopic(java.lang.String topicArn) Deletes given topic.
java.lang.String	getAmazonApplicationArn() Deprecated. use getPlatformApplicationArn(PlatformType)
java.lang.String	getAndroidApplicationArn() Deprecated. use getPlatformApplicationArn(PlatformType)
java.lang.String	getDefaultTopicNameOrArn()
java.lang.String	getIosApplicationArn() Deprecated. use getPlatformApplicationArn(PlatformType)
java.lang.String	getIosSandboxApplicationArn() Deprecated. use getPlatformApplicationArn(PlatformType)
java.lang.String	getPlatformApplicationArn(SimpleNotificationService.PlatformType platformType)
static boolean	isFifoTopic(java.lang.String topicName) Checks if the $topicName matches AWS requirements for FIFO topics
org.reactivestreams.Publisher<software.amazon.awssdk.services.sns.model.Topic>	listTopics()
default java.lang.String	publishMessageToTopic(java.lang.String topicArn, java.lang.String subject, java.lang.String message) Publishes a message into the topic.
java.lang.String	publishMessageToTopic(java.lang.String topicArn, java.lang.String subject, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> attributes) Publishes a message into the topic.
java.lang.String	publishRequest(java.lang.String topicArn, java.util.Map<java.lang.String,java.lang.String> attributes, software.amazon.awssdk.services.sns.model.PublishRequest.Builder publishRequestBuilder) Builds and Publishes a request into the topic
default java.lang.String	registerAmazonDevice(java.lang.String deviceToken) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerAmazonDevice(java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerAmazonDevice(java.lang.String applicationArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use createPlatformEndpoint(String, String)
default java.lang.String	registerAndroidDevice(java.lang.String deviceToken) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerAndroidDevice(java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerAndroidDevice(java.lang.String applicationArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated.
default java.lang.String	registerDevice(SimpleNotificationService.PlatformType platformType, java.lang.String deviceToken) Register new device depending on patform
default java.lang.String	registerDevice(SimpleNotificationService.PlatformType platformType, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use SimpleNotificationService.PlatformType instead of platform string
default java.lang.String	registerDevice(java.lang.String platform, java.lang.String deviceToken) Deprecated.
default java.lang.String	registerDevice(java.lang.String platform, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use SimpleNotificationService.PlatformType instead of platform string
default java.lang.String	registerIosDevice(java.lang.String deviceToken) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerIosDevice(java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerIosDevice(java.lang.String applicationArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated.
default java.lang.String	registerIosSandboxDevice(java.lang.String deviceToken) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	registerIosSandboxDevice(java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use registerDevice(PlatformType, String)
default java.lang.String	sendAndroidAppNotification(java.lang.String endpointArn, java.util.Map<java.lang.String,java.lang.Object> notification, java.lang.String collapseKey) Deprecated. use sendNotification(String, PlatformType, String)
default java.lang.String	sendAndroidAppNotification(java.lang.String endpointArn, java.util.Map<java.lang.String,java.lang.Object> notification, java.lang.String collapseKey, boolean delayWhileIdle) Deprecated. use sendNotification(String, PlatformType, String)
default java.lang.String	sendAndroidAppNotification(java.lang.String endpointArn, java.util.Map<java.lang.String,java.lang.Object> notification, java.lang.String collapseKey, boolean delayWhileIdle, int timeToLive) Deprecated. use sendNotification(String, PlatformType, String)
java.lang.String	sendAndroidAppNotification(java.lang.String endpointArn, java.util.Map<java.lang.String,java.lang.Object> notification, java.lang.String collapseKey, boolean delayWhileIdle, int timeToLive, boolean dryRun) Deprecated. use sendNotification(String, PlatformType, String)
default java.lang.String	sendIosAppNotification(java.lang.String endpointArn, java.util.Map<java.lang.String,java.lang.Object> notification) Deprecated. use sendNotification(String, PlatformType, String)
java.lang.String	sendIosAppNotification(java.lang.String endpointArn, java.util.Map<java.lang.String,java.lang.Object> notification, boolean sandbox) Deprecated. use sendNotification(String, PlatformType, String)
java.lang.String	sendNotification(java.lang.String endpointArn, SimpleNotificationService.PlatformType platformType, java.lang.String jsonMessage) Send a push notification to a single mobile target - platform will be included into payload https://docs.aws.amazon.com/sns/latest/dg/sns-send-custom-platform-specific-payloads-mobile-devices.html
default java.lang.String	sendSMSMessage(java.lang.String phoneNumber, java.lang.String message) Send SMS
java.lang.String	sendSMSMessage(java.lang.String phoneNumber, java.lang.String message, java.util.Map<java.lang.String,software.amazon.awssdk.services.sns.model.MessageAttributeValue> smsAttributes) Send SMS
java.lang.String	subscribeTopic(java.lang.String topic, java.lang.String protocol, java.lang.String endpoint) Generic version of subscribing to the topic.
default java.lang.String	subscribeTopicWithApplication(java.lang.String topicArn, java.lang.String applicationEndpointArn) Subscribes to the topic with SNS application.
default java.lang.String	subscribeTopicWithEmail(java.lang.String topicArn, java.lang.String email) Subscribes to the topic with an email.
default java.lang.String	subscribeTopicWithEndpoint(java.lang.String topicArn, java.lang.String url) Subscribe to topic with HTTP or HTTPS endpoint.
default java.lang.String	subscribeTopicWithEndpoint(java.lang.String topicArn, java.net.URL url) Subscribe to topic with HTTP or HTTPS endpoint.
default java.lang.String	subscribeTopicWithFunction(java.lang.String topicArn, java.lang.String lambdaArn) Subscribes to the topic with Lambda function.
default java.lang.String	subscribeTopicWithJsonEmail(java.lang.String topicArn, java.lang.String email) Subscribes to the topic with JSON email.
default java.lang.String	subscribeTopicWithQueue(java.lang.String topicArn, java.lang.String queueArn) Subscribes to the topic with SQS queue.
default java.lang.String	subscribeTopicWithSMS(java.lang.String topicArn, java.lang.String number) Subscribes to the topic with SMS to the phone number.
void	unregisterDevice(java.lang.String endpointArn) Unregisters existing device.
void	unsubscribeTopic(java.lang.String arn) Unsubscribes from the topic.
default java.lang.String	validateAmazonDevice(java.lang.String endpointArn, java.lang.String deviceToken) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateAmazonDevice(java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateAndroidDevice(java.lang.String endpointArn, java.lang.String deviceToken) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateAndroidDevice(java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateAndroidDevice(java.lang.String applicationArn, java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated.
default java.lang.String	validateDevice(java.lang.String platform, java.lang.String endpointArn, java.lang.String deviceToken) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateDevice(java.lang.String platform, java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateDeviceToken(SimpleNotificationService.PlatformType platformType, java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Validates Platform device.
java.lang.String	validateDeviceToken(java.lang.String applicationArn, java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Validates device token This method is able to update the custom user data as well as the type of the platform.
default java.lang.String	validateIosDevice(java.lang.String endpointArn, java.lang.String deviceToken) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateIosDevice(java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateIosDevice(java.lang.String applicationArn, java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated.
default java.lang.String	validateIosSandboxDevice(java.lang.String endpointArn, java.lang.String deviceToken) Deprecated. use validateDeviceToken(String, String, String, String)
default java.lang.String	validateIosSandboxDevice(java.lang.String endpointArn, java.lang.String deviceToken, java.lang.String customUserData) Deprecated. use validateDeviceToken(String, String, String, String)

Field Detail

MOBILE_PLATFORM_ANDROID

@Deprecated
static final java.lang.String MOBILE_PLATFORM_ANDROID

Deprecated.

See Also:

Constant Field Values

MOBILE_PLATFORM_IOS

@Deprecated
static final java.lang.String MOBILE_PLATFORM_IOS

Deprecated.

See Also:

Constant Field Values

MOBILE_PLATFORM_IOS_SANDBOX

@Deprecated
static final java.lang.String MOBILE_PLATFORM_IOS_SANDBOX

Deprecated.

See Also:

Constant Field Values

MOBILE_PLATFORM_AMAZON

@Deprecated
static final java.lang.String MOBILE_PLATFORM_AMAZON

Deprecated.

See Also:

Constant Field Values

PLATFORM_TYPE_IOS_SANDBOX

@Deprecated
static final java.lang.String PLATFORM_TYPE_IOS_SANDBOX

Deprecated.

See Also:

Constant Field Values

PLATFORM_TYPE_IOS

@Deprecated
static final java.lang.String PLATFORM_TYPE_IOS

Deprecated.

See Also:

Constant Field Values

PLATFORM_TYPE_ANDROID

@Deprecated
static final java.lang.String PLATFORM_TYPE_ANDROID

Deprecated.

See Also:

Constant Field Values

PLATFORM_TYPE_AMAZON

@Deprecated
static final java.lang.String PLATFORM_TYPE_AMAZON

Deprecated.

See Also:

Constant Field Values

FIFO_SUFFIX

static final java.lang.String FIFO_SUFFIX

See Also:

Constant Field Values

Method Detail

getPlatformApplicationArn

java.lang.String getPlatformApplicationArn(SimpleNotificationService.PlatformType platformType)

Parameters:

platformType - platform type

Returns:

the default Application ARN for given platform

getAmazonApplicationArn

@Deprecated
java.lang.String getAmazonApplicationArn()

Deprecated. use getPlatformApplicationArn(PlatformType)

Returns:

the default Application ARN for Amazon devices integration.

getAndroidApplicationArn

@Deprecated
java.lang.String getAndroidApplicationArn()

Deprecated. use getPlatformApplicationArn(PlatformType)

Returns:

the default Application ARN for Android devices integration.

getIosApplicationArn

@Deprecated
java.lang.String getIosApplicationArn()

Deprecated. use getPlatformApplicationArn(PlatformType)

Returns:

the default Application ARN for iOS devices integration.

getIosSandboxApplicationArn

@Deprecated
java.lang.String getIosSandboxApplicationArn()

Deprecated. use getPlatformApplicationArn(PlatformType)

Returns:

the default Application ARN for iOS sandbox devices integration.

getDefaultTopicNameOrArn

java.lang.String getDefaultTopicNameOrArn()

Returns:

the default topic ARN or name.

createTopic

java.lang.String createTopic(java.lang.String topicName)

Creates new topic with given name.

Parameters:

topicName - topic name

Returns:

ARN of newly created topic

listTopics

org.reactivestreams.Publisher<software.amazon.awssdk.services.sns.model.Topic> listTopics()

Returns:

flowable iterating through all the topics available

deleteTopic

void deleteTopic(java.lang.String topicArn)

Deletes given topic.

Parameters:

topicArn - topic ARN or name

subscribeTopic

java.lang.String subscribeTopic(java.lang.String topic,
                                java.lang.String protocol,
                                java.lang.String endpoint)

Generic version of subscribing to the topic.

It is recommended to use one of the specialised methods instead.

Parameters:

topic - ARN of the topic

protocol - see SubscribeRequest

endpoint - see SubscribeRequest

Returns:

subscription ARN

See Also:

subscribeTopicWithApplication(String, String), subscribeTopicWithEndpoint(String, String), subscribeTopicWithEndpoint(String, URL), subscribeTopicWithEmail(String, String), subscribeTopicWithJsonEmail(String, String), subscribeTopicWithQueue(String, String), subscribeTopicWithSMS(String, String), subscribeTopicWithFunction(String, String), SubscribeRequest

subscribeTopicWithEndpoint

default java.lang.String subscribeTopicWithEndpoint(java.lang.String topicArn,
                                                    java.lang.String url)
                                             throws java.net.MalformedURLException

Subscribe to topic with HTTP or HTTPS endpoint.

Parameters:

topicArn - topic ARN or name

url - the url to post new messages

Returns:

subscription ARN

Throws:

java.net.MalformedURLException

subscribeTopicWithEndpoint

default java.lang.String subscribeTopicWithEndpoint(java.lang.String topicArn,
                                                    java.net.URL url)

Subscribe to topic with HTTP or HTTPS endpoint.

Parameters:

topicArn - topic ARN or name

url - the url to post new messages

Returns:

subscription ARN

subscribeTopicWithEmail

default java.lang.String subscribeTopicWithEmail(java.lang.String topicArn,
                                                 java.lang.String email)

Subscribes to the topic with an email.

Parameters:

topicArn - topic ARN or name

email - email to subscribe with

Returns:

subscription ARN

subscribeTopicWithJsonEmail

default java.lang.String subscribeTopicWithJsonEmail(java.lang.String topicArn,
                                                     java.lang.String email)

Subscribes to the topic with JSON email.

Parameters:

topicArn - topic ARN or name

email - email to subscribe with

Returns:

subscription ARN

subscribeTopicWithSMS

default java.lang.String subscribeTopicWithSMS(java.lang.String topicArn,
                                               java.lang.String number)

Subscribes to the topic with SMS to the phone number.

Parameters:

topicArn - topic ARN or name

number - phone number in international format

Returns:

subscription ARN

subscribeTopicWithQueue

default java.lang.String subscribeTopicWithQueue(java.lang.String topicArn,
                                                 java.lang.String queueArn)

Subscribes to the topic with SQS queue.

Parameters:

topicArn - topic ARN or name

queueArn - ARN of the queue to be subscribed

Returns:

subscription ARN

subscribeTopicWithApplication

default java.lang.String subscribeTopicWithApplication(java.lang.String topicArn,
                                                       java.lang.String applicationEndpointArn)

Subscribes to the topic with SNS application.

Parameters:

topicArn - topic ARN or name

applicationEndpointArn - ARN of the application to be subscribed

Returns:

subscription ARN

subscribeTopicWithFunction

default java.lang.String subscribeTopicWithFunction(java.lang.String topicArn,
                                                    java.lang.String lambdaArn)

Subscribes to the topic with Lambda function.

Parameters:

topicArn - topic ARN or name

lambdaArn - ARN of the lambda to be subscribed with

Returns:

subscription ARN

unsubscribeTopic

void unsubscribeTopic(java.lang.String arn)

Unsubscribes from the topic.

Parameters:

arn - ARN of the subscription

publishMessageToTopic

default java.lang.String publishMessageToTopic(java.lang.String topicArn,
                                               java.lang.String subject,
                                               java.lang.String message)

Publishes a message into the topic.

Parameters:

topicArn - topic ARN or name

subject - subject of the message (ignored by most of the protocols)

message - the message

Returns:

the id of the message published

publishMessageToTopic

java.lang.String publishMessageToTopic(java.lang.String topicArn,
                                       java.lang.String subject,
                                       java.lang.String message,
                                       java.util.Map<java.lang.String,java.lang.String> attributes)

Publishes a message into the topic.

Parameters:

topicArn - topic ARN or name

subject - subject of the message (ignored by most of the protocols)

message - the message

attributes - the message attributes

Returns:

the id of the message published

publishRequest

java.lang.String publishRequest(java.lang.String topicArn,
                                java.util.Map<java.lang.String,java.lang.String> attributes,
                                software.amazon.awssdk.services.sns.model.PublishRequest.Builder publishRequestBuilder)

Builds and Publishes a request into the topic

Parameters:

topicArn - topic ARN or name

attributes - the message attributes

Returns:

the id of the message published

createPlatformApplication

java.lang.String createPlatformApplication(java.lang.String name,
                                           SimpleNotificationService.PlatformType platformType,
                                           java.lang.String principal,
                                           java.lang.String credential)

Creates new platform application.

Parameters:

name - name of the application

platformType -

principal - (ADM: clientId - APNS: sslCertificate - GCM: null)

credential - (ADM: clientSecret - APNS: privateKey - GCM: apiKey)

Returns:

ARN of the platform

createPlatformApplication

@Deprecated
default java.lang.String createPlatformApplication(java.lang.String name,
                                                               java.lang.String platformType,
                                                               java.lang.String principal,
                                                               java.lang.String credential)

Deprecated.

Creates new platform application.

Parameters:

name - name of the application

platformType - type of the platform

principal - user's principal

credential - user's credentials

Returns:

ARN of the platform

createIosApplication

@Deprecated
default java.lang.String createIosApplication(java.lang.String name,
                                                          java.lang.String privateKey,
                                                          java.lang.String sslCertificate,
                                                          boolean sandbox)

Deprecated. use createPlatformApplication(String, PlatformType, String, String)

Creates new platform application.

Parameters:

name - name of the application

privateKey - private key

sslCertificate - SSL certificate

sandbox - whether the application should be a iOS sandbox application

Returns:

ARN of the platform

createAndroidApplication

@Deprecated
default java.lang.String createAndroidApplication(java.lang.String name,
                                                              java.lang.String apiKey)

Deprecated. use instead

Creates new platform application.

Parameters:

name - name of the application

apiKey - API key

Returns:

ARN of the platform

createAmazonApplication

@Deprecated
default java.lang.String createAmazonApplication(java.lang.String name,
                                                             java.lang.String clientId,
                                                             java.lang.String clientSecret)

Deprecated. use instead

Creates new platform application.

Parameters:

name - name of the application

clientId - client ID

clientSecret - client secret

Returns:

ARN of the platform

registerDevice

default java.lang.String registerDevice(SimpleNotificationService.PlatformType platformType,
                                        java.lang.String deviceToken,
                                        java.lang.String customUserData)

Deprecated. use SimpleNotificationService.PlatformType instead of platform string

Register new device depending on patform

Parameters:

platformType - platform type

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerDevice

default java.lang.String registerDevice(SimpleNotificationService.PlatformType platformType,
                                        java.lang.String deviceToken)

Register new device depending on patform

Parameters:

platformType -

deviceToken - device token

Returns:

ARN of the endpoint

registerDevice

@Deprecated
default java.lang.String registerDevice(java.lang.String platform,
                                                    java.lang.String deviceToken,
                                                    java.lang.String customUserData)

Deprecated. use SimpleNotificationService.PlatformType instead of platform string

Register new device depending on patform

Parameters:

platform -

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerDevice

@Deprecated
default java.lang.String registerDevice(java.lang.String platform,
                                                    java.lang.String deviceToken)

Deprecated.

Register new device depending on patform

Parameters:

platform -

deviceToken - device token

Returns:

ARN of the endpoint

registerAndroidDevice

@Deprecated
default java.lang.String registerAndroidDevice(java.lang.String deviceToken)

Deprecated. use registerDevice(PlatformType, String)

Register new Android device.

Parameters:

deviceToken - device token

Returns:

ARN of the endpoint

registerAndroidDevice

@Deprecated
default java.lang.String registerAndroidDevice(java.lang.String deviceToken,
                                                           java.lang.String customUserData)

Deprecated. use registerDevice(PlatformType, String)

Register new Android device.

Parameters:

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerAndroidDevice

@Deprecated
default java.lang.String registerAndroidDevice(java.lang.String applicationArn,
                                                           java.lang.String deviceToken,
                                                           java.lang.String customUserData)

Deprecated.

Deprecated - If you know the platform applicationArn, use directly createPlatformEndpoint() Register new Android device.

Parameters:

applicationArn - application ARN

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerIosDevice

@Deprecated
default java.lang.String registerIosDevice(java.lang.String deviceToken)

Deprecated. use registerDevice(PlatformType, String)

Register new iOS device.

Parameters:

deviceToken - device token

Returns:

ARN of the endpoint

registerIosDevice

@Deprecated
default java.lang.String registerIosDevice(java.lang.String deviceToken,
                                                       java.lang.String customUserData)

Deprecated. use registerDevice(PlatformType, String)

Register new iOS device.

Parameters:

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerIosSandboxDevice

@Deprecated
default java.lang.String registerIosSandboxDevice(java.lang.String deviceToken)

Deprecated. use registerDevice(PlatformType, String)

Register new iOS Sandbox device.

Parameters:

deviceToken - device token

Returns:

ARN of the endpoint

registerIosSandboxDevice

@Deprecated
default java.lang.String registerIosSandboxDevice(java.lang.String deviceToken,
                                                              java.lang.String customUserData)

Deprecated. use registerDevice(PlatformType, String)

Register new iOS Sandbox device.

Parameters:

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerIosDevice

@Deprecated
default java.lang.String registerIosDevice(java.lang.String applicationArn,
                                                       java.lang.String deviceToken,
                                                       java.lang.String customUserData)

Deprecated.

Deprecated - If you know the platform applicationArn, use directly createPlatformEndpoint() Register new device.

Parameters:

applicationArn - application ARN

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerAmazonDevice

@Deprecated
default java.lang.String registerAmazonDevice(java.lang.String deviceToken)

Deprecated. use registerDevice(PlatformType, String)

Register new Amazon device.

Parameters:

deviceToken - device token

Returns:

ARN of the endpoint

registerAmazonDevice

@Deprecated
default java.lang.String registerAmazonDevice(java.lang.String deviceToken,
                                                          java.lang.String customUserData)

Deprecated. use registerDevice(PlatformType, String)

Register new Amazon device.

Parameters:

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

registerAmazonDevice

@Deprecated
default java.lang.String registerAmazonDevice(java.lang.String applicationArn,
                                                          java.lang.String deviceToken,
                                                          java.lang.String customUserData)

Deprecated. use createPlatformEndpoint(String, String)

Register new Amazon device.

Parameters:

applicationArn - application ARN

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

createPlatformEndpoint

java.lang.String createPlatformEndpoint(java.lang.String platformApplicationArn,
                                        java.lang.String deviceToken,
                                        java.lang.String customUserData)

Creates new application endpoint.

Parameters:

platformApplicationArn - application ARN

deviceToken - device token

customUserData - custom user data

Returns:

ARN of the endpoint

createPlatformEndpoint

default java.lang.String createPlatformEndpoint(java.lang.String platformApplicationArn,
                                                java.lang.String deviceToken)

Creates new application endpoint.

Parameters:

platformApplicationArn - application ARN

deviceToken - device token

Returns:

ARN of the endpoint

sendAndroidAppNotification

@Deprecated
java.lang.String sendAndroidAppNotification(java.lang.String endpointArn,
                                                        java.util.Map<java.lang.String,java.lang.Object> notification,
                                                        java.lang.String collapseKey,
                                                        boolean delayWhileIdle,
                                                        int timeToLive,
                                                        boolean dryRun)

Deprecated. use sendNotification(String, PlatformType, String)

Send Android application notification.

Parameters:

endpointArn - endpoint ARN

notification - notification payload

collapseKey - collapse key

delayWhileIdle - delay while idle

timeToLive - time to live

dryRun - dry run

Returns:

message id

sendAndroidAppNotification

@Deprecated
default java.lang.String sendAndroidAppNotification(java.lang.String endpointArn,
                                                                java.util.Map<java.lang.String,java.lang.Object> notification,
                                                                java.lang.String collapseKey,
                                                                boolean delayWhileIdle,
                                                                int timeToLive)

Deprecated. use sendNotification(String, PlatformType, String)

Send Android application notification.

Parameters:

endpointArn - endpoint ARN

notification - notification payload

collapseKey - collapse key

delayWhileIdle - delay while idle

timeToLive - time to live

Returns:

message id

sendAndroidAppNotification

@Deprecated
default java.lang.String sendAndroidAppNotification(java.lang.String endpointArn,
                                                                java.util.Map<java.lang.String,java.lang.Object> notification,
                                                                java.lang.String collapseKey,
                                                                boolean delayWhileIdle)

Deprecated. use sendNotification(String, PlatformType, String)

Send Android application notification.

Parameters:

endpointArn - endpoint ARN

notification - notification payload

collapseKey - collapse key

delayWhileIdle - delay while idle

Returns:

message id

sendAndroidAppNotification

@Deprecated
default java.lang.String sendAndroidAppNotification(java.lang.String endpointArn,
                                                                java.util.Map<java.lang.String,java.lang.Object> notification,
                                                                java.lang.String collapseKey)

Deprecated. use sendNotification(String, PlatformType, String)

Send Android application notification.

Parameters:

endpointArn - endpoint ARN

notification - notification payload

collapseKey - collapse key

Returns:

message id

sendIosAppNotification

@Deprecated
java.lang.String sendIosAppNotification(java.lang.String endpointArn,
                                                    java.util.Map<java.lang.String,java.lang.Object> notification,
                                                    boolean sandbox)

Deprecated. use sendNotification(String, PlatformType, String)

Send iOS application notification.

Parameters:

endpointArn - endpoint ARN

notification - notification payload

sandbox - whether the application is a sandbox application

Returns:

message id

sendIosAppNotification

@Deprecated
default java.lang.String sendIosAppNotification(java.lang.String endpointArn,
                                                            java.util.Map<java.lang.String,java.lang.Object> notification)

Deprecated. use sendNotification(String, PlatformType, String)

Send iOS application notification.

Parameters:

endpointArn - endpoint ARN

notification - notification payload

Returns:

message id

validateAmazonDevice

@Deprecated
default java.lang.String validateAmazonDevice(java.lang.String endpointArn,
                                                          java.lang.String deviceToken,
                                                          java.lang.String customUserData)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates Amazon device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateAmazonDevice

@Deprecated
default java.lang.String validateAmazonDevice(java.lang.String endpointArn,
                                                          java.lang.String deviceToken)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates Amazon device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

Returns:

endpoint ARN which can point to different platform if required

validateAndroidDevice

@Deprecated
default java.lang.String validateAndroidDevice(java.lang.String applicationArn,
                                                           java.lang.String endpointArn,
                                                           java.lang.String deviceToken,
                                                           java.lang.String customUserData)

Deprecated.

Deprecated - use validateDeviceToken() Validates Android device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

applicationArn - application ARN

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateAndroidDevice

@Deprecated
default java.lang.String validateAndroidDevice(java.lang.String endpointArn,
                                                           java.lang.String deviceToken,
                                                           java.lang.String customUserData)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates Android device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateAndroidDevice

@Deprecated
default java.lang.String validateAndroidDevice(java.lang.String endpointArn,
                                                           java.lang.String deviceToken)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates Android device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

Returns:

endpoint ARN which can point to different platform if required

validateIosDevice

@Deprecated
default java.lang.String validateIosDevice(java.lang.String applicationArn,
                                                       java.lang.String endpointArn,
                                                       java.lang.String deviceToken,
                                                       java.lang.String customUserData)

Deprecated.

Deprecated - use validateDeviceToken() Validates iOS device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

applicationArn - application ARN

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateIosDevice

@Deprecated
default java.lang.String validateIosDevice(java.lang.String endpointArn,
                                                       java.lang.String deviceToken,
                                                       java.lang.String customUserData)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates iOS device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateIosDevice

@Deprecated
default java.lang.String validateIosDevice(java.lang.String endpointArn,
                                                       java.lang.String deviceToken)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates iOS device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

Returns:

endpoint ARN which can point to different platform if required

validateIosSandboxDevice

@Deprecated
default java.lang.String validateIosSandboxDevice(java.lang.String endpointArn,
                                                              java.lang.String deviceToken,
                                                              java.lang.String customUserData)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates iOS Sandbox device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateIosSandboxDevice

@Deprecated
default java.lang.String validateIosSandboxDevice(java.lang.String endpointArn,
                                                              java.lang.String deviceToken)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates iOS Sandbox device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

Returns:

endpoint ARN which can point to different platform if required

validateDeviceToken

default java.lang.String validateDeviceToken(SimpleNotificationService.PlatformType platformType,
                                             java.lang.String endpointArn,
                                             java.lang.String deviceToken,
                                             java.lang.String customUserData)

Validates Platform device. This method is able to update the custom user data as well as the type of the platform.

Parameters:

platformType - platform type

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateDeviceToken

java.lang.String validateDeviceToken(java.lang.String applicationArn,
                                     java.lang.String endpointArn,
                                     java.lang.String deviceToken,
                                     java.lang.String customUserData)

Validates device token This method is able to update the custom user data as well as the type of the platform.

Parameters:

applicationArn - application ARN

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateDevice

@Deprecated
default java.lang.String validateDevice(java.lang.String platform,
                                                    java.lang.String endpointArn,
                                                    java.lang.String deviceToken,
                                                    java.lang.String customUserData)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates device token depending on platform This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

customUserData - custom user data

Returns:

endpoint ARN which can point to different platform if required

validateDevice

@Deprecated
default java.lang.String validateDevice(java.lang.String platform,
                                                    java.lang.String endpointArn,
                                                    java.lang.String deviceToken)

Deprecated. use validateDeviceToken(String, String, String, String)

Validates device token depending on platform This method is able to update the custom user data as well as the type of the platform.

Parameters:

endpointArn - endpoint ARN

deviceToken - device token

Returns:

endpoint ARN which can point to different platform if required

unregisterDevice

void unregisterDevice(java.lang.String endpointArn)

Unregisters existing device.

Parameters:

endpointArn - endpoint ARN

sendNotification

java.lang.String sendNotification(java.lang.String endpointArn,
                                  SimpleNotificationService.PlatformType platformType,
                                  java.lang.String jsonMessage)

Send a push notification to a single mobile target - platform will be included into payload https://docs.aws.amazon.com/sns/latest/dg/sns-send-custom-platform-specific-payloads-mobile-devices.html

Parameters:

endpointArn - mobile target's arn

platformType - identifier of the platform the device is registered in

jsonMessage - a JSON-formatted message

Returns:

notificationId

sendSMSMessage

java.lang.String sendSMSMessage(java.lang.String phoneNumber,
                                java.lang.String message,
                                java.util.Map<java.lang.String,software.amazon.awssdk.services.sns.model.MessageAttributeValue> smsAttributes)

Send SMS

Parameters:

phoneNumber - phone neumber in international format

message - message text

smsAttributes - optional SMS attributes

Returns:

message ID

sendSMSMessage

default java.lang.String sendSMSMessage(java.lang.String phoneNumber,
                                        java.lang.String message)

Send SMS

Parameters:

phoneNumber - phone number in international format

message - message text

Returns:

message ID

isFifoTopic

static boolean isFifoTopic(java.lang.String topicName)

Checks if the $topicName matches AWS requirements for FIFO topics

Parameters:

topicName - Name of the topic

Returns:

true if the $topicName ends with .fifo