org.mule.modules.sns

Class AmazonSNSConnector

java.lang.Object

org.mule.modules.sns.AmazonSNSConnector

@RequiresEnterpriseLicense(allowEval=true)
 @Connector(name="sns",
           schemaVersion="1.0",
           friendlyName="Amazon SNS",
           minMuleVersion="3.5")
public class AmazonSNSConnector
extends Object

Amazon Simple Notification Service (Amazon SNS) is a web service that makes it easy to set up, operate, and send notifications from the cloud. It provides developers with a highly scalable, flexible, and cost-effective capability to publish messages from an application and immediately deliver them to subscribers or other applications. It is designed to make web-scale computing easier for developers.

Author:

MuleSoft, Inc.

Constructor Summary

Constructors

Constructor and Description
AmazonSNSConnector()

Method Summary

Modifier and Type	Method and Description
void	addPermission(AddPermission addPermission) Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
String	confirmSubscription(ConfirmSubscription confirmSubscription) The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
String	createPlatformApplication(CreatePlatformApplication createPlatformApplication) Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register.
String	createPlatformEndpoint(CreatePlatformEndpoint createPlatformEndpoint) Creates an endpoint for a device and mobile app on one of the supported push notification services.
String	createTopic(String topicName) The CreateTopic action creates a topic to which notifications can be published.
void	deleteEndpoint(String endpointArn) Deletes the endpoint for a device and mobile app from Amazon SNS.
void	deletePlatformApplication(String platformApplicationArn) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
void	deleteTopic(String topicArn) The DeleteTopic action deletes a topic and all its subscriptions.
com.amazonaws.services.sns.AmazonSNS	getClient()
SNSCommonConfig	getConfig()
Map<String,String>	getEndpointAttributes(String endpointArn) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
Map<String,String>	getPlatformApplicationAttributes(String platformApplicationArn) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
Map<String,String>	getSubscriptionAttributes(String subscriptionArn) The GetSubscriptionAttributes action returns all of the properties of a subscription.
Map<String,String>	getTopicAttributes(String topicArn) The GetTopicAttributes action returns all of the properties of a topic.
ListEndpointsByPlatform	listEndpointsByPlatformApplication(EndpointsByPlatform endpointsByPlatform) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
ListPlatformApplications	listPlatformApplications(String nextToken) Lists the platform application objects for the supported push notification services, such as APNS and GCM.
ListSubscriptions	listSubscriptions(String nextToken) The ListSubscriptions action returns a list of the requester's subscriptions.
ListSubscriptionsByTopic	listSubscriptionsByTopic(SubscriptionsByTopic subscriptionsByTopic) The SubscriptionsByTopic action returns a list of the subscriptions to a specific topic.
ListTopics	listTopics(String nextTopic) The ListTopics action returns a list of the requester's topics.
String	publish(Publish publish) The Publish action sends a message to all of a topic's subscribed endpoints.
void	removePermission(RemovePermission removePermission) The RemovePermission action removes a statement from a topic's access control policy.
void	setClient(com.amazonaws.services.sns.AmazonSNS client)
void	setConfig(SNSCommonConfig config)
void	setEndpointAttributes(Endpoint endpointAttributes) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
void	setPlatformApplicationAttributes(PlatformApplication platformApplicationAttributes) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
void	setSubscriptionAttributes(SubscriptionAttributes subscriptionAttributes) The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value.
void	setTopicAttributes(TopicAttributes topicAttributes) The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value.
String	subscribe(Subscribe subscribe) The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message.
void	unsubscribe(String subscriptionArn) The Unsubscribe action deletes a subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonSNSConnector

public AmazonSNSConnector()

Method Detail

addPermission

@Processor
public void addPermission(@Default(value="#[payload]") @RefOnly
                                     AddPermission addPermission)

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

API reference

Parameters:

addPermission - Container for the parameters to the AddPermission operation.

confirmSubscription

@Processor
public String confirmSubscription(@Default(value="#[payload]")
                                             ConfirmSubscription confirmSubscription)
                                      throws SNSException

The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

API reference

Parameters:

confirmSubscription - Container for the parameters to the ConfirmSubscription operation.

Returns:

ARN of the created subscription is returned.

Throws:

SNSException - Indicates an internal connector error.

createPlatformApplication

@Processor
public String createPlatformApplication(@Default(value="#[payload]")
                                                   CreatePlatformApplication createPlatformApplication)

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register.

API reference

Parameters:

createPlatformApplication - Container for the parameters to the CreatePlatformApplication operation.

Returns:

ARN of the CreatePlatformApplication is returned.

createPlatformEndpoint

@Processor
public String createPlatformEndpoint(@Default(value="#[payload]")
                                                CreatePlatformEndpoint createPlatformEndpoint)

Creates an endpoint for a device and mobile app on one of the supported push notification services. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication.

API reference

Parameters:

createPlatformEndpoint - Container for the parameters to the CreatePlatformEndpoint operation.

Returns:

EndpointArn returned from CreateEndpoint action.

createTopic

@Processor
public String createTopic(String topicName)

The CreateTopic action creates a topic to which notifications can be published. Users can create at most 100 topics

API reference

Parameters:

topicName - The name of the topic you want to create.

Returns:

The Amazon Resource Name (ARN) assigned to the created topic.

deleteEndpoint

@Processor
public void deleteEndpoint(String endpointArn)

Deletes the endpoint for a device and mobile app from Amazon SNS.

API reference

Parameters:

endpointArn - EndpointArn of endpoint to delete.

deletePlatformApplication

@Processor
public void deletePlatformApplication(String platformApplicationArn)

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.

API reference

Parameters:

platformApplicationArn - PlatformApplicationArn of platform application object to delete.

deleteTopic

@Processor
public void deleteTopic(String topicArn)

The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

API reference

Parameters:

topicArn - The ARN of the topic you want to delete.

getEndpointAttributes

@Processor
public Map<String,String> getEndpointAttributes(String endpointArn)

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.

API reference

Parameters:

endpointArn - EndpointArn for GetEndpointAttributes input.

Returns:

Returns map of attributes that include CustomUserData, Enabled, and Token.

getPlatformApplicationAttributes

@Processor
public Map<String,String> getPlatformApplicationAttributes(String platformApplicationArn)

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.

API reference

Parameters:

platformApplicationArn - PlatformApplicationArn for GetPlatformApplicationAttributesInput.

Returns:

Returns map of attributes that include EventEndpointCreated, EventEndpointDeleted, EventEndpointUpdated and EventDeliveryFailure

getSubscriptionAttributes

@Processor
public Map<String,String> getSubscriptionAttributes(String subscriptionArn)

The GetSubscriptionAttributes action returns all of the properties of a subscription.

API reference

Parameters:

subscriptionArn - The ARN of the subscription whose properties you want to get

Returns:

A map of the subscription's attributes.

getTopicAttributes

@Processor
public Map<String,String> getTopicAttributes(String topicArn)

The GetTopicAttributes action returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

API reference

Parameters:

topicArn - The ARN of the topic whose properties you want to get.

Returns:

A map of the topic's attributes.

listEndpointsByPlatformApplication

@Processor
public ListEndpointsByPlatform listEndpointsByPlatformApplication(@Default(value="#[payload]")
                                                                             EndpointsByPlatform endpointsByPlatform)

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.

API reference

Parameters:

endpointsByPlatform - Container for the parameters to the ListEndpointsByPlatformApplication operation.

Returns:

Returns a list of the requester's endpoints.

listPlatformApplications

@Processor
public ListPlatformApplications listPlatformApplications(@Optional
                                                                    String nextToken)

Lists the platform application objects for the supported push notification services, such as APNS and GCM.

API reference

Parameters:

nextToken - NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

Returns:

a list of the requester's PlatformApplications.

listSubscriptions

@Processor
public ListSubscriptions listSubscriptions(@Optional
                                                      String nextToken)
                                               throws SNSException

The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

API reference

Parameters:

nextToken - Token returned by the previous ListSubscriptions request

Returns:

Returns a list of the requester's subscriptions.

Throws:

SNSException - Indicates an internal connector error.

listSubscriptionsByTopic

@Processor
public ListSubscriptionsByTopic listSubscriptionsByTopic(@Default(value="#[payload]")
                                                                    SubscriptionsByTopic subscriptionsByTopic)

The SubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new SubscriptionsByTopic call to get further results.

API reference

Parameters:

subscriptionsByTopic - Container for the parameters to the ListSubscriptionsByTopic operation.

Returns:

Returns a list of the subscriptions to a specific topic.

listTopics

@Processor
public ListTopics listTopics(@Optional
                                        String nextTopic)

The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

API reference

Parameters:

nextTopic - Token returned by the previous ListTopics request.

Returns:

Returns a list of the requester's topics.

publish

@Processor
public String publish(@Default(value="#[payload]")
                                 Publish publish)

The Publish action sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

API reference

Parameters:

publish - Container for the parameters to the publish operation.

Returns:

Unique identifier assigned to the published message.

removePermission

@Processor
public void removePermission(@Default(value="#[payload]")
                                        RemovePermission removePermission)

The RemovePermission action removes a statement from a topic's access control policy.

API reference

Parameters:

removePermission - Container for the parameters to the RemovePermission operation.

setEndpointAttributes

@Processor
public void setEndpointAttributes(@Default(value="#[payload]")
                                             Endpoint endpointAttributes)

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.

API reference

Parameters:

endpointAttributes - Container for the parameters to the SetEndpointAttributes operation.

setPlatformApplicationAttributes

@Processor
public void setPlatformApplicationAttributes(@Default(value="#[payload]")
                                                        PlatformApplication platformApplicationAttributes)

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.

API reference

Parameters:

platformApplicationAttributes - Container for the parameters to the SetPlatformApplicationAttributes operation.

setSubscriptionAttributes

@Processor
public void setSubscriptionAttributes(@Default(value="#[payload]")
                                                 SubscriptionAttributes subscriptionAttributes)
                                          throws SNSException

The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value.

API reference

Parameters:

subscriptionAttributes - Container for the parameters to the SetSubscriptionAttributes operation.

Throws:

SNSException - Indicates an internal connector error.

setTopicAttributes

@Processor
public void setTopicAttributes(@Default(value="#[payload]")
                                          TopicAttributes topicAttributes)

The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value.

API reference

Parameters:

topicAttributes - Container for the parameters to the SetTopicAttributes operation.

subscribe

@Processor
public String subscribe(@Default(value="#[payload]")
                                   Subscribe subscribe)

The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

API reference

Parameters:

subscribe - Container for the parameters to the Subscribe operation.

Returns:

The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).

unsubscribe

@Processor
public void unsubscribe(String subscriptionArn)

The Unsubscribe action deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the its topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

API reference

Parameters:

subscriptionArn - The ARN of the subscription to be deleted.

getClient

@NotNull
public com.amazonaws.services.sns.AmazonSNS getClient()

setClient

public void setClient(@NotNull
                      com.amazonaws.services.sns.AmazonSNS client)

getConfig

@NotNull
public SNSCommonConfig getConfig()

setConfig

public void setConfig(@NotNull
                      SNSCommonConfig config)