com.ibm.ras

Class RASTraceLogger

  • All Implemented Interfaces:
    RASConstants, RASILogger, RASIMaskChangeGenerator, RASIMaskChangeListener, RASIObject, RASITraceEvent, RASITraceLogger, java.io.Serializable, java.lang.Cloneable, java.util.EventListener
    Direct Known Subclasses:
    WsJrasTraceLogger
    Deprecated. 
    As of WAS 6.0, recommend using java.util.logging

    public class RASTraceLogger
extends RASLogger
implements RASITraceLogger, RASITraceEvent
    RASTraceLogger generates trace data and is one of two RASLogger sub-classes provided in this package. The other is RASMessageLogger. The purpose of tracing is to provide sufficient information to a developer or service team to diagnose a problem remotely (for example, when the application is in production). Normally an application will run with tracing turned off. When a problem occurs, it can be turned on to gather the data needed to understand the problem. (A logger's "on/off" state can be controlled by setting its isLogging flag. It might also be controlled through a graphical program, not included in this package.)

    RASTraceLogger provides the following set of overloaded methods for writing trace records:

    entry
    Traces entry into a method.
    exit
    Traces exit from a method.
    trace
    Traces general data.
    exception
    Traces an Exception.
    stackTrace
    Traces the call stack.

    When tracing in non-static methods, use the forms of these methods that take "this" (the object being traced) as the second parameter. This is a convenience to the programmer, as the class name can be derived from any Object. For static methods, an object does not exist. Use the forms which take String className as the second parameter.

    The set of types that may be used in these methods is defined in the RASITraceEvent class. These methods do not validate the type assigned to the trace point, so an error could result in the failure to trace a point.

    Note: The entry and exit methods always add RASITraceEvent.TYPE_ENTRY_EXIT to whatever type is selected. It is not necessary to include TYPE_ENTRY_EXIT. Similarly, the exception methods add RASITraceEvent.TYPE_ERROR_EXC to the exception trace points.

    RASTraceLogger has several optional fields which may be included in the trace event. These fields should not vary among trace events produced by a given RASTraceLogger, so they are not included as parameters in the methods listed above. They can, however, be specified through a RASTraceLogger constructor or by the appropriate "set" and "get" methods of this class. These fields are:

    • A server associated with the creation of the trace events.
    • The client on whose behalf the trace events are created.
    If not specified, each of these fields defaults to an empty string.

    Note: Classes which extend RASTraceLogger should, in their constructors, call addTraceEventClass to register the RASIEvent classes which the logger generates. This will allow a graphical program to query the logger to determine the supported RAS events. The events, in turn, can be queried to determine their set of supported event types.

    See Also:
    RASITraceLogger, RASIHandler, Serialized Form

    • Field Detail

      • ENTRY

        public static final java.lang.String ENTRY
        Deprecated. 
        Text used in the entry methods.
        See Also:
        Constant Field Values

      • EXIT

        public static final java.lang.String EXIT
        Deprecated. 
        Text used in the exit methods.
        See Also:
        Constant Field Values

    • Constructor Detail

      • RASTraceLogger

        public RASTraceLogger()
        Deprecated. 
        Creates a RASTraceLogger. The name and description of this object are empty strings.

      • RASTraceLogger

        public RASTraceLogger(java.lang.String name)
        Deprecated. 
        Creates a RASTraceLogger. The description of this object is an empty string.
        Parameters:
        name - The name of this object.

      • RASTraceLogger

        public RASTraceLogger(java.lang.String name,
              java.lang.String desc)
        Deprecated. 
        Creates a RASTraceLogger.
        Parameters:
        name - The name of this object.
        desc - The description of this object.

      • RASTraceLogger

        public RASTraceLogger(java.lang.String name,
              java.lang.String desc,
              java.lang.String server,
              java.lang.String client)
        Deprecated. 
        Creates a RASTraceLogger.
        Parameters:
        name - The name of this object.
        desc - The description of this object.
        server - The server.
        client - The client.

    • Method Detail

      • init

        protected void init()
        Deprecated. 
        Initializes this object, setting default values.
        Overrides:
        init in class RASLogger

      • entry

        public void entry(long type,
         java.lang.Object obj,
         java.lang.String methodName)
        Deprecated. 
        Traces entry into a non-static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a non-static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a non-static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a non-static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a static method.
        Specified by:
        entry in interface RASITraceLogger
        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)
        Deprecated. 
        Traces entry into a static method.
        Specified by:
        entry in interface RASITraceLogger
        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 elements to be displayed as trace data.

      • exit

        public void exit(long type,
        java.lang.Object obj,
        java.lang.String methodName)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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,
        byte retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        short retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        int retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        long retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        float retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        double retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        char retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        boolean retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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.Object obj,
        java.lang.String methodName,
        java.lang.Object retValue)
        Deprecated. 
        Traces exit from a non-static method.
        Specified by:
        exit in interface RASITraceLogger
        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)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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,
        byte retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        short retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        int retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        long retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        float retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        double retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        char retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        boolean retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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.

      • exit

        public void exit(long type,
        java.lang.String className,
        java.lang.String methodName,
        java.lang.Object retValue)
        Deprecated. 
        Traces exit from a static method.
        Specified by:
        exit in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a non-static method.
        Specified by:
        trace in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a non-static method.
        Specified by:
        trace in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a non-static method.
        Specified by:
        trace in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a non-static method.
        Specified by:
        trace in interface RASITraceLogger
        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 with the text.

      • trace

        public void trace(long type,
         java.lang.String className,
         java.lang.String methodName,
         java.lang.String text)
        Deprecated. 
        Traces data in a static method.
        Specified by:
        trace in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a static method.
        Specified by:
        trace in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a static method.
        Specified by:
        trace in interface RASITraceLogger
        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)
        Deprecated. 
        Traces data in a static method.
        Specified by:
        trace in interface RASITraceLogger
        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.

      • trace

        public void trace(long type,
         java.lang.Object obj,
         java.lang.String methodName,
         byte[] data)
        Deprecated. 
        Traces an array of bytes in a non-static method.
        Specified by:
        trace in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        obj - The traced object ("this").
        methodName - The name of the traced method.
        data - The array of bytes to be traced.

      • trace

        public void trace(long type,
         java.lang.String className,
         java.lang.String methodName,
         byte[] data)
        Deprecated. 
        Traces an array of bytes in a non-static method.
        Specified by:
        trace in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        className - The name of the traced class.
        methodName - The name of the traced method.
        data - The array of bytes to be traced.

      • exception

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

      • exception

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

      • exception

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

      • exception

        public void exception(long type,
             java.lang.String className,
             java.lang.String methodName,
             java.lang.Throwable exception)
        Deprecated. 
        Traces an Exception in a static method.
        Specified by:
        exception in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        className - The name of the traced class.
        methodName - The name of the traced method.
        exception - A Throwable object.

      • stackTrace

        public void stackTrace(long type,
              java.lang.Object obj,
              java.lang.String methodName)
        Deprecated. 
        Traces the call stack in a non-static method.
        Specified by:
        stackTrace in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        obj - The traced object ("this").
        methodName - The name of the traced method.

      • stackTrace

        public void stackTrace(long type,
              java.lang.Object obj,
              java.lang.String methodName,
              java.lang.String text)
        Deprecated. 
        Traces the call stack in a non-static method.
        Specified by:
        stackTrace in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        obj - The traced object ("this").
        methodName - The name of the traced method.
        text - A message to be displayed with the stack trace.

      • stackTrace

        public void stackTrace(long type,
              java.lang.String className,
              java.lang.String methodName)
        Deprecated. 
        Traces the call stack in a static method.
        Specified by:
        stackTrace in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        className - The name of the traced class.
        methodName - The name of the traced method.

      • stackTrace

        public void stackTrace(long type,
              java.lang.String className,
              java.lang.String methodName,
              java.lang.String text)
        Deprecated. 
        Traces the call stack in a static method.
        Specified by:
        stackTrace in interface RASITraceLogger
        Parameters:
        type - The type of the trace point.
        className - The name of the traced class.
        methodName - The name of the traced method.
        text - A message to be displayed with the stack trace.

      • logTrace

        protected void logTrace(long type,
            java.lang.String className,
            java.lang.String methodName,
            java.lang.String text,
            java.lang.Object[] parms,
            java.lang.Throwable exception)
        Deprecated. 
        Generates a RASTraceEvent and sends it to all attached handlers.

        This method assumes that any checks to see if the RAS event can be logged have already been done.

        Parameters:
        type - The type of the trace point.
        className - The name of the logging class.
        methodName - The name of the logging method.
        text - The trace text.
        parms - An array of elements to be displayed as trace data.
        exception - A Throwable object.

      • logTrace

        protected void logTrace(long type,
            java.lang.String className,
            java.lang.String methodName,
            byte[] data)
        Deprecated. 
        Generates a RASTraceEvent and sends it to all attached handlers.

        This method assumes that any checks to see if the RAS event can be logged have already been done.

        Parameters:
        type - The type of the trace point.
        className - The name of the traced class.
        methodName - The name of the traced method.
        data - The array of bytes to be traced.

      • maskValueChanged

        public void maskValueChanged(RASMaskChangeEvent mc)
        Deprecated. 
        Indicates that the value of the handler's trace mask has changed.

        This method is intended to improve the performance of the isLoggable method. When notified of a change in the value of a handler's mask, the logger can update its internal data, which allows the logger to determine if a RAS event will be logged.

        Specified by:
        maskValueChanged in interface RASIMaskChangeListener
        Specified by:
        maskValueChanged in class RASLogger
        Parameters:
        mc - A mask change event, indicating what has changed.
IBM WebSphere Application ServerTM
Release 8.5