com.ibm.commerce.ras
Class ECTrace

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

public final class ECTrace
extends java.lang.Object

ECTrace is the class used for tracing the execution flow of the WebSphere Commerce Application Server. The names of the components that are traceable and the name of the file that ECTrace writes to are 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 exposed by 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 componentName)
          Disables a specific tracing component.
static void disableTracing()
          Disables tracing subsystem.
static void enable(long componentName)
          Enables a specific tracing component.
static void enableTracing()
          Enable tracing subsystem.
static void entry(long componentName, java.lang.String className, java.lang.String methodName)
          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)
          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)
          Writes an entry in the trace file to record the exit from a method.
static boolean isClientInfoEnabled()
          Checks if the client tracing info option is enabled.
static boolean isTraceEnabled()
          Checks if the Tracing is enabled.
static void setClientInfoEnabled(boolean value)
          Sets client information option.
static void trace(long componentName, java.lang.String className, java.lang.String methodName, java.lang.String text)
          Writes an entry in the trace file to record a trace point in a method.
static boolean traceEnabled(long componentName)
          Check if the a specific tracing component is enabled.
 
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 componentName)
Disables a specific tracing component.

disableTracing

public static void disableTracing()
Disables tracing subsystem.

enable

public static void enable(long componentName)
Enables a specific tracing component.

enableTracing

public static void enableTracing()
Enable tracing subsystem.

entry

public static void entry(long componentName,
                         java.lang.String className,
                         java.lang.String methodName)
Writes an entry in the trace file to record the entrance to a method.
Parameters:
componentName - the name of the component to which the class to be traced belongs
methodName - the name of the method to be traced

exit

public static void exit(long componentName,
                        java.lang.String className,
                        java.lang.String methodName)
Writes an exit in the trace file to record the exit from a method.
Parameters:
componentName - the name of the component to which the class to be traced belongs
methodName - 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)
Writes an entry in the trace file to record the exit from a method.
Parameters:
componentName - the name of the component to which the class to be traced belongs
methodName - the name of the method to be traced
retValue - the return value of the method

isClientInfoEnabled

public static boolean isClientInfoEnabled()
Checks if the client tracing info option is enabled.
Returns:
true if client tracing infomation is enabled; false otherwise

isTraceEnabled

public static boolean isTraceEnabled()
Checks if the Tracing is enabled.
Returns:
true if tracing subsystem is enabled; false otherwise

trace

public static void trace(long componentName,
                         java.lang.String className,
                         java.lang.String methodName,
                         java.lang.String text)
Writes an entry in the trace file to record a trace point in a method.
Parameters:
componentName - the name of the component to which the class to be traced belongs
methodName - the name of the method to be traced
text - the text to be recorded

traceEnabled

public static boolean traceEnabled(long componentName)
Check if the a specific tracing component is enabled.
Parameters:
componentName - component name
Returns:
true if the tracing component is enabled; false otherwise

setClientInfoEnabled

public static void setClientInfoEnabled(boolean value)
Sets client information option.
Parameters:
value - client information enablement value