com.aspc.DBObj.Email.Internal.parser

Class DefaultEmailMessageParser

java.lang.Object

com.aspc.DBObj.Email.Internal.parser.DefaultEmailMessageParser

All Implemented Interfaces:

EmailMessageParser

public class DefaultEmailMessageParser
extends java.lang.Object
implements EmailMessageParser

A default message parser for DBEmailSend.
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

18 Nov 2008

Author:

Padma

Constructor Summary

Constructors

Constructor and Description
DefaultEmailMessageParser()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<Variable>	createRunTimeJSONObjectVars(DBEmailSend emailSend, DBObject target, Contact recipient)
protected java.util.List<Variable>	createRunTimeVars(DBEmailSend emailSend, DBObject target, Contact recipient)
protected java.lang.String	parseBasePath(DBEmailSend base, java.lang.String parsingToken, java.lang.String pth, java.lang.String res, boolean isHtml) Parsing base path.
protected java.lang.String	parseExpressInterestLink(DBEmailSend emailSend, DBObject target, java.lang.String key, Contact recipient, java.lang.String text)
protected java.lang.String	parseGlobalsPath(DBEmailSend base, DBObject globals, java.lang.String parsingToken, java.lang.String pth, java.lang.String res, boolean isHtml) Parsing the globals path, the target object that linked to base DBEmailSend.
protected java.lang.String	parseInvitationLink(DBObject target, java.lang.String key, Contact recipient)
java.lang.String	parseMessage(DataSource ds, java.lang.String msg, DBEmailSend emailSend, Contact recipient, DBEmailRecipient[] allRecipientList, boolean isParseRecipient, boolean isHtml, boolean isValidating) Parsing the message for the corresponding EmailSend object.
java.lang.String	parseMessage(DataSource ds, java.lang.String msg, DBEmailSend emailSend, DBObject target, Contact recipient, DBEmailRecipient[] allRecipientList, boolean isParseRecipient, boolean isHtml, boolean isValidating) The original version of DBEmailSend.parseMessage().
protected java.lang.String	parseMessageNew(DataSource ds, java.lang.String msg, DBEmailSend emailSend, Contact recipient, DBObject target, DBObject globals, DBEmailRecipient[] allRecipientList, boolean isParseRecipient, boolean isHtml, boolean isValidating)
protected java.lang.String	parseRecipientPath(DBEmailSend base, DBObject recipient, DBEmailRecipient[] allRecipientList, java.lang.String parsingToken, java.lang.String pth, java.lang.String res, boolean isHtml) Parsing the Recipient based path.
protected java.lang.String	parseRestPath(DBEmailSend emailSend, JSONObject json, java.lang.String token, boolean isHtml)
protected java.lang.String	parseTargetPath(DBEmailSend base, DBObject target, java.lang.String parsingToken, java.lang.String pth, java.lang.String res, boolean isHtml) Parsing the target path, the target object that linked to base DBEmailSend.
protected java.lang.String	parseUnsubscribeLink(DBEmailSend emailSend, Contact recipient, java.lang.String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEmailMessageParser

public DefaultEmailMessageParser()

Method Detail

parseMessage

public java.lang.String parseMessage(DataSource ds,
                                     java.lang.String msg,
                                     DBEmailSend emailSend,
                                     Contact recipient,
                                     DBEmailRecipient[] allRecipientList,
                                     boolean isParseRecipient,
                                     boolean isHtml,
                                     boolean isValidating)
                              throws java.lang.Exception

Description copied from interface: EmailMessageParser

Parsing the message for the corresponding EmailSend object.

Specified by:

parseMessage in interface EmailMessageParser

Parameters:

ds - the data source

msg - the message

isValidating - the email template variable will be skipped if isValidating is true and ignoreValidating flag is checked for this template variable

Returns:

the value

Throws:

java.lang.Exception - Exception A serious problem

parseMessage

public java.lang.String parseMessage(DataSource ds,
                                     java.lang.String msg,
                                     DBEmailSend emailSend,
                                     DBObject target,
                                     Contact recipient,
                                     DBEmailRecipient[] allRecipientList,
                                     boolean isParseRecipient,
                                     boolean isHtml,
                                     boolean isValidating)
                              throws java.lang.Exception

The original version of DBEmailSend.parseMessage(). Important: No changes in here since it needs to hold the existing version of DBEmailSend.ParseMessage() which is used by every one.

Specified by:

parseMessage in interface EmailMessageParser

Parameters:

ds - the data source

msg - the message

emailSend - the email

recipient - the recipient

allRecipientList - all recipient list

target - target DBObject

isValidating - the email template variable will be skipped if isValidating is true and ignoreValidating flag is checked for this template variable

Returns:

the parsed message

Throws:

java.lang.Exception - Exception A serious problem

createRunTimeVars

protected java.util.List<Variable> createRunTimeVars(DBEmailSend emailSend,
                                                     DBObject target,
                                                     Contact recipient)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

createRunTimeJSONObjectVars

protected java.util.List<Variable> createRunTimeJSONObjectVars(DBEmailSend emailSend,
                                                               DBObject target,
                                                               Contact recipient)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

parseMessageNew

protected java.lang.String parseMessageNew(DataSource ds,
                                           java.lang.String msg,
                                           DBEmailSend emailSend,
                                           Contact recipient,
                                           DBObject target,
                                           DBObject globals,
                                           DBEmailRecipient[] allRecipientList,
                                           boolean isParseRecipient,
                                           boolean isHtml,
                                           boolean isValidating)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

parseRestPath

protected java.lang.String parseRestPath(DBEmailSend emailSend,
                                         JSONObject json,
                                         java.lang.String token,
                                         boolean isHtml)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

parseUnsubscribeLink

protected java.lang.String parseUnsubscribeLink(DBEmailSend emailSend,
                                                Contact recipient,
                                                java.lang.String text)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

parseInvitationLink

protected java.lang.String parseInvitationLink(DBObject target,
                                               java.lang.String key,
                                               Contact recipient)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

parseExpressInterestLink

protected java.lang.String parseExpressInterestLink(DBEmailSend emailSend,
                                                    DBObject target,
                                                    java.lang.String key,
                                                    Contact recipient,
                                                    java.lang.String text)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

parseGlobalsPath

protected java.lang.String parseGlobalsPath(DBEmailSend base,
                                            DBObject globals,
                                            java.lang.String parsingToken,
                                            java.lang.String pth,
                                            java.lang.String res,
                                            boolean isHtml)
                                     throws java.lang.Exception

Parsing the globals path, the target object that linked to base DBEmailSend.

Parameters:

base - the base object

globals -

parsingToken -

pth -

res -

isHtml -

Returns:

parsed value

Throws:

java.lang.Exception - Exception A serious problem

parseRecipientPath

protected java.lang.String parseRecipientPath(DBEmailSend base,
                                              DBObject recipient,
                                              DBEmailRecipient[] allRecipientList,
                                              java.lang.String parsingToken,
                                              java.lang.String pth,
                                              java.lang.String res,
                                              boolean isHtml)
                                       throws java.lang.Exception

Parsing the Recipient based path.

Parameters:

base - the base object

recipient -

allRecipientList - the recipients

parsingToken -

pth -

res -

isHtml -

Returns:

parsed value

Throws:

java.lang.Exception - Exception A serious problem

parseTargetPath

protected java.lang.String parseTargetPath(DBEmailSend base,
                                           DBObject target,
                                           java.lang.String parsingToken,
                                           java.lang.String pth,
                                           java.lang.String res,
                                           boolean isHtml)
                                    throws java.lang.Exception

Parsing the target path, the target object that linked to base DBEmailSend.

Parameters:

base - the base object

target -

parsingToken -

pth -

res -

isHtml -

Returns:

parsed value

Throws:

java.lang.Exception - Exception A serious problem

parseBasePath

protected java.lang.String parseBasePath(DBEmailSend base,
                                         java.lang.String parsingToken,
                                         java.lang.String pth,
                                         java.lang.String res,
                                         boolean isHtml)
                                  throws java.lang.Exception

Parsing base path.

Parameters:

base - the base object

parsingToken -

pth -

res -

isHtml -

Returns:

parsed value

Throws:

java.lang.Exception - Exception A serious problem