com.dpslink.base.util

Class LogWriter

java.lang.Object

com.dpslink.base.util.LogWriter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AS400LogWriter, ImportLogWriter, JDBCLogWriter, SyncCustomersTask.SyncLogWriter, SyncNotificationContactsTask.SyncLogWriter, SyncProductsTask.SyncLogWriter, SyncUsersTask.SyncLogWriter

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

A utility class for persisting events to a log file and for sending alert email messages when a configured severity level occurs.

All message keys retrieved by this class are assumed to be prefixed with "MSG.". Message keys supplied to this class' methods that are not already prefixed with "MSG." will be automatically prefixed when the key is retrieved.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Level	cvAlert The minimum severity level for triggering alert emails.
protected static java.util.Properties	cvConfig The log4j configuration properties.
protected static LogConsole	cvConsole A reference to the console logging class.
protected static org.apache.log4j.Logger	cvMainLog A reference to the MAIN log file.
static org.apache.log4j.Level	DEBUG The debug severity level.
static org.apache.log4j.Level	ERROR The error severity level.
static org.apache.log4j.Level	FATAL The fatal severity level.
protected static java.lang.String	GENPREFIX Generic text used to prefix an exception stack trace when no message id or other text is supplied.
static org.apache.log4j.Level	INFO The information severity level.
private static long	serialVersionUID The class' serialization version id.
static org.apache.log4j.Level	WARN The warning severity level.

Constructor Summary

Constructors

Constructor and Description
LogWriter()

Method Summary

Modifier and Type	Method and Description
static void	dumpPropertiesToFile() Dumps a sorted list of the logger's configuration property keys and values to a file named "_properties.log4j.txt" in the application's temp folder.
static java.util.ArrayList<java.lang.String>	dumpPropertiesToList() Returns a sorted list of the logger's configuration property keys and values.
static org.apache.log4j.Level	getAlertLevel() Returns the minimum severity level for sending alert emails.
static java.lang.String	getLogFileFolder() Returns the configured file path for MAIN log files.
static java.lang.String	getLogFileName() Returns the configured file name for MAIN log files.
static org.apache.log4j.Level	getLogLevel() Returns the current log level for the MAIN log.
static java.lang.String	getStackTrace(java.lang.Exception ex) Returns the stack trace for an exception as a string.
static void	log(java.lang.Exception e) Writes a MAIN log file entry for the given exception.
static void	log(MailException mex) Writes a MAIN log file entry for the given mail exception.
static void	log(java.lang.String msgid) Writes a MAIN log file entry for the given message id.
static void	log(java.lang.String msgid, java.lang.Exception ex) Writes a MAIN log file entry for the given message id and exception.
static void	log(java.lang.String msgid, java.lang.Exception ex, java.lang.String... values) Writes a MAIN log file entry for the given message id and exception.
static void	log(java.lang.String msgid, java.lang.String... values) Writes a MAIN log file entry for the given message id.
protected static void	logMessage(org.apache.log4j.Level severity, java.lang.String msgtext) Writes a MAIN log file entry for the given severity level and message text and sends an email if the message severity is configured for alert emails.
static void	logSeparator() Writes a MAIN log file entry for a separator (a series of dashes).
static java.lang.Object[]	parseMessage(java.lang.String msgtext) Parses the given message text to determine if the text contains a valid severity level indicator.
static java.lang.Object[]	parseMessage(java.lang.String msgtext, org.apache.log4j.Level severity) Parses the given message text to determine if the text contains a valid severity level indicator.
protected static void	sendAlertEmail(org.apache.log4j.Level severity, java.lang.String msgtext) Sends an email if the message severity is configured for alert emails.
static void	setAlertLevel(org.apache.log4j.Level severity) Sets the minimum severity level for sending alert emails.
private static void	setLogFileFolder() Sets the full file path for log files.
static void	setLogLevel(org.apache.log4j.Level severity) Sets the current log level for the MAIN log.
static void	write(java.lang.String s) Writes a MAIN log file entry for the given string.
static void	write(java.lang.String s, org.apache.log4j.Level severity) Writes a MAIN log file entry for the given string and severity level.

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

cvConfig

protected static java.util.Properties cvConfig

The log4j configuration properties.

cvConsole

protected static LogConsole cvConsole

A reference to the console logging class.

cvMainLog

protected static org.apache.log4j.Logger cvMainLog

A reference to the MAIN log file.

GENPREFIX

protected static final java.lang.String GENPREFIX

Generic text used to prefix an exception stack trace when no message id or other text is supplied.

DEBUG

public static final org.apache.log4j.Level DEBUG

The debug severity level. The DEBUG level designates informational events that are useful in debugging a process.

INFO

public static final org.apache.log4j.Level INFO

The information severity level. The INFO level designates informational messages that highlight a process or a phase of a process.

WARN

public static final org.apache.log4j.Level WARN

The warning severity level. The WARN level designates potentially harmful situations.

ERROR

public static final org.apache.log4j.Level ERROR

The error severity level. The ERROR level designates error events that may or may not allow a process to continue running.

FATAL

public static final org.apache.log4j.Level FATAL

The fatal severity level. The FATAL level designates very severe error events that typically result in a process aborting.

cvAlert

protected static org.apache.log4j.Level cvAlert

The minimum severity level for triggering alert emails.

Constructor Detail

LogWriter

public LogWriter()

Method Detail

log

public static void log(java.lang.String msgid)

Writes a MAIN log file entry for the given message id.

Parameters:

msgid - (String) The id for the message to log. If necessary, the msgid is automatically prefixed with "MSG.".

log

public static void log(java.lang.String msgid,
                       java.lang.String... values)

Writes a MAIN log file entry for the given message id.

Parameters:

msgid - (String) The id for the message to log. If necessary, the msgid is automatically prefixed with "MSG.".

values - (String) The value(s) to replace in the message text. This parameter uses the varargs feature and can therefore be passed as multiple parms (msgid, value1, value2, value3, valueN) or as an array (msgid, values[]).

log

public static void log(java.lang.String msgid,
                       java.lang.Exception ex)

Writes a MAIN log file entry for the given message id and exception. The exception stack trace is auto-appended to the end of the message with a line separator inserted between the message and the stack trace.

Parameters:

msgid - (String) The id for the message to log. If necessary, the msgid is automatically prefixed with "MSG.".

ex - (Exception) The exception to log.

log

public static void log(java.lang.String msgid,
                       java.lang.Exception ex,
                       java.lang.String... values)

Writes a MAIN log file entry for the given message id and exception. The exception stack trace is auto-appended to the end of the message with a line separator inserted between the message and the stack trace.

Parameters:

msgid - (String) The id for the message to log. If necessary, the msgid is automatically prefixed with "MSG.".

ex - (Exception) The exception to log.

values - (String) The value(s) to replace in the message text. This parameter uses the varargs feature and can therefore be passed as multiple parms (msgid, value1, value2, value3, valueN) or as an array (msgid, values[]).

log

public static void log(java.lang.Exception e)

Writes a MAIN log file entry for the given exception.

Parameters:

e - (Exception) The exception to log.

log

public static void log(MailException mex)

Writes a MAIN log file entry for the given mail exception. Alert emails are never sent for mail exceptions, regardless of the message's severity.

Parameters:

mex - (MailException) The exception to log.

logMessage

protected static void logMessage(org.apache.log4j.Level severity,
                                 java.lang.String msgtext)

Writes a MAIN log file entry for the given severity level and message text and sends an email if the message severity is configured for alert emails.

Parameters:

severity - (Level) The severity of the message. Must be one of the defined constants (DEBUG, INFO, WARN, ERROR or FATAL).

msgtext - (String) The text for the message to log and email.

logSeparator

public static void logSeparator()

Writes a MAIN log file entry for a separator (a series of dashes). The separator is always logged using the logger's configured logging level. Typically used to denote the beginning of application startup.

dumpPropertiesToFile

public static void dumpPropertiesToFile()

Dumps a sorted list of the logger's configuration property keys and values to a file named "_properties.log4j.txt" in the application's temp folder.

dumpPropertiesToList

public static java.util.ArrayList<java.lang.String> dumpPropertiesToList()

Returns a sorted list of the logger's configuration property keys and values.

Returns:

ArrayList - The sorted list.

getAlertLevel

public static org.apache.log4j.Level getAlertLevel()

Returns the minimum severity level for sending alert emails.

Returns:

Level - The minimum severity level.

setAlertLevel

public static void setAlertLevel(org.apache.log4j.Level severity)

Sets the minimum severity level for sending alert emails. This method does not allow the minimum to be less than WARN.

Parameters:

severity - (Level) The minimum severity level. Must be one of the defined constants (DEBUG, INFO, WARN, ERROR or FATAL) or OFF.

getLogFileFolder

public static java.lang.String getLogFileFolder()

Returns the configured file path for MAIN log files.

Returns:

String - The file path to the log file folder. Includes trailing file separator character.

setLogFileFolder

private static void setLogFileFolder()

Sets the full file path for log files. Log files are assumed to reside in folder within Profile.SITE_PATH.

getLogFileName

public static java.lang.String getLogFileName()

Returns the configured file name for MAIN log files.

Returns:

String - The file name for log files.

getLogLevel

public static org.apache.log4j.Level getLogLevel()

Returns the current log level for the MAIN log.

Returns:

Level - The current log level.

setLogLevel

public static void setLogLevel(org.apache.log4j.Level severity)

Sets the current log level for the MAIN log.

Parameters:

severity - (Level) The current log level. Must be one of the defined constants (DEBUG, INFO, WARN, ERROR or FATAL) or OFF.

getStackTrace

public static java.lang.String getStackTrace(java.lang.Exception ex)

Returns the stack trace for an exception as a string.

Parameters:

ex - (Exception) An exception.

Returns:

String - The given exception's stack trace.

parseMessage

public static java.lang.Object[] parseMessage(java.lang.String msgtext)

Parses the given message text to determine if the text contains a valid severity level indicator. Returns a 2D object array where the 1st element is the severity level and the 2nd element is the actual message text. If the supplied value does not contain a valid severity level indicator, the ERROR level is assumed.

Parameters:

msgtext - (String) The text to parse.

Returns:

Object[] - A 2D array containing the message severity level and the message text.

parseMessage

public static java.lang.Object[] parseMessage(java.lang.String msgtext,
                                              org.apache.log4j.Level severity)

Parses the given message text to determine if the text contains a valid severity level indicator. Returns a 2D object array where the 1st element is the severity level and the 2nd element is the actual message text. If the supplied value does not contain a valid severity level indicator, the given level is used.

Parameters:

msgtext - (String) The text to parse.

severity - (Level) The default severity of the message if the message does not contain its own severity. Must be one of the defined constants (DEBUG, INFO, WARN, ERROR or FATAL).

Returns:

Object[] - A 2D array containing the message severity level and the message text.

sendAlertEmail

protected static void sendAlertEmail(org.apache.log4j.Level severity,
                                     java.lang.String msgtext)

Sends an email if the message severity is configured for alert emails.

Parameters:

severity - (Level) The severity of the message. Must be one of the defined constants (DEBUG, INFO, WARN, ERROR or FATAL).

msgtext - (String) The text for the message email.

write

public static void write(java.lang.String s)

Writes a MAIN log file entry for the given string. The severity level is assumed to be INFO.

Parameters:

s - (String) The string to write.

write

public static void write(java.lang.String s,
                         org.apache.log4j.Level severity)

Writes a MAIN log file entry for the given string and severity level.

Parameters:

s - (String) The string to write.

severity - (Level) The severity of the message. Must be one of the defined constants (DEBUG, INFO, WARN, ERROR or FATAL).