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
           
 
Method Summary
static void disable(long messageSeverity)
          This method is called to disable a specific message severity
static void disableLogging()
          This method is called to disable message logging
static void enable(long messageSeverity)
          This method is called to enable a specific message severity
static void enableLogging()
          This method is called to enable message logging
static boolean isLoggingEnabled()
          This method is called to 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

disable

public static void disable(long messageSeverity)
This method is called to disable a specific message severity
Parameters:
message - severity long

disableLogging

public static void disableLogging()
This method is called to disable message logging

enable

public static void enable(long messageSeverity)
This method is called to enable a specific message severity
Parameters:
message - severity long

enableLogging

public static void enableLogging()
This method is called to enable message logging

isLoggingEnabled

public static boolean isLoggingEnabled()
This method is called to 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.
classname - The name of the class that issued the logging of this ECMessage.
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 parm1)
Writes the specified ECMessage to the log file.
Parameters:
msg - The ECMessage object whose text is written to the log.
classname - The name of the class that issued the logging of this ECMessage.
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.

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.
classname - The name of the class that issued the logging of this ECMessage.
methodName - The name of the method that issued the logging of this ECMessage.
parms - The list 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.
classname - The name of the class that issued the logging of this ECMessage.
methodName - The name of the method that issued the logging of this ECMessage.
parms - The list 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,
                       java.lang.Object parm2)
Writes the specified ECMessage to the log file.
Parameters:
msg - The ECMessage object whose text is written to the log.
classname - The name of the class that issued the logging of this ECMessage.
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 - com.ibm.commerce.ras.ECMessage The ECMessage object whose text is written to the log.
classname - The name of the class that issued the logging of this ECMessage.
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 - com.ibm.commerce.ras.ECMessage The ECMessage object whose text is written to the log.
classname - The name of the class that issued the logging of this ECMessage.
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 - com.ibm.commerce.ras.ECMessage The ECMessage object whose text is written to the log.
classname - The name of the class that issued the logging of this ECMessage.
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.