com.ibm.commerce.ras
Interface ITracingService

All Known Implementing Classes:
ECTracingProvider

public interface ITracingService

ITracingService defines the methods to configure the Tracing service.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void disable(long componentName)
          This method is called to disable a specific tracing component
 void disableTracing()
          This method is used to disable Tracing.
 void enable(long componentName)
          This method is called to enable a specific tracing component
 void enableTracing()
          This method is used to enable Tracing.
 void entry(long componentName, java.lang.String className, java.lang.String methodName)
          Writes an entry in the trace file to record the entry from a method
 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
 boolean isClientInfoEnabled()
          This method is used to check if Client Tracing information is enabled.
 boolean isTraceable(long componentName)
          This method is used to check if a particular component is tracable.
 boolean isTraceEnabled()
          This method is used to check if Tracing is enabled.
 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.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

disable

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

disableTracing

public void disableTracing()
This method is used to disable Tracing.

enable

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

enableTracing

public void enableTracing()
This method is used to enable Tracing.

entry

public void entry(long componentName,
                  java.lang.String className,
                  java.lang.String methodName)
Writes an entry in the trace file to record the entry from a method
Parameters:
componentId - long
class - name String
method - name String

exit

public 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:
componentId - long
class - name String
method - name String
return - object value Object

isClientInfoEnabled

public boolean isClientInfoEnabled()
This method is used to check if Client Tracing information is enabled.

isTraceable

public boolean isTraceable(long componentName)
This method is used to check if a particular component is tracable.
Parameters:
componentId - long

isTraceEnabled

public boolean isTraceEnabled()
This method is used to check if Tracing is enabled.

trace

public 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.