com.ibm.ras
Interface RASITraceLogger

All Known Implementing Classes:
RASTraceLogger

public abstract interface RASITraceLogger
extends RASILogger

RASITraceLogger defines a set of methods that must be implemented to create RAS trace data.

See Also:
RASILogger, RASTraceLogger

Method Summary
 void entry(long type, java.lang.Object obj, java.lang.String methodName)
          Traces entry into a non-static method.
 void entry(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Object parm1)
          Traces entry into a non-static method.
 void entry(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Object[] parms)
          Traces entry into a non-static method.
 void entry(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Object parm1, java.lang.Object parm2)
          Traces entry into a non-static method.
 void entry(long type, java.lang.String className, java.lang.String methodName)
          Traces entry into a static method.
 void entry(long type, java.lang.String className, java.lang.String methodName, java.lang.Object parm1)
          Traces entry into a static method.
 void entry(long type, java.lang.String className, java.lang.String methodName, java.lang.Object[] parms)
          Traces entry into a static method.
 void entry(long type, java.lang.String className, java.lang.String methodName, java.lang.Object parm1, java.lang.Object parm2)
          Traces entry into a static method.
 void exception(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Exception exc)
          Traces an Exception in a non-static method.
 void exception(long type, java.lang.String className, java.lang.String methodName, java.lang.Exception exc)
          Traces an Exception in a static method.
 void exit(long type, java.lang.Object obj, java.lang.String methodName)
          Traces exit from a non-static method.
 void exit(long type, java.lang.Object obj, java.lang.String methodName, java.lang.Object retValue)
          Traces exit from a non-static method.
 void exit(long type, java.lang.String className, java.lang.String methodName)
          Traces exit from a static method.
 void exit(long type, java.lang.String className, java.lang.String methodName, java.lang.Object retValue)
          Traces exit from a static method.
 java.util.Hashtable getConfig()
          Gets the configuration of this object.
 long getTraceMask()
          Gets the mask which defines the set of trace types that will be processed.
 void setConfig(java.util.Hashtable ht)
          Sets the configuration of this object.
 void setTraceMask(long mask)
          Sets the mask which defines the set of trace types that will be processed.
 void trace(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text)
          Traces data in a non-static method.
 void trace(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object parm1)
          Traces data in a non-static method.
 void trace(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object[] parms)
          Traces data in a non-static method.
 void trace(long type, java.lang.Object obj, java.lang.String methodName, java.lang.String text, java.lang.Object parm1, java.lang.Object parm2)
          Traces data in a non-static method.
 void trace(long type, java.lang.String className, java.lang.String methodName, java.lang.String text)
          Traces data in a static method.
 void trace(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object parm1)
          Traces data in a static method.
 void trace(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object[] parms)
          Traces data in a static method.
 void trace(long type, java.lang.String className, java.lang.String methodName, java.lang.String text, java.lang.Object parm1, java.lang.Object parm2)
          Traces data in a static method.
 
Methods inherited from interface com.ibm.ras.RASILogger
addHandler, getHandlers, isLoggable, isSynchronous, removeHandler, setSynchronous
 
Methods inherited from interface com.ibm.ras.RASIObject
getDescription, getName, setDescription, setName
 

Method Detail

getConfig

public java.util.Hashtable getConfig()
Gets the configuration of this object.
Specified by:
getConfig in interface RASILogger
Returns:
A Hashtable containing the configuration. This object inserts the following key/value pairs into the configuration:
         "traceMask" The mask which selects the trace types to be
                     processed.
         
All values are Strings. The parent and extensions of this object may add additional keys.

setConfig

public void setConfig(java.util.Hashtable ht)
Sets the configuration of this object. This method is used by a RASManager to initialize a RAS object. It should not be necessary for an application to use this method.
Specified by:
setConfig in interface RASILogger
Parameters:
ht - A Hashtable containing the configuration. This object searches for the following keys:
            "traceMask" The mask which selects the trace types to be
                        processed.
            
All values are Strings. If a key is not found, that configuration element is not updated. The parent and extensions of this object may use additional keys.

getTraceMask

public long getTraceMask()
Gets the mask which defines the set of trace types that will be processed. Possible values are defined by the logical OR of the RASITraceEvent.TYPE_XXXX constants.
Returns:
The trace mask.

setTraceMask

public void setTraceMask(long mask)
Sets the mask which defines the set of trace types that will be processed. Possible values are defined by the RASITraceEvent.TYPE_XXXX constants. The mask value is not validated against these types.
Parameters:
mask - The trace mask.

entry

public void entry(long type,
                  java.lang.Object obj,
                  java.lang.String methodName)
Traces entry into a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.

entry

public void entry(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.Object parm1)
Traces entry into a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
parm1 - An element to be displayed as trace data.

entry

public void entry(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.Object parm1,
                  java.lang.Object parm2)
Traces entry into a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
parm1 - An element to be displayed as trace data.
parm2 - An element to be displayed as trace data.

entry

public void entry(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.Object[] parms)
Traces entry into a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
parms - An array of parameters passed to the method.

entry

public void entry(long type,
                  java.lang.String className,
                  java.lang.String methodName)
Traces entry into a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.

entry

public void entry(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.Object parm1)
Traces entry into a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
parm1 - An element to be displayed as trace data.

entry

public void entry(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.Object parm1,
                  java.lang.Object parm2)
Traces entry into a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
parm1 - An element to be displayed as trace data.
parm2 - An element to be displayed as trace data.

entry

public void entry(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.Object[] parms)
Traces entry into a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
parms - An array of parameters passed to the method.

exit

public void exit(long type,
                 java.lang.Object obj,
                 java.lang.String methodName)
Traces exit from a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.

exit

public void exit(long type,
                 java.lang.Object obj,
                 java.lang.String methodName,
                 java.lang.Object retValue)
Traces exit from a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
retValue - The returned value.

exit

public void exit(long type,
                 java.lang.String className,
                 java.lang.String methodName)
Traces exit from a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.

exit

public void exit(long type,
                 java.lang.String className,
                 java.lang.String methodName,
                 java.lang.Object retValue)
Traces exit from a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
retValue - The returned value.

trace

public void trace(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.String text)
Traces data in a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
text - The trace text.

trace

public void trace(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.String text,
                  java.lang.Object parm1)
Traces data in a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
text - The trace text.
parm1 - An element to be displayed as trace data.

trace

public void trace(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.String text,
                  java.lang.Object parm1,
                  java.lang.Object parm2)
Traces data in a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
text - The trace text.
parm1 - An element to be displayed as trace data.
parm2 - An element to be displayed as trace data.

trace

public void trace(long type,
                  java.lang.Object obj,
                  java.lang.String methodName,
                  java.lang.String text,
                  java.lang.Object[] parms)
Traces data in a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
text - The trace text.
parms - An array of elements to be displayed as trace data.

trace

public void trace(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.String text)
Traces data in a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
text - The trace text.

trace

public void trace(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.String text,
                  java.lang.Object parm1)
Traces data in a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
text - The trace text.
parm1 - An element to be displayed as trace data.

trace

public void trace(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.String text,
                  java.lang.Object parm1,
                  java.lang.Object parm2)
Traces data in a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
text - The trace text.
parm1 - An element to be displayed as trace data.
parm2 - An element to be displayed as trace data.

trace

public void trace(long type,
                  java.lang.String className,
                  java.lang.String methodName,
                  java.lang.String text,
                  java.lang.Object[] parms)
Traces data in a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
text - The trace text.
parms - An array of elements to be displayed as trace data.

exception

public void exception(long type,
                      java.lang.Object obj,
                      java.lang.String methodName,
                      java.lang.Exception exc)
Traces an Exception in a non-static method.
Parameters:
type - The type of the trace point.
obj - The traced object ("this").
methodName - The name of the traced method.
exc - An exception.

exception

public void exception(long type,
                      java.lang.String className,
                      java.lang.String methodName,
                      java.lang.Exception exc)
Traces an Exception in a static method.
Parameters:
type - The type of the trace point.
className - The name of the traced class.
methodName - The name of the traced method.
exc - An exception.