com.dpslink.flash.test

Class TestNFMessages

java.lang.Object

com.dpslink.flash.test.TestNFMessages

All Implemented Interfaces:

java.io.Serializable

public class TestNFMessages
extends java.lang.Object
implements java.io.Serializable

Tests Notification Framework message APIs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static ThreadServletContext	ivTSCTX
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
TestNFMessages()

Method Summary

Modifier and Type	Method and Description
protected static org.json.JSONArray	getFileAttachmentsAsJSON() Returns the collection of file attachment files as a JSON array of base 64 encoded JSON objects.
protected static org.json.JSONObject	getFromAsJSON() Returns the message from address as a JSON object.
protected static org.apache.velocity.VelocityContext	getMessageContent(java.lang.String type) Returns the Velocity Context content for message type.
protected static org.json.JSONArray	getRecipientAddrsAsJSON() Returns the collection of message recipient internet addresses as a JSON array.
protected static org.json.JSONArray	getRecipientUsersAsJSON() Returns the collection of message recipient users as a JSON array of contact ids.
protected static Customer	getSampleBillto() Returns a Customer object using values from the configured sample data spreadsheet file.
protected static Order	getSampleOrder() Returns an ERP Order object using values from the configured sample data spreadsheet file.
protected static RestockNotification	getSampleRestock(java.lang.String type) Returns a Restock Notification object using values from the configured sample data spreadsheet file.
protected static Shipper	getSampleShipper() Returns a Shipper object using values from the configured sample data spreadsheet file.
protected static boolean	getTemplateVersions(java.lang.String tmpid, java.lang.String dlvmeth) Tests the getTemplateVersions API.
protected static org.apache.velocity.VelocityContext	initTemplateData() Creates, initializes and returns a Velocity Context object that can then be used as the template data for a message.
static void	main(java.lang.String[] args) The main entry point for when the class is started from a command line.
protected static org.json.JSONArray	parseContent(org.apache.velocity.VelocityContext vc) Parses the message content when it is a Velocity Context.
protected static boolean	sendMessage(java.lang.String api, org.json.JSONObject data) Sends a formatted message to the Notification Framework for processing.
protected static boolean	sendNotification() Tests the sendNotification API.
protected static boolean	sendNotificationByAddress() Tests the sendNotificationByAddress API.
protected static boolean	sendTemplateNotification() Tests the sendTemplateNotification API.
protected static boolean	sendTemplateNotificationByAddress() Tests the sendTemplateNotificationByAddress API.
protected static boolean	sendTemplateNotificationForVersion() Tests the sendTemplateNotificationForVersion API.
protected static boolean	sendTemplateNotificationWithBody() Tests the sendTemplateNotificationWithBody API.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivTSCTX

protected static ThreadServletContext ivTSCTX

Constructor Detail

TestNFMessages

public TestNFMessages()

Method Detail

main

public static void main(java.lang.String[] args)

The main entry point for when the class is started from a command line.

Parameters:

args - (String[]) A string array of startup parameters.

sendNotification

protected static boolean sendNotification()
                                   throws java.lang.Exception

Tests the sendNotification API.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

sendNotificationByAddress

protected static boolean sendNotificationByAddress()
                                            throws java.lang.Exception

Tests the sendNotificationByAddress API.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

sendTemplateNotification

protected static boolean sendTemplateNotification()
                                           throws java.lang.Exception

Tests the sendTemplateNotification API.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

sendTemplateNotificationByAddress

protected static boolean sendTemplateNotificationByAddress()
                                                    throws java.lang.Exception

Tests the sendTemplateNotificationByAddress API.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

sendTemplateNotificationWithBody

protected static boolean sendTemplateNotificationWithBody()
                                                   throws java.lang.Exception

Tests the sendTemplateNotificationWithBody API.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

sendTemplateNotificationForVersion

protected static boolean sendTemplateNotificationForVersion()
                                                     throws java.lang.Exception

Tests the sendTemplateNotificationForVersion API.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

getFileAttachmentsAsJSON

protected static 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.

getFromAsJSON

protected static org.json.JSONObject getFromAsJSON()

Returns the message from address as a JSON object.

Returns:

JSONObject - The message from address.

getMessageContent

protected static org.apache.velocity.VelocityContext getMessageContent(java.lang.String type)

Returns the Velocity Context content for message type.

Parameters:

type - (String) The type of message for the desired content.

Returns:

VelocityContext - The message content.

getRecipientAddrsAsJSON

protected static org.json.JSONArray getRecipientAddrsAsJSON()

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

Returns:

JSONArray - The message recipient internet addresses.

getRecipientUsersAsJSON

protected static 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.

getSampleBillto

protected static Customer getSampleBillto()

Returns a Customer object using values from the configured sample data spreadsheet file.

Returns:

Customer - The Customer object.

getSampleOrder

protected static Order getSampleOrder()

Returns an ERP Order object using values from the configured sample data spreadsheet file.

Returns:

Order - The ERP Order object.

getSampleRestock

protected static RestockNotification getSampleRestock(java.lang.String type)

Returns a Restock Notification object using values from the configured sample data spreadsheet file.

Parameters:

type - (String) The current email type being processed. Will either be MailMessage.LOWSTOCK or MailMessage.RESTOCK.

Returns:

RestockNotification - The Restock Notification object.

getSampleShipper

protected static Shipper getSampleShipper()

Returns a Shipper object using values from the configured sample data spreadsheet file.

Returns:

Shipper - The Shipper object.

getTemplateVersions

protected static boolean getTemplateVersions(java.lang.String tmpid,
                                             java.lang.String dlvmeth)
                                      throws java.lang.Exception

Tests the getTemplateVersions API.

Parameters:

tmpid - (String) The template id to test.

dlvmeth - (String) The delivery method to test.

Returns:

boolean - true if the test is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during the test.

initTemplateData

protected static org.apache.velocity.VelocityContext initTemplateData()

Creates, initializes and returns a Velocity Context object that can then be used as the template data for a message.

Returns:

VelocityContext - An initialized Velocity Context object.

parseContent

protected static org.json.JSONArray parseContent(org.apache.velocity.VelocityContext vc)

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:

vc - (VelocityContext) The Velocity Context to parse.

Throws:

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

sendMessage

protected static 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 the send.