edu.usc.ict.iago.utils

Class ServletUtils

java.lang.Object

edu.usc.ict.iago.utils.ServletUtils

public class ServletUtils
extends java.lang.Object

Servlet utility functions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletUtils.DebugLevels The DebugLevel sets the verbosity of the logger, which is by default stored in catalina.out.

Constructor Summary

Constructors

Constructor and Description
ServletUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	isDataModeDb()
static boolean	isDataModeEmail()
static boolean	isDataModeLog()
static void	log(java.lang.String o, ServletUtils.DebugLevels level) Convenience method for printing statements.
protected static boolean	mailReady() Simple check to make sure mail is ready to be sent.
static void	sendMail(java.lang.String to, java.lang.String subject, java.lang.String body) Allows an email to be sent using the preset authentication patterns.
static void	setCredentials(java.lang.String user, java.lang.String pass, java.lang.String sender, java.lang.String smtpAuth, java.lang.String smtpHost, java.lang.String smtpPort) Sets the mail credentials for this servlet, which allows it to send email notifications.
static void	setDataModeDb(boolean dataMode_db)
static void	setDataModeEmail(boolean dataMode_email)
static void	setDataModeLog(boolean dataMode_log)
static void	setDebug(ServletUtils.DebugLevels debug) Sets DebugLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletUtils

public ServletUtils()

Method Detail

isDataModeDb

public static boolean isDataModeDb()

Returns:

the dataMode_db

setDataModeDb

public static void setDataModeDb(boolean dataMode_db)

Parameters:

dataMode_db - the dataMode_db to set

isDataModeEmail

public static boolean isDataModeEmail()

Returns:

the dataMode_email

setDataModeEmail

public static void setDataModeEmail(boolean dataMode_email)

Parameters:

dataMode_email - the dataMode_email to set

isDataModeLog

public static boolean isDataModeLog()

Returns:

the dataMode_log

setDataModeLog

public static void setDataModeLog(boolean dataMode_log)

Parameters:

dataMode_log - the dataMode_log to set

setCredentials

public static void setCredentials(java.lang.String user,
                                  java.lang.String pass,
                                  java.lang.String sender,
                                  java.lang.String smtpAuth,
                                  java.lang.String smtpHost,
                                  java.lang.String smtpPort)

Sets the mail credentials for this servlet, which allows it to send email notifications. Must be set before sending mail for each servlet. Multiple servlets may use idendical credentials.

Parameters:

user - the user name, e.g., iago

pass - the password, e.g., myPassword99

sender - the sender, required for some email systems, e.g., iago@website.com

smtpAuth - if the mail server uses smtp authentication (usually true, occasionally false)

smtpHost - the smtp host, e.g., exchange.website.com

smtpPort - the smtp port, e.g., 25

sendMail

public static void sendMail(java.lang.String to,
                            java.lang.String subject,
                            java.lang.String body)
                     throws java.io.IOException,
                            java.lang.Exception

Allows an email to be sent using the preset authentication patterns.

Parameters:

to -

subject -

body -

Throws:

java.io.IOException

AddressException

java.lang.Exception

log

public static void log(java.lang.String o,
                       ServletUtils.DebugLevels level)

Convenience method for printing statements. Has been modified in 2.1 to utilize Log4j2 internally. Future version will utilize Log4j2 directly, and this will be marked deprecated.

Parameters:

o -

setDebug

public static void setDebug(ServletUtils.DebugLevels debug)

Sets DebugLevel

Parameters:

debug - ERROR, WARN, SILENCED, DEBUG

mailReady

protected static boolean mailReady()

Simple check to make sure mail is ready to be sent.

Returns:

if mail has been configured