com.ibm.jarm.api.util

Class JarmLogger

java.lang.Object

com.ibm.ier.logtrace.BaseLogger

com.ibm.jarm.api.util.JarmLogger

public class JarmLogger
extends com.ibm.ier.logtrace.BaseLogger

For internal use only.

JARM logging class that wraps the functionality of the IER Common Log/Trace component (ierLogTrace.jar).

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.ier.logtrace.BaseLogger

com.ibm.ier.logtrace.BaseLogger.Severity

Method Summary

Methods

Modifier and Type	Method and Description
void	error(RMLogCode code, java.lang.Object... params) Logs a message with the ERROR level.
void	error(RMLogCode code, java.lang.Throwable t, java.lang.Object... params) Logs a message with the ERROR level including the stack trace of the included Throwable t parameter.
static JarmLogger	getJarmLogger(java.lang.String loggerName) Static method to acquire a new JarmLogger instance.
void	info(RMLogCode code, java.lang.Object... params) Logs a message with the INFO level.
void	info(RMLogCode code, java.lang.Throwable t, java.lang.Object... params) Logs a message with the INFO level including the stack trace of the included Throwable t parameter.
void	warn(RMLogCode code, java.lang.Object... params) Logs a message with the WARN level.
void	warn(RMLogCode code, java.lang.Throwable t, java.lang.Object... params) Logs a message with the WARN level including the stack trace of the included Throwable t parameter.

Methods inherited from class com.ibm.ier.logtrace.BaseLogger

error, error, getBaseLogger, getBaseLogger, getLog4jLogger, info, info, isEnabledFor, setLocale, warn, warn

Methods inherited from class java.lang.Object

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

Method Detail

getJarmLogger

public static JarmLogger getJarmLogger(java.lang.String loggerName)

Static method to acquire a new JarmLogger instance.

Parameters:

loggerName - The name String that defines this JarmLogger instance. This entry cannot be empty or null.

Returns:

A new JarmLogger instance.

error

public void error(RMLogCode code,
         java.lang.Object... params)

Logs a message with the ERROR level. Intended for use during non-exception logging.

Parameters:

code - the RMLogCode used to define the logging resource bundle key.

params - zero or more parameters used in formatting the logging message.

error

public void error(RMLogCode code,
         java.lang.Throwable t,
         java.lang.Object... params)

Logs a message with the ERROR level including the stack trace of the included Throwable t parameter. This method first checks to see if the logger is enabled for the ERROR level and, if so, proceeds to format the specified message with the given parameters.

Parameters:

code - the RMLogCode used to define the logging resource bundle key.

t - Throwable whose stack trace is included in the logging message. This entry can be null.

params - zero or more parameters used in formatting the logging message.

warn

public void warn(RMLogCode code,
        java.lang.Object... params)

Logs a message with the WARN level. This method first checks to see if the logger is enabled for the WARN level and, if so, proceeds to format the specified message with the given parameters.

Parameters:

code - the RMLogCode used to define the logging resource bundle key.

params - zero or more parameters used in formatting the logging message.

warn

public void warn(RMLogCode code,
        java.lang.Throwable t,
        java.lang.Object... params)

Logs a message with the WARN level including the stack trace of the included Throwable t parameter. This method first checks to see if the logger is enabled for the WARN level and, if so, proceeds to format the specified message with the given parameters.

Parameters:

code - the RMLogCode used to define the logging resource bundle key.

t - Throwable whose stack trace is included in the logging message. This entry can be null.

params - zero or more parameters used in formatting the logging message.

info

public void info(RMLogCode code,
        java.lang.Object... params)

Logs a message with the INFO level. This method first checks to see if the logger is enabled for the INFO level and, if so, proceeds to format the specified message with the given parameters.

Parameters:

code - the RMLogCode used to define the logging resource bundle key.

params - zero or more parameters used in formatting the logging message.

info

public void info(RMLogCode code,
        java.lang.Throwable t,
        java.lang.Object... params)

Logs a message with the INFO level including the stack trace of the included Throwable t parameter. This method first checks to see if the logger is enabled for the INFO level and, if so, proceeds to format the specified message with the given parameters.

Parameters:

code - the RMLogCode used to define the logging resource bundle key.

t - Throwable whose stack trace is included in the logging message. This entry can be null.

params - zero or more parameters used in formatting the logging message.