com.dpslink.base.jdbc

Class JDBCLogWriter

java.lang.Object

com.dpslink.base.util.LogWriter

com.dpslink.base.jdbc.JDBCLogWriter

All Implemented Interfaces:

java.io.Serializable

public class JDBCLogWriter
extends LogWriter

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

Overrides the base LogWriter to provide logging to an alternate log file for JDBC functions.

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
private static org.apache.log4j.Logger	cvJDBCLog A reference to the JDBC log file.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.util.LogWriter

cvAlert, cvConfig, cvConsole, cvMainLog, DEBUG, ERROR, FATAL, GENPREFIX, INFO, WARN

Constructor Summary

Constructors

Constructor and Description
JDBCLogWriter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLogFileFolder() Returns the configured file path for JDBC log files.
static java.lang.String	getLogFileName() Returns the configured file name for JDBC log files.
static org.apache.log4j.Level	getLogLevel() Returns the current log level for the JDBC log.
static void	log(java.lang.Exception e) Writes a JDBC log file entry for the given exception.
static void	log(java.lang.String msgid) Writes a JDBC log file entry for the given message id.
static void	log(java.lang.String msgid, java.lang.Exception ex) Writes a JDBC 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 JDBC log file entry for the given message id and exception.
static void	log(java.lang.String msgid, java.lang.String... values) Writes a JDBC log file entry for the given message id.
protected static void	logMessage(org.apache.log4j.Level severity, java.lang.String msgtext) Writes a JDBC 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 JDBC log file entry for a separator (a series of dashes).
static void	setLogLevel(org.apache.log4j.Level severity) Sets the current log level for the JDBC log.
static void	write(java.lang.String s) Writes a JDBC log file entry for the given string.
static void	write(java.lang.String s, org.apache.log4j.Level severity) Writes a JDBC log file entry for the given string and severity level.

Methods inherited from class com.dpslink.base.util.LogWriter

dumpPropertiesToFile, dumpPropertiesToList, getAlertLevel, getStackTrace, log, parseMessage, parseMessage, sendAlertEmail, setAlertLevel

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

cvJDBCLog

private static org.apache.log4j.Logger cvJDBCLog

A reference to the JDBC log file.

Constructor Detail

JDBCLogWriter

public JDBCLogWriter()

Method Detail

log

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

Writes a JDBC 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 JDBC 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 JDBC 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 JDBC 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 JDBC log file entry for the given exception.

Parameters:

e - (Exception) The exception to log.

logMessage

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

Writes a JDBC log file entry for the given severity level and message text and sends an email if the message severity is configured for alert emails. Overrides logMessage in the shared LogWriter.

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 JDBC 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.

getLogFileFolder

public static java.lang.String getLogFileFolder()

Returns the configured file path for JDBC log files.

Returns:

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

getLogFileName

public static java.lang.String getLogFileName()

Returns the configured file name for JDBC 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 JDBC log.

Returns:

Level - The current log level.

setLogLevel

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

Sets the current log level for the JDBC log.

Parameters:

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

write

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

Writes a JDBC 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 JDBC 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).