com.googlecode.fascinator.portal.process

Class EmailNotifier

java.lang.Object

com.googlecode.fascinator.portal.process.EmailNotifier

All Implemented Interfaces:

Processor

public class EmailNotifier
extends java.lang.Object
implements Processor

Template-aware email utility class.

Author:

Shilo Banihit

Constructor Summary

Constructors

Constructor and Description
EmailNotifier()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	email(java.lang.String oid, java.lang.String from, java.lang.String recipient, java.lang.String subject, java.lang.String body) Send the actual email.
boolean	emailAttachment(java.lang.String from, java.lang.String recipient, java.lang.String subject, java.lang.String body, byte[] attachData, java.lang.String attachDataType, java.lang.String attachFileName, java.lang.String attachDesc)
java.lang.String	getCollectionValues(com.googlecode.fascinator.common.JsonSimple emailConfig, com.googlecode.fascinator.common.JsonSimple tfPackage, java.lang.String varField)
boolean	process(java.lang.String id, java.lang.String inputKey, java.lang.String outputKey, java.lang.String stage, java.lang.String configFilePath, java.util.HashMap<java.lang.String,java.lang.Object> dataMap) Main processing method.
java.lang.String	sanitizeAndEvaluateStr(java.lang.String source, org.apache.velocity.VelocityContext context) Apart from evaluating the template using velocity context, this method also adds velocity's quiet reference and finally cleans up any punctuation left behind by empty references.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailNotifier

public EmailNotifier()

Method Detail

getCollectionValues

public java.lang.String getCollectionValues(com.googlecode.fascinator.common.JsonSimple emailConfig,
                                   com.googlecode.fascinator.common.JsonSimple tfPackage,
                                   java.lang.String varField)

sanitizeAndEvaluateStr

public java.lang.String sanitizeAndEvaluateStr(java.lang.String source,
                                      org.apache.velocity.VelocityContext context)
                                        throws org.apache.velocity.exception.ParseErrorException,
                                               org.apache.velocity.exception.MethodInvocationException,
                                               org.apache.velocity.exception.ResourceNotFoundException,
                                               java.io.IOException

Apart from evaluating the template using velocity context, this method also adds velocity's quiet reference and finally cleans up any punctuation left behind by empty references.

Parameters:

context: - velocity context

source: - email template

Returns:

: sanitized and velocity evaluated string

Throws:

org.apache.velocity.exception.ParseErrorException

org.apache.velocity.exception.MethodInvocationException

org.apache.velocity.exception.ResourceNotFoundException

java.io.IOException

process

public boolean process(java.lang.String id,
              java.lang.String inputKey,
              java.lang.String outputKey,
              java.lang.String stage,
              java.lang.String configFilePath,
              java.util.HashMap<java.lang.String,java.lang.Object> dataMap)
                throws java.lang.Exception

Main processing method. This class can comprise of multiple email configuration blocks, specified by 'id' array.

Specified by:

process in interface Processor

Throws:

java.lang.Exception

email

public boolean email(java.lang.String oid,
            java.lang.String from,
            java.lang.String recipient,
            java.lang.String subject,
            java.lang.String body)

Send the actual email.

Parameters:

oid -

from -

recipient -

subject -

body -

Returns:

emailAttachment

public boolean emailAttachment(java.lang.String from,
                      java.lang.String recipient,
                      java.lang.String subject,
                      java.lang.String body,
                      byte[] attachData,
                      java.lang.String attachDataType,
                      java.lang.String attachFileName,
                      java.lang.String attachDesc)
                        throws java.lang.Exception

Throws:

java.lang.Exception