com.dpslink.flash.util

Class NotificationMessage

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.util.NotificationMessage

All Implemented Interfaces:

java.io.Serializable

public class NotificationMessage
extends MappedAttributesObject

A utility class for formulating Notification Framework messages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Base64.Encoder	cvEncoder The base 64 encoder used for converting byte arrays to strings.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NotificationMessage() Constructs a NotificationMessage object.
	NotificationMessage(java.lang.String type) Constructs a NotificationMessage object.

Method Summary

Modifier and Type	Method and Description
void	addFileAttachment(java.io.File value) Adds to the collection of file attachment file objects.
protected void	addRecipentsAdmin(JDBCConnectionInfo cninf, java.lang.String typesfx) Adds to the collection of message recipient objects for admin users when the current message type is for an admin message.
protected void	addRecipientAddr(javax.mail.internet.InternetAddress value) Adds to the collection of message recipient internet addresses.
void	addRecipients(java.lang.Object value) Adds to the collection of message recipient objects (Customer, User, ArrayList, etc.).
protected void	addRecipientUser(User value) Adds to the collection of message recipient users.
protected void	cullRecipientUsers(JDBCConnectionInfo cninf, java.lang.String typesfx) Discards message recipient users who don't have an interest in receiving notifications for the current message type.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
protected void	formatMessage(JDBCConnectionInfo cninf, java.lang.String typesfx) Formats a message and then sends the formatted message to the Notification Framework for processing.
protected void	formatMessageMassMail(JDBCConnectionInfo cninf, java.lang.String typesfx) Formats a mass mail message and then sends the formatted message to the Notification Framework for processing.
protected void	formatMessageSample(java.lang.String typesfx) Formats a sample message and then sends the formatted message to the Notification Framework for processing.
protected void	formatMessageString(java.lang.String typesfx) Formats a message and then sends the formatted message to the Notification Framework for processing.
protected void	formatMessageVelocity(java.lang.String typesfx) Formats a message and then sends the formatted message to the Notification Framework for processing.
java.lang.Object	getContent() Returns the message content object.
java.util.ArrayList<java.io.File>	getFileAttachments() Returns the collection of file attachment file objects.
protected org.json.JSONArray	getFileAttachmentsAsJSON() Returns the collection of file attachment files as a JSON array of base 64 encoded JSON objects.
java.lang.Object	getFrom() Returns the message from address object.
protected org.json.JSONObject	getFromAsJSON() Returns the message from address as a JSON object.
protected java.util.ArrayList<javax.mail.internet.InternetAddress>	getRecipientAddrs() Returns the collection of message recipient internet addresses.
protected org.json.JSONArray	getRecipientAddrsAsJSON() Returns the collection of message recipient internet addresses as a JSON array.
java.util.ArrayList<java.lang.Object>	getRecipients() Returns the collection of message recipient objects.
protected java.util.ArrayList<User>	getRecipientUsers() Returns the collection of message recipient users.
protected org.json.JSONArray	getRecipientUsersAsJSON() Returns the collection of message recipient users as a JSON array of contact ids.
java.lang.String	getSampleMethod() Returns the sample delivery method (email, sms, push).
boolean	getSampleMode() Returns the sample mode on/off state.
java.lang.String	getSampleVersion() Returns the sample version number.
java.lang.String	getSubject() Returns the message subject.
protected org.json.JSONArray	getSubstitutionsAsJSON() Returns the collection of message API substitution parameters as a JSON array.
java.lang.String	getTemplate() Returns the message template file path.
java.lang.String	getType() Returns the message type code.
java.lang.String	getTypeSuffix() Returns the message type code's suffix, which is the actual message type used by the Notification Framework (sans the "MailMessage." prefix).
protected boolean	isUserInterested(JDBCConnectionInfo cninf, User user, java.lang.String typesfx) Answers if a user is interested in receiving notifications for the given message type.
protected void	logSendFailure() Logs an error to the MAIN log for a send message failure.
protected javax.mail.internet.InternetAddress	makeInternetAddress(java.lang.String name, java.lang.String address) Creates an InternetAddress object from the given name and email address.
protected void	parseContent(JDBCConnectionInfo cninf) Parses the message content when it is a Velocity Context.
protected org.apache.velocity.VelocityContext	parseContentAlert() Parses the message content when it is a string for an alert message.
static org.apache.velocity.VelocityContext	parseContentAlert(java.lang.String content) Parses the message content when it is a string for an alert message.
protected void	parseRecipients(JDBCConnectionInfo cninf) Parses the collection of message recipients into either User objects or InternetAddress objects and adds to the respective collection.
protected void	parseRecipients(JDBCConnectionInfo cninf, java.lang.Object recipient) Parses the given message recipient object into either a User object or an InternetAddress object and adds to the respective collection.
protected void	parseRecipientsLowstockRestock(JDBCConnectionInfo cninf, RestockNotification restock) Parses the given lowstock/restock object into either a User recipient object or an InternetAddress recipient object and then resets this message's recipient accordingly.
void	send() Sends the message.
protected boolean	sendMessage(java.lang.String api, org.json.JSONObject data) Sends a formatted message to the Notification Framework for processing.
void	setContent(java.lang.Object value) Sets the message content object.
protected void	setContentAsHTML() Converts plain text message content to HTML content by enclosing the content within an HTML <pre> tag.
void	setFrom(java.lang.Object value) Sets the message from address object.
void	setSampleMethod(java.lang.String value) Sets the sample delivery method (email, sms, push).
void	setSampleMode(boolean value) Sets the sample mode on/off state.
void	setSampleVersion(java.lang.String value) Sets the sample version number.
void	setSubject(java.lang.String value) Sets the message subject.
protected void	setSubstitutionsAsJSON(org.json.JSONArray value) Sets the collection of message API substitution parameters as a JSON array.
void	setTemplate(java.lang.String value) Sets the message template file path.
void	setType(java.lang.String value) Sets the message type code.
protected void	throwNoRecipients() Throws a no recipients exception.

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvEncoder

private static java.util.Base64.Encoder cvEncoder

The base 64 encoder used for converting byte arrays to strings.

Constructor Detail

NotificationMessage

protected NotificationMessage()
                       throws java.lang.Exception

Constructs a NotificationMessage object.

Throws:

java.lang.Exception - - if an error occurs while constructing the NotificationMessage object.

NotificationMessage

public NotificationMessage(java.lang.String type)
                    throws java.lang.Exception

Constructs a NotificationMessage object.

Parameters:

type - (String) The type code for the message. Must be one of the predefined FlashMailMessage.MSG_* type constants or the base class MailMessage.MSG_* type constants.

Throws:

java.lang.Exception - - if an error occurs while constructing the NotificationMessage object.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. This implementation always returns false.

Specified by:

equals in class MappedAttributesObject

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

send

public void send()
          throws java.lang.Exception

Sends the message.

Throws:

java.lang.Exception - - if an error occurs while sending the message.

getContent

public java.lang.Object getContent()

Returns the message content object.

Returns:

Object - The message content.

setContent

public void setContent(java.lang.Object value)

Sets the message content object. The content may be a message text String, a message file name String, or a VelocityContext of template tags and values.

Parameters:

value - (Object) The object that contains the message content.

setContentAsHTML

protected void setContentAsHTML()

Converts plain text message content to HTML content by enclosing the content within an HTML <pre> tag. This method is intended for use when a plain text content is about to be sent as an email. Enclosing the content within <pre> preserves the plain text formatting (i.e. tabs, line spaces, etc.).

getFrom

public java.lang.Object getFrom()

Returns the message from address object.

Returns:

Object - The message from address.

getFromAsJSON

protected org.json.JSONObject getFromAsJSON()

Returns the message from address as a JSON object.

Returns:

JSONObject - The message from address.

setFrom

public void setFrom(java.lang.Object value)

Sets the message from address object. (Customer, User, ArrayList, etc.)

Parameters:

value - (Object) The object that contains the message from address.

addRecipients

public void addRecipients(java.lang.Object value)

Adds to the collection of message recipient objects (Customer, User, ArrayList, etc.).

Parameters:

value - (Object) The object that contains the recipient info.

addRecipentsAdmin

protected void addRecipentsAdmin(JDBCConnectionInfo cninf,
                                 java.lang.String typesfx)

Adds to the collection of message recipient objects for admin users when the current message type is for an admin message.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

getRecipients

public java.util.ArrayList<java.lang.Object> getRecipients()

Returns the collection of message recipient objects.

Returns:

ArrayList - The message recipients.

addFileAttachment

public void addFileAttachment(java.io.File value)

Adds to the collection of file attachment file objects. This method assumes the file resides in the server's local file system.

Parameters:

value - (File) The object for the file to attach.

getFileAttachments

public java.util.ArrayList<java.io.File> getFileAttachments()

Returns the collection of file attachment file objects.

Returns:

ArrayList - The file attachment files.

getFileAttachmentsAsJSON

protected org.json.JSONArray getFileAttachmentsAsJSON()

Returns the collection of file attachment files as a JSON array of base 64 encoded JSON objects.

Returns:

JSONArray - The file attachment files.

getSampleMethod

public java.lang.String getSampleMethod()

Returns the sample delivery method (email, sms, push).

Returns:

String - The sample delivery method.

setSampleMethod

public void setSampleMethod(java.lang.String value)

Sets the sample delivery method (email, sms, push).

Parameters:

value - (String) The sample delivery method.

getSampleMode

public boolean getSampleMode()

Returns the sample mode on/off state.

Returns:

boolean - The sample mode on/off state.

setSampleMode

public void setSampleMode(boolean value)

Sets the sample mode on/off state.

Parameters:

value - (boolean) true if sample mode is to be turned on, otherwise false (default).

getSampleVersion

public java.lang.String getSampleVersion()

Returns the sample version number.

Returns:

String - The sample version number.

setSampleVersion

public void setSampleVersion(java.lang.String value)

Sets the sample version number.

Parameters:

value - (String) The sample version number.

getSubject

public java.lang.String getSubject()

Returns the message subject.

Returns:

String - The message subject.

setSubject

public void setSubject(java.lang.String value)

Sets the message subject.

Parameters:

value - (String) The message subject.

getTemplate

public java.lang.String getTemplate()

Returns the message template file path.

Returns:

String - The full path to the template file.

setTemplate

public void setTemplate(java.lang.String value)

Sets the message template file path.

Parameters:

value - (String) The full path to the template file.

getType

public java.lang.String getType()

Returns the message type code.

Returns:

String - The message type code.

getTypeSuffix

public java.lang.String getTypeSuffix()

Returns the message type code's suffix, which is the actual message type used by the Notification Framework (sans the "MailMessage." prefix).

Returns:

String - The message type code's suffix.

setType

public void setType(java.lang.String value)

Sets the message type code.

Parameters:

value - (String) The message type code.

parseContent

protected void parseContent(JDBCConnectionInfo cninf)
                     throws java.lang.Exception

Parses the message content when it is a Velocity Context. Converts Flash objects found within the context (Customers, Users, Orders, etc.) into Notification Framework API substitution parameter objects.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

Throws:

java.lang.Exception - - if an error occurs during parsing.

parseContentAlert

protected org.apache.velocity.VelocityContext parseContentAlert()

Parses the message content when it is a string for an alert message. Converts the string content into a Velocity Context object.

Returns:

VelocityContext - The parsed content.

parseContentAlert

public static org.apache.velocity.VelocityContext parseContentAlert(java.lang.String content)

Parses the message content when it is a string for an alert message. Converts the string content into a Velocity Context object.

Parameters:

content - (String) The content to parse.

Returns:

VelocityContext - The parsed content.

parseRecipients

protected void parseRecipients(JDBCConnectionInfo cninf)
                        throws java.lang.Exception

Parses the collection of message recipients into either User objects or InternetAddress objects and adds to the respective collection.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

Throws:

java.lang.Exception - - if an error occurs during parsing.

parseRecipients

protected void parseRecipients(JDBCConnectionInfo cninf,
                               java.lang.Object recipient)
                        throws java.lang.Exception

Parses the given message recipient object into either a User object or an InternetAddress object and adds to the respective collection.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

recipient - (Object) An individual message recipient object.

Throws:

java.lang.Exception - - if an error occurs during parsing.

parseRecipientsLowstockRestock

protected void parseRecipientsLowstockRestock(JDBCConnectionInfo cninf,
                                              RestockNotification restock)
                                       throws java.lang.Exception

Parses the given lowstock/restock object into either a User recipient object or an InternetAddress recipient object and then resets this message's recipient accordingly.

If the lowstock/restock object's email address matches the email address of the object's user, then use the object's user as the recipient so that email/sms/push can be sent.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

restock - (RestockNotification) The lowstock/restock to parse.

Throws:

java.lang.Exception - - if an error occurs during parsing.

makeInternetAddress

protected javax.mail.internet.InternetAddress makeInternetAddress(java.lang.String name,
                                                                  java.lang.String address)

Creates an InternetAddress object from the given name and email address.

Parameters:

name - (String) The name associated with the email address.

address - (String) The email address.

Returns:

InternetAddress - An InternetAddress object for the specified name and address, or null if the specified address does not conform to RFC822 syntax.

addRecipientAddr

protected void addRecipientAddr(javax.mail.internet.InternetAddress value)

Adds to the collection of message recipient internet addresses.

Parameters:

value - (InternetAddress) The internet addresses that contains the recipient info.

getRecipientAddrs

protected java.util.ArrayList<javax.mail.internet.InternetAddress> getRecipientAddrs()

Returns the collection of message recipient internet addresses.

Returns:

ArrayList - The message recipient internet addresses.

getRecipientAddrsAsJSON

protected org.json.JSONArray getRecipientAddrsAsJSON()

Returns the collection of message recipient internet addresses as a JSON array.

Returns:

JSONArray - The message recipient internet addresses.

addRecipientUser

protected void addRecipientUser(User value)

Adds to the collection of message recipient users.

Parameters:

value - (User) The user that contains the recipient info.

getRecipientUsers

protected java.util.ArrayList<User> getRecipientUsers()

Returns the collection of message recipient users.

Returns:

ArrayList - The message recipient users.

getRecipientUsersAsJSON

protected org.json.JSONArray getRecipientUsersAsJSON()

Returns the collection of message recipient users as a JSON array of contact ids.

Returns:

JSONArray - The message recipient user contact ids.

cullRecipientUsers

protected void cullRecipientUsers(JDBCConnectionInfo cninf,
                                  java.lang.String typesfx)
                           throws java.lang.Exception

Discards message recipient users who don't have an interest in receiving notifications for the current message type.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Throws:

java.lang.Exception - - if an error occurs during culling.

getSubstitutionsAsJSON

protected org.json.JSONArray getSubstitutionsAsJSON()

Returns the collection of message API substitution parameters as a JSON array.

Returns:

JSONArray - The substitution parameters.

setSubstitutionsAsJSON

protected void setSubstitutionsAsJSON(org.json.JSONArray value)

Sets the collection of message API substitution parameters as a JSON array.

Parameters:

value - (JSONArray) The substitution parameters.

isUserInterested

protected boolean isUserInterested(JDBCConnectionInfo cninf,
                                   User user,
                                   java.lang.String typesfx)
                            throws java.lang.Exception

Answers if a user is interested in receiving notifications for the given message type.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

user - (User) The user to check.

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Returns:

boolean - true if the user is interested, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during checking.

formatMessage

protected void formatMessage(JDBCConnectionInfo cninf,
                             java.lang.String typesfx)
                      throws java.lang.Exception

Formats a message and then sends the formatted message to the Notification Framework for processing.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Throws:

java.lang.Exception - - if an error occurs during formatting.

formatMessageMassMail

protected void formatMessageMassMail(JDBCConnectionInfo cninf,
                                     java.lang.String typesfx)
                              throws java.lang.Exception

Formats a mass mail message and then sends the formatted message to the Notification Framework for processing.

Parameters:

cninf - (JDBCConnectionInfo) A JDBC connection information object.

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Throws:

java.lang.Exception - - if an error occurs during formatting.

formatMessageSample

protected void formatMessageSample(java.lang.String typesfx)
                            throws java.lang.Exception

Formats a sample message and then sends the formatted message to the Notification Framework for processing.

Parameters:

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Throws:

java.lang.Exception - - if an error occurs during formatting.

formatMessageString

protected void formatMessageString(java.lang.String typesfx)
                            throws java.lang.Exception

Formats a message and then sends the formatted message to the Notification Framework for processing. Invoked by formatMessage when the message content is a String.

Parameters:

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Throws:

java.lang.Exception - - if an error occurs during formatting.

formatMessageVelocity

protected void formatMessageVelocity(java.lang.String typesfx)
                              throws java.lang.Exception

Formats a message and then sends the formatted message to the Notification Framework for processing. Invoked by formatMessage when the message content is a Velocity Context.

Parameters:

typesfx - (String) The message type suffix for the current message type (sans the "MailMessage." prefix).

Throws:

java.lang.Exception - - if an error occurs during formatting.

sendMessage

protected boolean sendMessage(java.lang.String api,
                              org.json.JSONObject data)
                       throws java.lang.Exception

Sends a formatted message to the Notification Framework for processing.

Parameters:

api - (String) The name of the API to call.

data - (JSONObject) The data to be sent to the API.

Returns:

boolean - true if the processing was successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during sending.

logSendFailure

protected void logSendFailure()

Logs an error to the MAIN log for a send message failure.

throwNoRecipients

protected void throwNoRecipients()
                          throws java.lang.Exception

Throws a no recipients exception.

Throws:

java.lang.Exception - - the no recipients exception.