com.ibm.itim.logging
Class SystemLog

java.lang.Object
  com.ibm.itim.logging.SystemLog

public class SystemLog
extends java.lang.Object

External class that provides an interface for message logging. The supported messages types are INFO, WARNING, and ERROR. The messages will be logged by message key, and the logged messages will be localized using the registered resource bundle. The concept of categories is introduced to support the hierarchical control of the message logging. This class supports Logging toolkit JLOG and Log4j, by default JLOG is used. When JLOG is used, all the message logging goes to the message log file while the debug information goes to the trace file. When Log4j is used, both message logging and debug infomation will go to the same file as specified in the Log4j logging properties. The support for Log4j will be dropped in the next major release and all the deprecated methods and constants will also be removed in the next major release.

Field Summary

static int	DEBUG_INFO Deprecated. SystemLog only supports message logging with type of ERROR, WARNING, or INFO. DEBUG_INFO is mapped to DEBUG_MAX in JLOG.
static java.lang.String	ENROLE_BASE_CATEGORY Base category name also used as default category name.
static java.lang.String	ENROLE_SECURITY_CATEGORY category name specifically defined for security-related message logging.
static int	ERROR Defines an Error message that indicates error events.
static int	FATAL_ERROR Deprecated. Use ERROR instead.
static int	INFO Defines an Information message that highlights the progress of the application.
static int	NON_FATAL_ERROR Deprecated. Use ERROR instead.
static int	WARNING Defines a Warning message that indicates potentially harmful situations.

Method Summary

static SystemLog	getInstance() Returns an instance of SystemLog, creating a new one if necessary.
int	getPriorityLevel(java.lang.Object src) Accessor method for a category's priority level.
int	getPriorityLevel(java.lang.String category) Accessor method for a category's priority level.
boolean	getTraceExceptions() Deprecated. This method will be removed in the next major release. Exception will always be traced.
void	logDebug(java.lang.Object src, java.lang.Object msg) Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.text().
void	logDebug(java.lang.Object src, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logDebug(java.lang.String category, java.lang.Object msg) Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.text().
void	logDebug(java.lang.String category, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logError(java.lang.Object src, java.lang.Object msg) Log an error message.
void	logError(java.lang.Object src, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use logError(Object src, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logError(java.lang.Object src, java.lang.String srcMethod, java.lang.String key) Log an error message, by key.
void	logError(java.lang.Object src, java.lang.String srcMethod, java.lang.String key, java.lang.Object[] parms) Log an error message, by key, with an array of run-time parameter.
void	logError(java.lang.String category, java.lang.Object msg) Log a error message.
void	logError(java.lang.String category, java.lang.Object src, java.lang.String srcMethod, java.lang.String key) Log an error message, by key.
void	logError(java.lang.String category, java.lang.Object src, java.lang.String srcMethod, java.lang.String key, java.lang.Object[] parms) Log an error message, by key, with an array of run-time parameters.
void	logError(java.lang.String category, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use logError(String category, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logErrorNonTranslated(java.lang.String category, java.lang.String source, java.lang.String method, java.lang.Object msg) Writes the specified string as an error log record to the message log.
void	logFatal(java.lang.Object src, java.lang.Object msg) Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.
void	logFatal(java.lang.Object src, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.
void	logFatal(java.lang.String category, java.lang.Object msg) Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.
void	logFatal(java.lang.String category, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.
void	logInformation(java.lang.Object src, java.lang.Object msg) Log an information message.
void	logInformation(java.lang.Object src, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use logInformation(Object src, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logInformation(java.lang.Object src, java.lang.String srcMethod, java.lang.String key) Log an information message, by key.
void	logInformation(java.lang.Object src, java.lang.String srcMethod, java.lang.String key, java.lang.Object[] parms) Log an information message, by key, with an array of run-time parameters.
void	logInformation(java.lang.String category, java.lang.Object msg) Log an information message.
void	logInformation(java.lang.String category, java.lang.Object src, java.lang.String srcMethod, java.lang.String key) Log an information message, by key.
void	logInformation(java.lang.String category, java.lang.Object src, java.lang.String srcMethod, java.lang.String key, java.lang.Object[] parms) Log an information message, by key, with an array of run-time parameters.
void	logInformation(java.lang.String category, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use logInformation(String category, Object msg). Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logInformationNonTranslated(java.lang.String category, java.lang.String source, java.lang.String method, java.lang.Object msg) Writes the specified string as an informational log record to the message log.
void	logWarning(java.lang.Object src, java.lang.Object msg) Log a warning message.
void	logWarning(java.lang.Object src, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use logWarning(Object src, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logWarning(java.lang.Object src, java.lang.String srcMethod, java.lang.String key) Log a warning message, by key.
void	logWarning(java.lang.Object src, java.lang.String srcMethod, java.lang.String key, java.lang.Object[] parms) Log a warning message, by key, with an array of run-time parameters.
void	logWarning(java.lang.String category, java.lang.Object msg) Log a warning message.
void	logWarning(java.lang.String category, java.lang.Object src, java.lang.String srcMethod, java.lang.String key) Log a warning message, by key.
void	logWarning(java.lang.String category, java.lang.Object src, java.lang.String srcMethod, java.lang.String key, java.lang.Object[] parms) Log a warning message, by key, with an array of run-time parameter.
void	logWarning(java.lang.String category, java.lang.Object msg, java.lang.Throwable e) Deprecated. This method will be removed in the next major release. Use logWarning(String category, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().
void	logWarningNonTranslated(java.lang.String category, java.lang.String source, java.lang.String method, java.lang.Object msg) Writes the specified string as an warning log record to the message log.
void	setPriorityLevel(java.lang.Object src, int priority) Mutator method for a category's priority level.
void	setPriorityLevel(java.lang.String category, int priority) Mutator method for a category's priority level.
void	setTraceExceptions(boolean traceExceptions) Deprecated. This method will be removed in the next major release. Exception will always be traced.

Methods inherited from class java.lang.Object

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

Field Detail

ENROLE_BASE_CATEGORY

public static final java.lang.String ENROLE_BASE_CATEGORY

Base category name also used as default category name.

See Also:

Constant Field Values

ENROLE_SECURITY_CATEGORY

public static final java.lang.String ENROLE_SECURITY_CATEGORY

category name specifically defined for security-related message logging.

See Also:

Constant Field Values

FATAL_ERROR

public static final int FATAL_ERROR

Deprecated. Use ERROR instead.

See Also:

Constant Field Values

NON_FATAL_ERROR

public static final int NON_FATAL_ERROR

Deprecated. Use ERROR instead.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Defines an Error message that indicates error events.

See Also:

Constant Field Values

WARNING

public static final int WARNING

Defines a Warning message that indicates potentially harmful situations.

See Also:

Constant Field Values

INFO

public static final int INFO

Defines an Information message that highlights the progress of the application.

See Also:

Constant Field Values

DEBUG_INFO

public static final int DEBUG_INFO

Deprecated. SystemLog only supports message logging with type of ERROR, WARNING, or INFO. DEBUG_INFO is mapped to DEBUG_MAX in JLOG.

See Also:

Constant Field Values

Method Detail

getInstance

public static SystemLog getInstance()

Returns an instance of SystemLog, creating a new one if necessary.

Returns:

SystemLog singleton (unique) instance of SystemLog.

logDebug

public void logDebug(java.lang.Object src,
                     java.lang.Object msg)

Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.text().

Log a debug message. Debug messages are fine-grained informational events that are most useful to debug an application. The debug message will be logged to the trace file.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

logDebug

public void logDebug(java.lang.Object src,
                     java.lang.Object msg,
                     java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log a debug message. Debug messages are fine-grained informational events that are most useful to debug an application. The debug message will be logged to the trace file.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logDebug

public void logDebug(java.lang.String category,
                     java.lang.Object msg)

Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.text().

Log a debug message. Debug messages are fine-grained informational events that are most useful to debug an application. The debug message will be logged to the trace file.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

logDebug

public void logDebug(java.lang.String category,
                     java.lang.Object msg,
                     java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log a debug message. Debug messages are fine-grained informational events that are most useful to debug an application. The debug message will be logged to the trace file.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logInformation

public void logInformation(java.lang.Object src,
                           java.lang.Object msg)

Log an information message. Information messages highlight the progress of the application at a coarse-grained level. The message will be logged to the message log file without translation. For localizable information message logging, use logInformation(Object src, String srcMethod, String key) instead.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

logInformation

public void logInformation(java.lang.Object src,
                           java.lang.Object msg,
                           java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use logInformation(Object src, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log an information message. Information messages highlight the progress of the application at a coarse-grained level. The message will be logged to the message log file without translation while the Throwable will be logged to the trace file.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logInformation

public void logInformation(java.lang.Object src,
                           java.lang.String srcMethod,
                           java.lang.String key)

Log an information message, by key. The logged message will be localized.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

logInformation

public void logInformation(java.lang.Object src,
                           java.lang.String srcMethod,
                           java.lang.String key,
                           java.lang.Object[] parms)

Log an information message, by key, with an array of run-time parameters. The logged message will be Localized.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

parms - An array of parameters to be inserted into the message.

logInformation

public void logInformation(java.lang.String category,
                           java.lang.Object msg)

Log an information message. Information messages highlight the progress of the application at a coarse-grained level. The message will be logged to the message log file without translation. For localizable information message logging, use logInformation(String category, Object src, String srcMethod, String key) instead.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

logInformation

public void logInformation(java.lang.String category,
                           java.lang.Object msg,
                           java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use logInformation(String category, Object msg). Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log an information message. Information messages highlight the progress of the application at a coarse-grained level. The message will be logged to the message log file without translation.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logInformation

public void logInformation(java.lang.String category,
                           java.lang.Object src,
                           java.lang.String srcMethod,
                           java.lang.String key)

Log an information message, by key. The logged message will be Localized.

Parameters:

category - A dot separated category name.

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

logInformation

public void logInformation(java.lang.String category,
                           java.lang.Object src,
                           java.lang.String srcMethod,
                           java.lang.String key,
                           java.lang.Object[] parms)

Log an information message, by key, with an array of run-time parameters. The logged message will be Localized.

Parameters:

category - A dot separated category name.

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

parms - An array of parameters to be inserted into the message.

logWarning

public void logWarning(java.lang.Object src,
                       java.lang.Object msg)

Log a warning message. Warning messages are messages that indicate potentially harmful situations. The message will be logged to the message log file without translation. For localizable warning message logging, use logWarning(Object src, String srcMethod, String key) instead.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

logWarning

public void logWarning(java.lang.Object src,
                       java.lang.Object msg,
                       java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use logWarning(Object src, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log a warning message. Warning messages are informational messages that indicate potentially harmful situations. The message will be logged to the message log file without translation.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logWarning

public void logWarning(java.lang.Object src,
                       java.lang.String srcMethod,
                       java.lang.String key)

Log a warning message, by key. The logged message will be Localized.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

logWarning

public void logWarning(java.lang.Object src,
                       java.lang.String srcMethod,
                       java.lang.String key,
                       java.lang.Object[] parms)

Log a warning message, by key, with an array of run-time parameters. The logged message will be Localized.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

parms - An array of parameters to be inserted into the message.

logWarning

public void logWarning(java.lang.String category,
                       java.lang.Object msg)

Log a warning message. Warning messages are informational messages that indicate potentially harmful situations. The message will be logged to the message log file without translation. For localizable warning message logging, use logWarning(String category, Object src, String srcMethod, String key) instead.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

logWarning

public void logWarning(java.lang.String category,
                       java.lang.Object msg,
                       java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use logWarning(String category, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log a warning message. Warning messages are informational messages that indicate potentially harmful situations. The message will be logged to the message log file without translation.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logWarning

public void logWarning(java.lang.String category,
                       java.lang.Object src,
                       java.lang.String srcMethod,
                       java.lang.String key)

Log a warning message, by key. The logged message will be Localized.

Parameters:

category - A dot separated category name.

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

logWarning

public void logWarning(java.lang.String category,
                       java.lang.Object src,
                       java.lang.String srcMethod,
                       java.lang.String key,
                       java.lang.Object[] parms)

Log a warning message, by key, with an array of run-time parameter. The logged message will be Localized.

Parameters:

category - A dot separated category name.

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

parms - An array of parameters to be inserted into the message.

logError

public void logError(java.lang.Object src,
                     java.lang.Object msg)

Log an error message. Error messages are messages that indicate error events that might still allow the application to continue running. The message will be logged to the message log file without translation. For localizable error message logging, use logError(Object src, String srcMethod, String key) instead.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

logError

public void logError(java.lang.Object src,
                     java.lang.Object msg,
                     java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use logError(Object src, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log an error message. Error messages are messages that indicate error events that might still allow the application to continue running. The message will be logged to the message log file without translation.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logError

public void logError(java.lang.Object src,
                     java.lang.String srcMethod,
                     java.lang.String key)

Log an error message, by key. The logged message will be Localized.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

logError

public void logError(java.lang.Object src,
                     java.lang.String srcMethod,
                     java.lang.String key,
                     java.lang.Object[] parms)

Log an error message, by key, with an array of run-time parameter. The logged message will be Localized.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

parms - An array of parameters to be inserted into the message.

logError

public void logError(java.lang.String category,
                     java.lang.Object msg)

Log a error message. Error messages are messages that indicate error events that might still allow the application to continue running. The message will be logged to the message log file without translation. For localizable error message logging, use logError(String category, Object src, String srcMethod, String key) instead.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged, which is already Log.

logError

public void logError(java.lang.String category,
                     java.lang.Object msg,
                     java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. Use logError(String category, Object msg) instead. Throwable should be traced instead of logged as part of message. For Throwable tracing, Use JLogUtil.getTraceLogger() to get PDLogger, then use PDLogger.exception().

Log an error message. Error messages are messages that indicate error events that might still allow the application to continue running. The message will be logged to the message log file without translation.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logInformationNonTranslated

public void logInformationNonTranslated(java.lang.String category,
                                        java.lang.String source,
                                        java.lang.String method,
                                        java.lang.Object msg)

Writes the specified string as an informational log record to the message log. This string is used as is, no translation.

Parameters:

category - A dot separated category name.

source - String describing the originator of the log record.

method - String describing the method that the log record was created from.

msg - Text to be written as the content of the log message.

logWarningNonTranslated

public void logWarningNonTranslated(java.lang.String category,
                                    java.lang.String source,
                                    java.lang.String method,
                                    java.lang.Object msg)

Writes the specified string as an warning log record to the message log. This string is used as is, no translation.

Parameters:

category - A dot separated category name.

source - String describing the originator of the log record.

method - String describing the method that the log record was created from.

msg - Text to be written as the content of the log message.

logErrorNonTranslated

public void logErrorNonTranslated(java.lang.String category,
                                  java.lang.String source,
                                  java.lang.String method,
                                  java.lang.Object msg)

Writes the specified string as an error log record to the message log. This string is used as is, no translation.

Parameters:

category - A dot separated category name.

source - String describing the originator of the log record.

method - String describing the method that the log record was created from.

msg - Text to be written as the content of the log message.

logError

public void logError(java.lang.String category,
                     java.lang.Object src,
                     java.lang.String srcMethod,
                     java.lang.String key)

Log an error message, by key. The logged message will be Localized.

Parameters:

category - A dot separated category name.

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

logError

public void logError(java.lang.String category,
                     java.lang.Object src,
                     java.lang.String srcMethod,
                     java.lang.String key,
                     java.lang.Object[] parms)

Log an error message, by key, with an array of run-time parameters. The logged message will be Localized.

Parameters:

category - A dot separated category name.

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

srcMethod - Name of the method which generates this logging.

key - Message key in the resource bundle.

parms - An array of parameters to be inserted into the message.

logFatal

public void logFatal(java.lang.Object src,
                     java.lang.Object msg)

Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.

Log a fatal message. Fatal messages are messages that indicate very severe error events that will presumably lead the application to abort. The message will be logged to the message log file without translation.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

logFatal

public void logFatal(java.lang.Object src,
                     java.lang.Object msg,
                     java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.

Log a fatal message. Fatal messages are messages that indicate very severe error events that will presumably lead the application to abort. The message will be logged to the message log file without translation while the Throwable will be logged to the trace file.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

logFatal

public void logFatal(java.lang.String category,
                     java.lang.Object msg)

Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.

Log a fatal message. Fatal messages are messages that indicate very severe error events that will presumably lead the application to abort. The message will be logged to the message log file without translation.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

logFatal

public void logFatal(java.lang.String category,
                     java.lang.Object msg,
                     java.lang.Throwable e)

Deprecated. This method will be removed in the next major release. FATAL is not a supported severity anymore. Use logError() instead.

Log a fatal message. Fatal messages are messages that indicate very severe error events that will presumably lead the application to abort. The message will be logged to the message log file without translation while the Throwable will be logged to the trace file.

Parameters:

category - A dot separated category name.

msg - String containing message to be logged.

e - Optional throwable object reference. If this parameter is not null then a stack trace is written to the log.

getPriorityLevel

public int getPriorityLevel(java.lang.Object src)

Accessor method for a category's priority level.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

Returns:

priority level of specified category.

getPriorityLevel

public int getPriorityLevel(java.lang.String category)

Accessor method for a category's priority level.

Parameters:

category - A dot separated category name.

Returns:

priority level of specified category.

setPriorityLevel

public void setPriorityLevel(java.lang.Object src,
                             int priority)

Mutator method for a category's priority level. All messages written with priority higher than or equal to the category's priority level will be logged.

Parameters:

src - The source object reference. The source object is the object which generates this logging. You can pass in "this" object reference, or the full class name.

priority - the priority level to set the specified category to.

setPriorityLevel

public void setPriorityLevel(java.lang.String category,
                             int priority)

Mutator method for a category's priority level. All messages written with priority higher than or equal to the category's priority level will be logged.

Parameters:

category - A dot separated category name.

priority - the priority level to set the specified category to.

setTraceExceptions

public void setTraceExceptions(boolean traceExceptions)

Deprecated. This method will be removed in the next major release. Exception will always be traced.

Set accessor for traceExceptions. If true, then exceptions will be logged along with stack traces. Otherwise, toString() will be used, but without printStackTrace().

Parameters:

traceExceptions - boolean value indicating whether stack traces should be logged with exceptions.

getTraceExceptions

public boolean getTraceExceptions()

Deprecated. This method will be removed in the next major release. Exception will always be traced.

Get accessor for traceExceptions.

Returns:

boolean value of traceExceptions