com.ibm.commerce.ras
Class ECMessageLog

java.lang.Object
  |
  +--com.ibm.commerce.ras.ECMessageLog

public final class ECMessageLog
extends java.lang.Object

ECMessageLog is the class used for logging messages issued by the WebSphere Commerce Application Server. The level of logging and the name of the file that ECMessageLog writes to is determined by the configuration found in the $INSTALLROOT/instances/$INSTANCE_NAME/xml/$INSTANCE_NAME.xml file, under "LogSystem" XML element.

This class expose static methods. The user will call the methods of this class without instantiating any object of this type.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Method Summary
static void disable(long messageSeverity)
          Disables a specific message severity based on the message severity Id.
static void disableLogging()
          Disables message logging.
static void enable(long messageSeverity)
          Enables a specific message severity based on the message severity Id.
static void enableLogging()
          Enables message logging.
static boolean isLoggingEnabled()
          Check if message logging is enabled.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object parm1)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] parms)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] parms, java.lang.Throwable exc)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object parm1, java.lang.Object parm2)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3, java.lang.Object parm4)
          Writes the specified ECMessage to the log file.
static void out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3, java.lang.Object parm4, java.lang.Object parm5)
          Writes the specified ECMessage to the log file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values
Method Detail

disable

public static void disable(long messageSeverity)
Disables a specific message severity based on the message severity Id.
Parameters:
messageSeverity - message severity id

disableLogging

public static void disableLogging()
Disables message logging.

enable

public static void enable(long messageSeverity)
Enables a specific message severity based on the message severity Id.
Parameters:
messageSeverity - message severity Id

enableLogging

public static void enableLogging()
Enables message logging.

isLoggingEnabled

public static boolean isLoggingEnabled()
Check if message logging is enabled.

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log
methodName - the name of the method that issued the logging of this ECMessage

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object[] parms)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log.
methodName - the name of the method that issued the logging of this ECMessage
parms - the array of parameters that will be substituted into the message text

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object[] parms,
                       java.lang.Throwable exc)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log
methodName - the name of the method that issued the logging of this ECMessage
parms - the array of parameters that will be substituted into the message text
exc - the exception whose stack trace will be appended to the message text

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object parm1)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log
methodName - the name of the method that issued the logging of this ECMessage
parm1 - value of the parameter to be substituted into the message text

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object parm1,
                       java.lang.Object parm2)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log.
methodName - the name of the method that issued the logging of this ECMessage
parm1 - value of the first parameter to be substituted into the message text
parm2 - value of the second parameter to be substituted into the message text

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object parm1,
                       java.lang.Object parm2,
                       java.lang.Object parm3)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log.
methodName - the name of the method that issued the logging of this ECMessage
parm1 - value of the first parameter to be substituted into the message text
parm2 - value of the second parameter to be substituted into the message text
parm3 - value of the third parameter to be substituted into the message text

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object parm1,
                       java.lang.Object parm2,
                       java.lang.Object parm3,
                       java.lang.Object parm4)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log.
methodName - the name of the method that issued the logging of this ECMessage
parm1 - value of the first parameter to be substituted into the message text
parm2 - value of the second parameter to be substituted into the message text
parm3 - value of the third parameter to be substituted into the message text
parm4 - value of the fourth parameter to be substituted into the message text

out

public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object parm1,
                       java.lang.Object parm2,
                       java.lang.Object parm3,
                       java.lang.Object parm4,
                       java.lang.Object parm5)
Writes the specified ECMessage to the log file.
Parameters:
msg - the ECMessage object whose text is written to the log
methodName - the name of the method that issued the logging of this ECMessage
parm1 - value of the first parameter to be substituted into the message text
parm2 - value of the second parameter to be substituted into the message text
parm3 - value of the third parameter to be substituted into the message text
parm4 - value of the fourth parameter to be substituted into the message text
parm5 - value of the fifth parameter to be substituted into the message text