com.dpslink.flash.db.util

Class SyncUsersTask.SyncLogWriter

java.lang.Object

com.dpslink.base.util.LogWriter

com.dpslink.flash.db.util.SyncUsersTask.SyncLogWriter

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SyncUsersTask

public static class SyncUsersTask.SyncLogWriter
extends LogWriter

An inner 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 synchronization functions.

All message keys retrieved by this class are automatically prefixed with "MSG.SyncUsersTask." when the message id is retrieved.

NOTE: THIS CLASS CONTAINS JUST A PARTIAL OVERRIDE OF METHODS FOUND IN LogWriter. CARE SHOULD BE TAKEN TO ONLY INVOKE THE METHODS THAT HAVE BEEN OVERRIDDEN.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.log4j.Logger	cvSyncLog A reference to the synchronization 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
SyncLogWriter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLogFileFolder() Returns the configured file path for sync log files.
static java.lang.String	getLogFileName() Returns the configured file name for sync log files.
static org.apache.log4j.Level	getLogLevel() Returns the current log level for the sync log.
static void	log(java.lang.String msgid) Writes a sync log file entry for the given message id.
static void	log(java.lang.String msgid, java.lang.String... values) Writes a sync log file entry for the given message id.
protected static void	logMessage(org.apache.log4j.Level severity, java.lang.String msgtext) Writes a sync log file entry for the given severity level and message text and sends an email if the message severity is configured for alert emails.
protected static java.lang.String	qualifyMsgId(java.lang.String msgid) Returns the given message id with "MSG.SyncUsersTask." prefixed to it.
static void	setLogLevel(org.apache.log4j.Level severity) Sets the current log level for the sync log.

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

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

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

cvSyncLog

private static org.apache.log4j.Logger cvSyncLog

A reference to the synchronization log file.

Constructor Detail

SyncLogWriter

public SyncLogWriter()

Method Detail

log

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

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

Parameters:

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

log

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

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

Parameters:

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

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[]).

logMessage

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

Writes a sync 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 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.

getLogFileFolder

public static java.lang.String getLogFileFolder()

Returns the configured file path for sync 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 sync 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 sync log.

Returns:

Level - The current log level.

setLogLevel

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

Sets the current log level for the sync log.

Parameters:

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

qualifyMsgId

protected static java.lang.String qualifyMsgId(java.lang.String msgid)

Returns the given message id with "MSG.SyncUsersTask." prefixed to it.

Parameters:

msgid - (String) The id for the message to qualify.

Returns:

String - The qualified results.