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

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
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	entry(long componentName, java.lang.String className, java.lang.String methodName, java.lang.Object[] params) 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

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

disable

void disable(long componentName)

Disables a specific tracing component

Parameters:

component - tracing component Id

disableTracing

void disableTracing()

Disables tracing subsystem.

enable

void enable(long componentName)

Enables a specific tracing component

Parameters:

component - tracing component Id

enableTracing

void enableTracing()

Enable tracing subsystem.

entry

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 - tracing component

className - class name

methodName - method name

entry

void entry(long componentName,
           java.lang.String className,
           java.lang.String methodName,
           java.lang.Object[] params)

Writes an entry in the trace file to record the entry from a method

Parameters:

componentId - tracing component

className - class name

methodName - method name

param - the entry parameters to the method.

exit

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 - tracing component

className - class name

methodName - method name

retValue - return object value

exit

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:

componentId - tracing component

className - class name

methodName - method name

isClientInfoEnabled

boolean isClientInfoEnabled()

Checks if client tracing information is enabled.

Returns:

true if client tracing information is enabled; false otherwise

isTraceable

boolean isTraceable(long componentName)

Checks if a particular component is tracable.

Parameters:

componentId - component name

Returns:

true if the tracing component is traceable; false otherwise

isTraceEnabled

boolean isTraceEnabled()

Checks if tracing is enabled.

Returns:

true if tracing subsystem is enabled

trace

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

setClientInfoEnabled

void setClientInfoEnabled(boolean value)

Sets the client tracing information option.

Parameters:

value - client tracing information enablement value