edu.uiuc.ncsa.security.util.mail

Class MailUtil

java.lang.Object

edu.uiuc.ncsa.security.util.configuration.TemplateUtil

edu.uiuc.ncsa.security.util.mail.MailUtil

All Implemented Interfaces:

Logable

Direct Known Subclasses:

ServletMailUtil

public class MailUtil
extends TemplateUtil
implements Logable

A utility for sending messages via SMTP or SMTPS using Java mail.

Created by Jeff Gaynor
on 10/5/11 at 1:18 PM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailUtil.MailEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDRESS_SEPARATOR The separator between email addresses.
static String	LEFT_DELIMITER The left-hand delimiter for replacements in templates.
static String	RIGHT_DELIMITER The right-hand delimiter for replacements in templates.

Fields inherited from class edu.uiuc.ncsa.security.util.configuration.TemplateUtil

REGEX_LEFT_DELIMITER, REGEX_RIGHT_DELIMITER

Constructor Summary

Constructors

Constructor and Description
MailUtil()
MailUtil(MailUtil.MailEnvironment me)
MailUtil(MyLoggingFacade myLogger)

Method Summary

Modifier and Type	Method and Description
void	debug(String x) Write a debug message to the log.
void	error(String x) Write an error message to the log.
MailUtil.MailEnvironment	getMailEnvironment()
String	getMessageTemplate()
MyLoggingFacade	getMyLogger()
Session	getSession(Properties props)
String	getSubjectTemplate()
void	info(String x) Write an informational message to the log
boolean	isDebugOn() Query if debugging is enabled for this logger.
boolean	isEnabled()
protected String	readTemplate(String fileName)
boolean	sendMessage(Map replacements) This takes a map of replacements for the templates and sends the message.
boolean	sendMessage(String subjectTemplate, String messageTemplate, Map replacements) This allows for sending with a specific subject and message template.
void	setDebugOn(boolean debugOn) Enable/disable debugging for this logger
void	setMessageTemplate(String messageTemplate)
void	setMyLogger(MyLoggingFacade myLogger)
void	setSubjectTemplate(String subjectTemplate)
void	warn(String x) Write a warning to the log.

Methods inherited from class edu.uiuc.ncsa.security.util.configuration.TemplateUtil

main, newReplaceAll, oldReplaceAll, replaceAll, rr

Methods inherited from class java.lang.Object

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

Field Detail

LEFT_DELIMITER

public static String LEFT_DELIMITER

The left-hand delimiter for replacements in templates. Must make a valid regex when combined with the key and right-hand delimiter.

RIGHT_DELIMITER

public static String RIGHT_DELIMITER

The right-hand delimiter for replacements in templates. Must make a valid regex when combined with the left-hand delimiter and key.

ADDRESS_SEPARATOR

public static String ADDRESS_SEPARATOR

The separator between email addresses. The default is a semi-colon.

Constructor Detail

MailUtil

public MailUtil(MyLoggingFacade myLogger)

MailUtil

public MailUtil()

MailUtil

public MailUtil(MailUtil.MailEnvironment me)

Method Detail

getSession

public Session getSession(Properties props)
                   throws NamingException

Throws:

NamingException

isEnabled

public boolean isEnabled()

getMailEnvironment

public MailUtil.MailEnvironment getMailEnvironment()

sendMessage

public boolean sendMessage(String subjectTemplate,
                           String messageTemplate,
                           Map replacements)

This allows for sending with a specific subject and message template. This is useful for internally generated messages that may need a lot of customization on the fly. Remember that a template has string delimited with ${KEY} which the replacements map (KEY, VALUE pairs) will render into VALUES.

Parameters:

subjectTemplate -

messageTemplate -

replacements -

Returns:

sendMessage

public boolean sendMessage(Map replacements)

This takes a map of replacements for the templates and sends the message.

This will return a true if the message succeeded and a false otherwise. It will not cause a failure outright, since a failed notification should not bring down your server.

Parameters:

replacements -

Returns:

getMessageTemplate

public String getMessageTemplate()
                          throws IOException

Throws:

IOException

setMessageTemplate

public void setMessageTemplate(String messageTemplate)

setSubjectTemplate

public void setSubjectTemplate(String subjectTemplate)

getSubjectTemplate

public String getSubjectTemplate()
                          throws IOException

Throws:

IOException

readTemplate

protected String readTemplate(String fileName)
                       throws IOException

Throws:

IOException

getMyLogger

public MyLoggingFacade getMyLogger()

setMyLogger

public void setMyLogger(MyLoggingFacade myLogger)

debug

public void debug(String x)

Description copied from interface: Logable

Write a debug message to the log.

Specified by:

debug in interface Logable

setDebugOn

public void setDebugOn(boolean debugOn)

Description copied from interface: Logable

Enable/disable debugging for this logger

Specified by:

setDebugOn in interface Logable

isDebugOn

public boolean isDebugOn()

Description copied from interface: Logable

Query if debugging is enabled for this logger.

Specified by:

isDebugOn in interface Logable

Returns:

info

public void info(String x)

Description copied from interface: Logable

Write an informational message to the log

Specified by:

info in interface Logable

warn

public void warn(String x)

Description copied from interface: Logable

Write a warning to the log. This indicates a severe, but non-fatal condition exists.

Specified by:

warn in interface Logable

error

public void error(String x)

Description copied from interface: Logable

Write an error message to the log. Typically this is invoked as the last command before throwing an exception.

Specified by:

error in interface Logable