AmazonSNSDispatcher (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.aws.sns.sms.transformer.AmazonSNSDispatcher<M>

Type Parameters:

M - type Message or AsynchronousMessage. The Message.getRecipients() is phone numbers

M - as Message or AsynchronousMessage; of recipient type String (phone number) and Message.getPayload() as Text to send Note: The recipient # derivation logic should not be left to this adapter-level impl hence its kept String as any contact/user derivation logic should be anyway external before message is created. Similarly a message can't only be a text at the end so any dynamic text logic ambitions are also best left out.

All Implemented Interfaces:

BulkDispatcher<M>, GenericDispatcher<M>, Consumer<M>, org.apache.commons.collections.Transformer
```
public class AmazonSNSDispatcher<M extends SMS>
extends Object
implements BulkDispatcher<M>
```
AWS SNS SMS Integration Transformer

Recipient Type - String (phone#) Payload Type - String (SMS simple message string format)
Author:

Rajat Nayak, Arjun Dhar

See Also:

AsynchronousMessage

Constructor Summary

Constructors
Constructor and Description
`AmazonSNSDispatcher(AmazonSNSAuthenticationDetails auth, MessageDeliveryAttributes arnAccess, com.amazonaws.auth.BasicAWSCredentials awsCredentials, String regionsName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`broadcast(M msg)` Single Message Sent to Multiple Recipients
`void`	`close()` Shuts down the SNS client object, releasing any resources that might be held open.
`void`	`dispatch(List<M> message)` Sends nth Message to the nth Recipient
`void`	`dispatch(M msg)` Sends single message to single recipient Publish Message to a Single Number
`MessageType`	`evaluateType(Priority priority, Boolean isDirectMessage)` Set Type of Message.
`protected Map<String,com.amazonaws.services.sns.model.MessageAttributeValue>`	`generateSMSAttributesAndUpdateDerivedTypes(M msg)` Use AmazonSNSAuthenticationDetails object to create a Map of Default SMS attributes and also update `SMS.getSettings()`.type Refer to for Setting SMS attributes
`MessageDeliveryAttributes`	`getArnAccess()` Attribute Details for Message Delivery Reports
`AmazonSNSAuthenticationDetails`	`getAuthentication()` Stores the Authentication Details of the user
`com.amazonaws.auth.AWSCredentials`	`getAwsCredentials()` Credentials required to init a `AmazonSNSClientClient`
`String`	`getDefaultCountryCode()` Country Code of the recipient
`int`	`getMessagePriorityThresholdSecs()` If less than this amount of seconds then treat message as priority. Priority = `MessageType.TRANSACTIONAL` else `MessageType.PROMOTIONAL`
`com.amazonaws.regions.Regions`	`getRegions()` Enumeration of region names
`com.amazonaws.services.sns.AmazonSNSClient`	`getSnsClient()` Client for accessing Amazon SNS.
`void`	`init()`
`boolean`	`isFailFast()` Decides whether to continue with execution of code when a error occurs or simply throw the error
`void`	`publishToSingleNumber(Message message, Map<String,com.amazonaws.services.sns.model.MessageAttributeValue> smsAttributes)` Sends One message to One recipient
`void`	`setArnAccess(MessageDeliveryAttributes arnAccess)` Attribute Details for Message Delivery Reports
`void`	`setAuthentication(AmazonSNSAuthenticationDetails authentication)` Stores the Authentication Details of the user
`void`	`setAwsCredentials(com.amazonaws.auth.AWSCredentials awsCredentials)` Credentials required to init a `AmazonSNSClientClient`
`void`	`setDefaultCountryCode(String defaultCountryCode)` Country Code of the recipient
`void`	`setFailFast(boolean failFast)` Decides whether to continue with execution of code when a error occurs or simply throw the error
`void`	`setMessagePriorityThresholdSecs(int messagePriorityThresholdSecs)` If less than this amount of seconds then treat message as priority. Priority = `MessageType.TRANSACTIONAL` else `MessageType.PROMOTIONAL`
`void`	`setRegions(com.amazonaws.regions.Regions regions)` Enumeration of region names
`void`	`setSnsClient(com.amazonaws.services.sns.AmazonSNSClient snsClient)` Client for accessing Amazon SNS.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.neurosys.messenger.dispatchers.GenericDispatcher
accept, getSettings, transform

Methods inherited from interface java.util.function.Consumer
andThen

- Constructor Detail
  - AmazonSNSDispatcher
```
public AmazonSNSDispatcher(AmazonSNSAuthenticationDetails auth,
                           MessageDeliveryAttributes arnAccess,
                           com.amazonaws.auth.BasicAWSCredentials awsCredentials,
                           String regionsName)
```
    Parameters:
    
    auth - : Authentication Details to be used for sending the message
    
    snsCl - : client to be used for accessing SNS
    
    reg - : region to be used for the sms
    make sure that the operation to be performed is supported in the region For Regions and Countries supported for SMS messaging
- Method Detail
  - init
```
@PostConstruct
public void init()
```
  - dispatch
```
public void dispatch(M msg)
```
    Sends single message to single recipient
    Publish Message to a Single Number
    
    Specified by:
    
    dispatch in interface GenericDispatcher<M extends SMS>
  - broadcast
```
public void broadcast(M msg)
               throws Exception,
                      PartialTransactionException
```
    Single Message Sent to Multiple Recipients
    
    Specified by:
    
    broadcast in interface BulkDispatcher<M extends SMS>
    
    Type Parameters:
    
    M - type Message
    
    Throws:
    
    PartialTransactionException - in case of partial failures. Where PartialTransactionException.getFailed() are of type PayLoadException
    
    Exception - which can be of any type from AmazonSNSClient.publish(PublishRequest)
    
    See Also:
    
    AmazonSNSClient.publish(PublishRequest), Publish Message to a Multiple Phone Numbers
  - dispatch
```
public void dispatch(List<M> message)
              throws PartialTransactionException
```
    Sends nth Message to the nth Recipient
    
    Specified by:
    
    dispatch in interface BulkDispatcher<M extends SMS>
    
    Type Parameters:
    
    M - type Message
    
    Throws:
    
    PartialTransactionException. - Where PartialTransactionException.getFailed() are of type PayLoadException
    
    PartialTransactionException
  - publishToSingleNumber
```
public void publishToSingleNumber(Message message,
                                  Map<String,com.amazonaws.services.sns.model.MessageAttributeValue> smsAttributes)
```
    Sends One message to One recipient
    
    Type Parameters:
    
    M - type Message
    
    Parameters:
    
    smsAttributes - : Attributes of Message to be sent
    
    Throws:
    
    PartialTransactionException - in case of partial failures
    
    Exception - which can be of any type from AmazonSNSClient.publish(PublishRequest)
    
    See Also:
    
    AmazonSNSClient.publish(PublishRequest)
  - evaluateType
```
public MessageType evaluateType(Priority priority,
                                Boolean isDirectMessage)
```
    Set Type of Message.
    
    Parameters:
    
    priority - : priority of Message
    
    isDirectMessage - : Whether the message is of Direct type
    
    Returns:
    
    "Promotional" : if Message to be sent is of type Promotional "Transactional" : if Message to be sent is of type transactional
  - generateSMSAttributesAndUpdateDerivedTypes
```
protected Map<String,com.amazonaws.services.sns.model.MessageAttributeValue> generateSMSAttributesAndUpdateDerivedTypes(M msg)
```
    Use AmazonSNSAuthenticationDetails object to create a Map of Default SMS attributes and also update SMS.getSettings().type
    Refer to for Setting SMS attributes
    
    Parameters:
    
    settings - as AmazonMessageSettings, nullable false Details regarding SMS Attributes
    
    Returns:
    
    Map of key and value as MessageAttributeValue, nullable
  - close
```
public void close()
```
    Shuts down the SNS client object, releasing any resources that might be held open.
    
    See Also:
    
    AmazonWebServiceClient.shutdown()
  - getAuthentication
```
public AmazonSNSAuthenticationDetails getAuthentication()
```
    Stores the Authentication Details of the user
    
    See Also:
    
    AmazonSNSAuthenticationDetails
  - setAuthentication
```
public void setAuthentication(AmazonSNSAuthenticationDetails authentication)
```
    Stores the Authentication Details of the user
    
    See Also:
    
    AmazonSNSAuthenticationDetails
  - getSnsClient
```
public com.amazonaws.services.sns.AmazonSNSClient 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.AmazonSNSClient 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
  - getRegions
```
public com.amazonaws.regions.Regions getRegions()
```
    Enumeration of region names
    
    See Also:
    
    Amazon SNS Client
  - setRegions
```
public void setRegions(com.amazonaws.regions.Regions regions)
```
    Enumeration of region names
    
    See Also:
    
    Amazon SNS Client
  - getDefaultCountryCode
```
public String getDefaultCountryCode()
```
    Country Code of the recipient
    
    Default value:
    
    +91 (INDIA)
  - setDefaultCountryCode
```
public void setDefaultCountryCode(String defaultCountryCode)
```
    Country Code of the recipient
    
    Default value:
    
    +91 (INDIA)
  - setFailFast
```
public void setFailFast(boolean failFast)
```
    Decides whether to continue with execution of code when a error occurs or simply throw the error
    
    Default value:
    
    false i.e continue code execution
  - isFailFast
```
public boolean isFailFast()
```
    Decides whether to continue with execution of code when a error occurs or simply throw the error
    
    Default value:
    
    false i.e continue code execution
  - getMessagePriorityThresholdSecs
```
public int getMessagePriorityThresholdSecs()
```
    If less than this amount of seconds then treat message as priority.
    Priority = MessageType.TRANSACTIONAL else MessageType.PROMOTIONAL
    
    See Also:
    
    evaluateType(Priority, Boolean)
  - setMessagePriorityThresholdSecs
```
public void setMessagePriorityThresholdSecs(int messagePriorityThresholdSecs)
```
    If less than this amount of seconds then treat message as priority.
    Priority = MessageType.TRANSACTIONAL else MessageType.PROMOTIONAL
    
    See Also:
    
    evaluateType(Priority, Boolean)
  - getArnAccess
```
public MessageDeliveryAttributes getArnAccess()
```
    Attribute Details for Message Delivery Reports
    
    See Also:
    
    MessageDeliveryAttributes
  - setArnAccess
```
public void setArnAccess(MessageDeliveryAttributes arnAccess)
```
    Attribute Details for Message Delivery Reports
    
    See Also:
    
    MessageDeliveryAttributes
  - getAwsCredentials
```
public com.amazonaws.auth.AWSCredentials getAwsCredentials()
```
    Credentials required to init a AmazonSNSClientClient
    
    See Also:
    
    AWSCredentials
  - setAwsCredentials
```
public void setAwsCredentials(com.amazonaws.auth.AWSCredentials awsCredentials)
```
    Credentials required to init a AmazonSNSClientClient
    
    See Also:
    
    AWSCredentials

Class AmazonSNSDispatcher<M extends SMS>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.neurosys.messenger.dispatchers.GenericDispatcher

Methods inherited from interface java.util.function.Consumer

Constructor Detail

AmazonSNSDispatcher

Method Detail

init

dispatch

broadcast

dispatch

publishToSingleNumber

evaluateType

generateSMSAttributesAndUpdateDerivedTypes

close

getAuthentication

setAuthentication

getSnsClient

setSnsClient

getRegions

setRegions

getDefaultCountryCode

setDefaultCountryCode

setFailFast

isFailFast

getMessagePriorityThresholdSecs

setMessagePriorityThresholdSecs

getArnAccess

setArnAccess

getAwsCredentials

setAwsCredentials