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
           
 
Method Summary
static void disable(long componentName)
          This method is called to disable a specific tracing component
static void disableTracing()
          This method is called to disable tracing
static void enable(long componentName)
          This method is called to enable a specific tracing component
static void enableTracing()
          This method is called to enable tracing
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 entry 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()
          This method is called to check if the Client Info option is enabled.
static boolean isTraceEnabled()
          This method is called to check if the Tracing is enabled.
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)
          This method is called to 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

disable

public static void disable(long componentName)
This method is called to disable a specific tracing component
Parameters:
component - long

disableTracing

public static void disableTracing()
This method is called to disable tracing

enable

public static void enable(long componentName)
This method is called to enable a specific tracing component
Parameters:
component - long

enableTracing

public static void enableTracing()
This method is called to enable tracing

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.
classname - The name of the class to be traced.
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 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.
classname - The name of the class to be traced.
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.
classname - The name of the class to be traced.
methodName - The name of the method to be traced.
retValue - The return value of the method.

isClientInfoEnabled

public static boolean isClientInfoEnabled()
This method is called to check if the Client Info option is enabled.

isTraceEnabled

public static boolean isTraceEnabled()
This method is called to check if the Tracing is enabled.

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.
classname - The name of the class to be traced.
methodName - The name of the method to be traced.
text - The text to be recorded.

traceEnabled

public static boolean traceEnabled(long componentName)
This method is called to check if the a specific tracing component is enabled.
Parameters:
componentName - long