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
          IBM copyright notice field.
 
Method Summary
 void disable(long componentName)
          Disables a specific tracing component
 void disableTracing()
          Disables tracing subsystem.
 void enable(long componentName)
          Enables a specific tracing component
 void enableTracing()
          Enable tracing subsystem.
 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)
          Writes an exit in the trace file to record the exit 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()
          Checks if client tracing information is enabled.
 boolean isTraceable(long componentName)
          Checks if a particular component is tracable.
 boolean isTraceEnabled()
          Checks if tracing is enabled.
 void setClientInfoEnabled(boolean value)
          Sets the client tracing information option.
 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
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values
Method Detail

disable

public void disable(long componentName)
Disables a specific tracing component

disableTracing

public void disableTracing()
Disables tracing subsystem.

enable

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

enableTracing

public void enableTracing()
Enable tracing subsystem.

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:
className - class name
methodName - method name

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:
className - class name
methodName - method name
retValue - return object value

exit

public 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:
className - class name
methodName - method name

isClientInfoEnabled

public boolean isClientInfoEnabled()
Checks if client tracing information is enabled.
Returns:
true if client tracing information is enabled; false otherwise

isTraceable

public boolean isTraceable(long componentName)
Checks if a particular component is tracable.
Returns:
true if the tracing component is traceable; false otherwise

isTraceEnabled

public boolean isTraceEnabled()
Checks if tracing is enabled.
Returns:
true if tracing subsystem 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
methodName - the name of the method to be traced
text - the text to be recorded

setClientInfoEnabled

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