com.neurosys.aws.sns.push.transformer

Class NotificationTools

java.lang.Object

com.neurosys.aws.sns.push.transformer.NotificationTools

public class NotificationTools
extends Object

Contains list of functions to be used while sending Push Notification

• Create Platform Application
  Creates a platform application object for one of the supported push notification services

Author:

Rajat Nayak

Constructor Summary

Constructors

Constructor and Description
NotificationTools(com.amazonaws.services.sns.AmazonSNS snsClient, PlatformDetails platformDetails)

Method Summary

Modifier and Type	Method and Description
com.amazonaws.services.sns.model.CreatePlatformApplicationResult	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.
com.amazonaws.services.sns.model.CreatePlatformEndpointResult	createPlatformEndpoint(String customData, String applicationArn, String instanceId) Create a Platform Endpoint
com.amazonaws.services.sns.model.CreateTopicResult	createTopic(String topicName) Creates a topic to which notifications can be published.
void	deletePlatformApplication(String applicationArn) Delete a Platform Application
void	deleteTopic(String topicArn)
Map<String,Object>	generateAndroidPayload(String message) Generates Payload for Android Platform
Map<String,Object>	generateIOSPayload(String message) Generates Payload for IOS Platform
PlatformDetails	getPlatformDetails() Details generated from Platform to which the Push Notification is to be published
com.amazonaws.services.sns.AmazonSNS	getSnsClient() Client for accessing Amazon SNS.
static String	jsonify(Object message) Convert Message Map to a JSON
com.amazonaws.services.sns.model.PublishResult	publish(String targetArn, String message) Publish a Notification Since we will be sending platform-specific payloads in messages using the Amazon SNS the data must be key-value pair strings and formatted as JSON with quotation marks escaped.
void	setPlatformDetails(PlatformDetails platformDetails) Details generated from Platform to which the Push Notification is to be published
void	setSnsClient(com.amazonaws.services.sns.AmazonSNS snsClient) Client for accessing Amazon SNS.
List<com.amazonaws.services.sns.model.SubscribeResult>	subscribeToTopic(String topicArn, String protocol, List<String> endpointArns) Subscribe Endpoints to the topic

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationTools

public NotificationTools(com.amazonaws.services.sns.AmazonSNS snsClient,
                         PlatformDetails platformDetails)

Method Detail

createPlatformApplication

public com.amazonaws.services.sns.model.CreatePlatformApplicationResult 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.

Requirements

• Application Name is the Name of which Amazon SNS Platform Application is to be created
• Platform Type is thePlatform to be used for sending Push Notification.
• Platform Principal is received from the notification service.
  PLatform Principal Value for different Services are
  
  • APNS/APNS_SANDBOX : "SSL certificate".
  • GCM : not applicable.
  • ADM : "client id".
  • WNS : "Package Security Identifier".
  • MPNS : "TLS certificate".
  • Baidu : "API key".
• Platform Credential is also received from the notification service.
  PLatform Credential Value for different Services are
  
  • APNS/APNS_SANDBOX : "private key".
  • GCM : "API key".
  • ADM : "client secret".
  • WNS : "secret key".
  • MPNS : "private key".
  • Baidu : "secret key".

createTopic

public com.amazonaws.services.sns.model.CreateTopicResult createTopic(String topicName)

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

Parameters:

topicName - : The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

createPlatformEndpoint

public com.amazonaws.services.sns.model.CreatePlatformEndpointResult createPlatformEndpoint(String customData,
                                                                                            String applicationArn,
                                                                                            String instanceId)

Create a Platform Endpoint

Parameters:

customData - : Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

applicationArn - : Arn of application for which Endpoint is to be created

instanceId - : Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

subscribeToTopic

public List<com.amazonaws.services.sns.model.SubscribeResult> subscribeToTopic(String topicArn,
                                                                               String protocol,
                                                                               List<String> endpointArns)
                                                                        throws PartialTransactionException

Subscribe Endpoints to the topic

Parameters:

topicArn - : The ARN of the topic you want to subscribe to.

protocol - : The protocol you want to use.
Supported protocols include:

• http - delivery of JSON-encoded message via HTTP POST
• https - delivery of JSON-encoded message via HTTPS POST
• email - delivery of message via SMTP
• email-json - delivery of JSON-encoded message via SMTP
• sms - delivery of message via SMS
• sqs - delivery of JSON-encoded message to an Amazon SQS queue
• application - delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
• lambda - delivery of JSON-encoded message to an AWS Lambda function.

endpointArns - : The endpoint that you want to receive notifications.
Endpoints vary by protocol:

• For the http protocol, the endpoint is an URL beginning with "http://"
• For the https protocol, the endpoint is a URL beginning with "https://"
• For the email protocol, the endpoint is an email address
• For the email-json protocol, the endpoint is an email address
• For the sms protocol, the endpoint is a phone number of an SMS-enabled device
• For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
• For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
• For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

Returns:

List of Results of the Subscribe operations returned by the service.

Throws:

PartialTransactionException

deleteTopic

public void deleteTopic(String topicArn)

Parameters:

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

deletePlatformApplication

public void deletePlatformApplication(String applicationArn)

Delete a Platform Application

Parameters:

applicationArn - : PlatformApplicationArn of platform application object to delete.

publish

public com.amazonaws.services.sns.model.PublishResult publish(String targetArn,
                                                              String message)

Publish a Notification Since we will be sending platform-specific payloads in messages using the Amazon SNS the data must be key-value pair strings and formatted as JSON with quotation marks escaped. JSON Formatted Message Data For sending messages to an app installed on devices for multiple platforms, We use Topic. Since it can be subscribed from multiple platforms, we need to define a default message in case we have not defined a platform specific payload for that particular platform

Parameters:

targetArn - : Topic or Endpoint Arn to which the Push Notification is to be published

message - : Notification to be published

generateAndroidPayload

public Map<String,Object> generateAndroidPayload(String message)

Generates Payload for Android Platform

Parameters:

message - : notification to be sent to android device

generateIOSPayload

public Map<String,Object> generateIOSPayload(String message)

Generates Payload for IOS Platform

Parameters:

message - : notification to be sent to android device TODO : Write Logic to create IOS Message Map

jsonify

public static String jsonify(Object message)

Convert Message Map to a JSON

getSnsClient

public com.amazonaws.services.sns.AmazonSNS getSnsClient()

Client for accessing Amazon SNS. All service calls made using this client are blocking, and will not return until the service call completes.

See Also:

Amazon SNS Client

setSnsClient

public void setSnsClient(com.amazonaws.services.sns.AmazonSNS snsClient)

Client for accessing Amazon SNS. All service calls made using this client are blocking, and will not return until the service call completes.

See Also:

Amazon SNS Client

getPlatformDetails

public PlatformDetails getPlatformDetails()

Details generated from Platform to which the Push Notification is to be published

setPlatformDetails

public void setPlatformDetails(PlatformDetails platformDetails)

Details generated from Platform to which the Push Notification is to be published