ECMessageLog

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

```
public final class ECMessageLog
extends java.lang.Object
```
This class is used for logging messages issued by the WebSphere Commerce Application Server. The level of logging and the name of the file to which ECMessageLog writes are determined by the configuration found in an XML file. In this case, this is specified to be the $INSTALLROOT/instances/$INSTANCE_NAME/xml/$INSTANCE_NAME.xml file, under the "LogSystem" XML element.
This class exposes static methods. The user will call the methods of this class without instantiating any objects of this type.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`disable(long messageSeverity)` This method disables a specific message severity based on the message severity id.
`static void`	`disableLogging()` This method disables message logging.
`static void`	`enable(long messageSeverity)` This method enables a specific message severity based on the message severity id.
`static void`	`enableLogging()` This method enables message logging.
`static boolean`	`isLoggingEnabled()` This method determines whether message logging is enabled.
`static void`	`out(ECMessage msg, java.lang.String className, java.lang.String methodName)` This method writes the specified `ECMessage` object to the log file.
`static void`	`out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object parm1)` This method writes the specified `ECMessage` object to the log file.
`static void`	`out(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] parms)` This method writes the specified `ECMessage` object 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)` This method writes the specified `ECMessage` object 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)` This method writes the specified `ECMessage` object 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)` This method writes the specified `ECMessage` object 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)` This method writes the specified `ECMessage` object 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)` This method writes the specified `ECMessage` object to the log file.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
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)
```
    This method disables a specific message severity based on the message severity id.
    
    Parameters:
    
    messageSeverity - This is the message severity id.
  - disableLogging
```
public static void disableLogging()
```
    This method disables message logging.
  - enable
```
public static void enable(long messageSeverity)
```
    This method enables a specific message severity based on the message severity id.
    
    Parameters:
    
    messageSeverity - This is the message severity id.
  - enableLogging
```
public static void enableLogging()
```
    This method enables message logging.
  - isLoggingEnabled
```
public static boolean isLoggingEnabled()
```
    This method determines whether message logging is enabled.
  - out
```
public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
  - out
```
public static void out(ECMessage msg,
                       java.lang.String className,
                       java.lang.String methodName,
                       java.lang.Object[] parms)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parms - This is an 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)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parms - This is an array of parameters that will be substituted into the message text.
    
    exc - This is 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)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parm1 - This is the 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)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parm1 - This is the value of the first parameter to be substituted into the message text.
    
    parm2 - This is the 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)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parm1 - This is the value of the first parameter to be substituted into the message text.
    
    parm2 - This is the value of the second parameter to be substituted into the message text.
    
    parm3 - This is the 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)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parm1 - This is the value of the first parameter to be substituted into the message text.
    
    parm2 - This is the value of the second parameter to be substituted into the message text.
    
    parm3 - This is the value of the third parameter to be substituted into the message text.
    
    parm4 - This is the 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)
```
    This method writes the specified ECMessage object to the log file.
    
    Parameters:
    
    msg - This is the ECMessage object whose text is written to the log.
    
    classname - This is the name of the class that issued the logging of this ECMessage object.
    
    methodName - This is the name of the method that issued the logging of this ECMessage object.
    
    parm1 - This is the value of the first parameter to be substituted into the message text.
    
    parm2 - This is the value of the second parameter to be substituted into the message text.
    
    parm3 - This is the value of the third parameter to be substituted into the message text.
    
    parm4 - This is the value of the fourth parameter to be substituted into the message text.
    
    parm5 - This is the value of the fifth parameter to be substituted into the message text.

Methods inherited from class java.lang.Object

COPYRIGHT

disable

disableLogging

enable

enableLogging

isLoggingEnabled

out

out

out

out

out

out

out

out