ECTrace

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

```
public final class ECTrace
extends java.lang.Object
```
This class is used for tracing the execution flow of the WebSphere Commerce Application Server. The names of the traceable components and the file to which ECTrace writes are configured in an XML file. In this case, this is found in 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 exposed by 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 componentName)` This method disables a specific tracing component.
`static void`	`disableTracing()` This method disables the tracing subsystem.
`static void`	`enable(long componentName)` This method enables a specific tracing component.
`static void`	`enableTracing()` This method enables the tracing subsystem.
`static void`	`entry(long componentName, java.lang.String className, java.lang.String methodName)` This method writes an entry in the trace file to record the entrance to a method.
`static void`	`entry(long componentName, java.lang.String className, java.lang.String methodName, java.lang.Object[] params)` This method writes an entry in the trace file to record the entrance to a method.
`static void`	`exit(long componentName, java.lang.String className, java.lang.String methodName)` This method writes an exit in the trace file to record the exit from a method.
`static void`	`exit(long componentName, java.lang.String className, java.lang.String methodName, java.lang.Object retValue)` This method writes an exit in the trace file to record the exit from a method.
`static boolean`	`isClientInfoEnabled()` This method determines whether the client tracing info option is enabled.
`static boolean`	`isTraceEnabled()` This method determines whether tracing is enabled.
`static void`	`setClientInfoEnabled(boolean value)` This method sets the client information option.
`static void`	`trace(long componentName, java.lang.String className, java.lang.String methodName, java.lang.String text)` This method writes an entry in the trace file to record a trace point in a method.
`static boolean`	`traceEnabled(long componentName)` This method determines whether the a specific tracing component is enabled.

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 componentName)
```
    This method disables a specific tracing component.
    
    Parameters:
    
    component - This is the tracing component.
  - disableTracing
```
public static void disableTracing()
```
    This method disables the tracing subsystem.
  - enable
```
public static void enable(long componentName)
```
    This method enables a specific tracing component.
    
    Parameters:
    
    component - This is the tracing component.
  - enableTracing
```
public static void enableTracing()
```
    This method enables the tracing subsystem.
  - entry
```
public static void entry(long componentName,
                         java.lang.String className,
                         java.lang.String methodName)
```
    This method writes an entry in the trace file to record the entrance to a method.
    
    Parameters:
    
    componentName - This is the name of the component to which the class to be traced belongs.
    
    classname - This is the name of the class to be traced.
    
    methodName - This is the name of the method to be traced.
  - entry
```
public static void entry(long componentName,
                         java.lang.String className,
                         java.lang.String methodName,
                         java.lang.Object[] params)
```
    This method writes an entry in the trace file to record the entrance to a method.
    
    Parameters:
    
    componentName - This is the name of the component to which the class to be traced belongs.
    
    classname - This is the name of the class to be traced.
    
    methodName - This is the name of the method to be traced.
    
    param - This contains the entry parameters to the method.
  - exit
```
public static void exit(long componentName,
                        java.lang.String className,
                        java.lang.String methodName)
```
    This method writes an exit in the trace file to record the exit from a method.
    
    Parameters:
    
    componentName - This is the name of the component to which the class to be traced belongs.
    
    classname - This is the name of the class to be traced.
    
    methodName - This is the name of the method to be traced.
  - exit
```
public static void exit(long componentName,
                        java.lang.String className,
                        java.lang.String methodName,
                        java.lang.Object retValue)
```
    This method writes an exit in the trace file to record the exit from a method.
    
    Parameters:
    
    componentName - This is the name of the component to which the class to be traced belongs.
    
    classname - This is the name of the class to be traced.
    
    methodName - This is the name of the method to be traced.
    
    retValue - This is the return value of the method.
  - isClientInfoEnabled
```
public static boolean isClientInfoEnabled()
```
    This method determines whether the client tracing info option is enabled.
    
    Returns:
    
    This method returns true if client tracing information is enabled and false otherwise.
  - isTraceEnabled
```
public static boolean isTraceEnabled()
```
    This method determines whether tracing is enabled.
    
    Returns:
    
    This method returns true if the tracing subsystem is enabled and false otherwise.
  - trace
```
public static void trace(long componentName,
                         java.lang.String className,
                         java.lang.String methodName,
                         java.lang.String text)
```
    This method writes an entry in the trace file to record a trace point in a method.
    
    Parameters:
    
    componentName - This is the name of the component to which the class to be traced belongs.
    
    classname - This is the name of the class to be traced.
    
    methodName - This is the name of the method to be traced.
    
    text - This is the text to be recorded.
  - traceEnabled
```
public static boolean traceEnabled(long componentName)
```
    This method determines whether the a specific tracing component is enabled.
    
    Parameters:
    
    componentName - This is the name of the component.
    
    Returns:
    
    This method returns true if the tracing is enabled and false otherwise.
  - setClientInfoEnabled
```
public static void setClientInfoEnabled(boolean value)
```
    This method sets the client information option.
    
    Parameters:
    
    value - This is the client information enablement value.

Methods inherited from class java.lang.Object

COPYRIGHT

disable

disableTracing

enable

enableTracing

entry

entry

exit

exit

isClientInfoEnabled

isTraceEnabled

trace

traceEnabled

setClientInfoEnabled