com.waveset.logging.trace
Class WSTrace
java.lang.Object
com.waveset.logging.trace.WSTrace
All Implemented Interfaces: ITrace
Deprecated. as of 6.0, use com.sun.idm.logging.Trace instead
public class WSTrace extends java.lang.Objectimplements ITrace
The Waveset trace class exposes methods so that Lighthouse methods
can conveniently trace entry, exit, exception, and information.
Instrumenting Lighthouse code with trace is critically important
to how well Waveset can support Lighthouse in the field, since
trace is often the only way to debug problems at a customer site.
Instrumenting Lighthouse code with trace appropriately
makes Lighthouse trace useful in localizing a problem.
Instrumenting Lighthouse code with trace efficiently
improves the performance of the Lighthouse application in normal operation.
Places NOT to use WSTrace
Do not add WSTrace to a class
that may need to load and execute
before the Lighthouse Server has constructed a Repository.
In general, this means to avoid using trace in packages such as:
com.waveset.msgcat
com.waveset.util
packages.
com.waveset.exception
To add trace capability in classes where you cannot use
WSTrace
, consider using Debug
.
Trace Levels
WSTrace defines four levels of trace, of which
LEVEL1
is the most concise, and
LEVEL4
is the most detailed.
In general, application code calling WSTrace is expected to trace
the following types of information at each level:
LEVEL1
entry and exit of PUBLIC methods.
LEVEL2
entry and exit of ALL methods (excluding trivial accessors
and mutators--i.e., simple 'get' and 'set' methods).
LEVEL3
level 2, plus SIGNIFICANT DATA
(e.g., data values on which code branches are conditioned).
LEVEL4
level 3, plus PAINFUL DETAIL (i.e., large or high-volume stuff)
such as buffer contents or loop variables.
Checking Trace Levels
WSTrace exposes a set of methods that return true
if a particular level of trace is in effect for a particular method:
level1()
,
level2()
,
level3()
, and
level4()
.
Internally, each of these methods first performs a top-level check
of whether trace is enabled. This top-level check is very fast.
Thus each method-level check is very fast when trace is disabled.
Hashing and caching further down in the implementation
make the method-level checks reasonably fast even when trace is enabled.
In general, code calling WSTrace should:
condition object creation on a method-level check
minimize object creation
minimize the number of checks
Discussion and Examples
This simplest example is a class with a single method
that takes no argument and returns void
.
We'll use this trivial example just to show what trace looks like.
(After this, our examples will show only the relevant stuff.)
   import com.waveset.logging.trace.WSTrace;
   public class Simple {
     protected WSTrace trace = WSTrace.getTrace();
     private static final String CLASS = "com.waveset.example.Simple";
     public void simple() {
       final String METHOD = "simple";
       trace.entry(trace.LEVEL1,CLASS,METHOD);
       ...
       trace.exit(trace.LEVEL1,CLASS,METHOD);
     }
   } // class Simple
NOTE: The CLASS
argument affects trace behavior.
Statically defining a CLASS
constant
(as shown in the example) can clarify trace with overridden methods.
If you pass the Class
object, trace will reflect
the class whose implementation is actually being executed .
(On the other hand, if you pass the this
pointer,
trace will reflect the class of the object currently in scope.
This can be confusing if you:
look in the class and don't find the method.
think you're executing an inherited method (but you're not).
think you're executing your own method that overrides
an inherited implementation (but you're not).
For example, assume that SolarisResourceAdapter extends UnixResourceAdapter.
If UnixResourceAdapter has a method foo that uses
       trace.entry(trace.LEVEL1,this,METHOD);
When this method is called through a Solaris resource,
trace output shows the class as SolarisResourceAdapter
.
Someone might think that the code resides in SolarisResourceAdapter,
when it was actually inherited from UnixResourceAdapter.
If the programmer had passed the statically defined
Class, this would have been clear.
     private static final String CLASS = "com.waveset.adapter.UnixResourceAdapter";
...
...
...
       trace.entry(trace.LEVEL1,CLASS,METHOD);
Object creation is expensive in the Java programming language.
Of course, object creation is not nearly as expensive as
the I/O we will perform when we actually do write out trace,
but carelessly coded trace calls can construct unnecessary objects
every time a method is invoked, adversely impacting performance.
Consider the following example:
    public void pleaseDoNotDoThis(Object arg1, int arg2) {
      final String METHOD = "pleaseDoNotDoThis";
      trace.entry(trace.LEVEL1,CLASS,METHOD,
        new Object[]{ arg1, new Integer(arg2) });
      ...
    }
The code above looks innocent, but is actually quite expensive.
The trace code in method pleaseDoNotDoThis()
will always
construct at least two objects whether it needs them or not :
a new Integer
to wrap arg2
an array of Object to contain arg1
and (the wrapped) arg2
A better way to handle this is to condition the object creation
on a method-level check:
    public void traceEntryArgs(Object arg1, int arg2) {
      final String METHOD = "traceEntryArgs";
      if (trace.level1(CLASS,METHOD)) {
         trace.entry(trace.ALWAYS,CLASS,METHOD,
           new Object[]{ arg1, new Integer(arg2) } );
      }
      ...
    }
This way, traceEntryArgs
constructs the Integer
wrapper for arg2
and the Object
array
only when it is actually supposed to trace something.
The requested level trace.ALWAYS
is a special value
that indicates trace should be written
unconditionally, as long as trace is enabled .
This special value short-circuits the level check
so that we do not repeat the same level check
that we performed in the surrounding condition.
The same logic can be applied to a tracing the exit of a method.
If the return value is a Java primitive
that must be wrapped in an Object
for trace,
or if the return value requires formatting in order to be useful,
then the call to trace.exit()
should be conditional.
   public int returnsPrimitive() {
     int primitive;
     final String METHOD = "returnsPrimitive";
     ...
     if (trace.level1(CLASS,METHOD)) {
       trace.exit(trace.ALWAYS,CLASS,METHOD
         new Integer(primitive));
     }
     return primitive;
   }
   public int needsFormatting() {
     Object[] needsFormatting;
     final String METHOD = "needsFormatting";
     ...
     if (trace.level1(CLASS,METHOD)) {
       trace.exit(trace.ALWAYS,CLASS,METHOD
         Util.arrayToString(needsFormatting));
     }
     return needsFormatting;
   }
On the other hand, if a method returns void
or directly returns an instance of Object
,
then there is no sense in performing the method-level check twice.
   public void returnsVoid() {
     final String METHOD = "returnsVoid";
     ...
     trace.exit(trace.LEVEL1,CLASS,METHOD);
   }
   public Object returnsObject() {
     Object o;
     final String METHOD = "returnsObject";
     ...
     trace.exit(trace.LEVEL1,CLASS,METHOD, o);
     return o;
   }
While all these examples are highly simplified,
they should serve to illustrate the general goals of:
minimizing object creation
minimizing checks
As you instrument your code for trace,
use your best judgment in applying these guidelines.
Keep in mind that the overall goals are to make your trace:
appropriate (i.e., useful as possible in trouble-shooting)
efficient (i.e., as fast as possible in normal operation)
For example, imagine a method such that all one really cares about
at level 1 is whether the method was entered and exited normally.
At level 3, tracing argument values may become important.
In such a case, it is most efficient to do the following:
   public void manyArgs(Object arg1, Object arg2, Object arg3) {
     final String METHOD = "manyArgs";
     if (trace.level3(CLASS,METHOD)) {
       trace.entry(trace.ALWAYS,CLASS,METHOD,
         new Object[]{ arg1, arg2, arg3 });
     } else {
       trace.entry(trace.LEVEL1,CLASS,METHOD);
     }
     ...
     trace.exit(trace.LEVEL1,CLASS,METHOD);
   }
Method Summary
static void
clearTraceLevel (java.lang.String scope)
Deprecated. Persistently remove the trace level configured for a specific scope.
static void
clearTraceLevels (java.lang.String scope)
Deprecated. Persistently remove all configured trace levels within a specified scope.
void
data (long level,
java.lang.Class clas,
java.lang.String meth,
byte[] data)
Deprecated. Traces method data
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
data (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
byte[] data)
Deprecated. Logs an array of bytes.
void
data (long reqLevel,
java.lang.Object clas,
java.lang.String client,
java.lang.String meth,
byte[] data)
Deprecated. Logs an array of bytes.
void
data (long level,
java.lang.String clas,
java.lang.String meth,
byte[] data)
Deprecated. Traces method data
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
entry (long level,
java.lang.Class c,
java.lang.String meth)
Deprecated. Traces method entry
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
entry (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.Object[] args)
Deprecated. Traces method entry (with an array of args)
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
entry (long reqLevel,
java.lang.Class c,
java.lang.String meth,
java.lang.String input)
Deprecated. Traces method entry (with preformatted input)
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application.
void
entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Object[] parms)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application.
void
entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application.
void
entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.Object[] parms)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application.
void
entry (long level,
java.lang.String c,
java.lang.String meth)
Deprecated. Traces method entry
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
entry (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.Object[] args)
Deprecated. Traces method entry (with an array of args)
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
entry (long reqLevel,
java.lang.String c,
java.lang.String meth,
java.lang.String input)
Deprecated. Traces method entry (with preformatted input)
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exception (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.Throwable th)
Deprecated. Traces an exception
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exception (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Throwable exception)
Deprecated. Logs an exception.
void
exception (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.Throwable th)
Deprecated. Traces an exception
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.Class clas,
java.lang.String meth)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.Class clas,
java.lang.String meth,
boolean retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.Class clas,
java.lang.String meth,
int retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.Class clas,
java.lang.String meth,
long retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.Object retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. An exit trace point should be added to every significant
method to track movement through an application.
void
exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
long retVal)
Deprecated. Gary is using this, make sure its part of the new diggs
void
exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Object retVal)
Deprecated. An exit trace point should be added to every significant
method to track movement through an application.
void
exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.Object retVal)
Deprecated. An exit trace point should be added to every significant
method to track movement through an application.
void
exit (long level,
java.lang.String clas,
java.lang.String meth)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.String clas,
java.lang.String meth,
boolean retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.String clas,
java.lang.String meth,
int retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.String clas,
java.lang.String meth,
long retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
exit (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.Object retVal)
Deprecated. Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
flush (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String msg)
Deprecated.
static java.lang.String
getClassName (java.lang.Object o)
Deprecated.
protected static java.lang.String
getFullyQualifiedMethodName (java.lang.Object clas,
java.lang.String meth)
Deprecated.
static int
getIntLevel (long reqLevel)
Deprecated.
long
getLevel (java.lang.String clas,
java.lang.String meth)
Deprecated.
static long
getLongLevel (int intLevel)
Deprecated.
static WSTrace
getTrace ()
Deprecated. Factory method.
static int
getTraceLevel (java.lang.String scope)
Deprecated. Queries the trace level specified for a scope.
void
info (long level,
java.lang.Class c,
java.lang.String method,
java.lang.String msg)
Deprecated. Traces method information
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
Message msg)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application.
void
info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Object[] parms)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application.
void
info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String msg)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application.
void
info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.Object[] parms)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application.
void
info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.String msg)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application.
void
info (long level,
java.lang.String c,
java.lang.String method,
java.lang.String msg)
Deprecated. Traces method information
if the trace level in effect for the specified class
meets or exceeds the specified level.
boolean
isLogging (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. Are we tracing the specified method at the specified level?
boolean
level1 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
boolean
level1 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
boolean
level1 (java.lang.String clas,
java.lang.String meth)
Deprecated.
boolean
level2 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
boolean
level2 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
boolean
level2 (java.lang.String clas,
java.lang.String meth)
Deprecated.
boolean
level3 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
boolean
level3 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
boolean
level3 (java.lang.String clas,
java.lang.String meth)
Deprecated.
boolean
level4 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
boolean
level4 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
boolean
level4 (java.lang.String clas,
java.lang.String meth)
Deprecated.
static void
listTraceLevels (java.io.PrintWriter out,
java.lang.String scope)
Deprecated.
static WSTrace
peekTrace ()
Deprecated. Singleton accessor method.
protected static void
println (java.lang.Object o)
Deprecated. Ubiquitous macro.
void
setLogging (boolean state)
Deprecated. Set if trace is enabled.
static void
setTraceLevel (int level,
java.lang.String scope)
Deprecated. Persistently add or update a trace level
(by updating LogConfig.properties).
static void
shutdown ()
Deprecated. Shutdown the singleton and release any resources.
void
stackTrace (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. Writes a stack trace to the trace file.
void
stackTrace (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client)
Deprecated. Writes a stack trace to the trace file.
void
variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
boolean b)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
int i)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
long l)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
java.lang.Object o)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
boolean value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
void
variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
int value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
void
variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
long value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
void
variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
java.lang.Object value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
void
variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
boolean b)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
int i)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
long l)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
void
variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
java.lang.Object o)
Deprecated. Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
code_id
public static final java.lang.String code_id
Deprecated.
See Also: Constant Field Values
_singleton
protected static WSTrace _singleton
Deprecated.
getTrace
public static WSTrace getTrace ()
Deprecated. Factory method.
Returns: an instance of WSTrace
.
peekTrace
public static WSTrace peekTrace ()
Deprecated. Singleton accessor method.
Returns: an instance of WSTrace
if the singleton has already been constructed;
otherwise null
.
level1
public boolean level1 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
Specified by: level1
in interface ITrace
Parameters: clas
- Java class for which to check trace.
May be specified either as:
the Java Class
object; or
an object whose string value is the fully qualified class name
meth
- name of method for which to check trace.
Returns: true
if waveset is currently logging
LEVEL1
trace points for the specified class and method;
false
otherwise.
level1
public boolean level1 (java.lang.String clas,
java.lang.String meth)
Deprecated.
Specified by: level1
in interface ITrace
Returns: true
if a trace level of at least 1
is in effect for the specified class and method.
level1
public boolean level1 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
getLevel
public long getLevel (java.lang.String clas,
java.lang.String meth)
Deprecated.
level2
public boolean level2 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
Specified by: level2
in interface ITrace
Parameters: clas
- Java class for which trace is being checked.
May be specified either as:
the Java Class
object; or
an object whose string value is the fully qualified class name
meth
- name of method for which to check trace.
Returns: true
if waveset is currently logging
LEVEL2
trace points for the specified class and method;
false
otherwise.
level2
public boolean level2 (java.lang.String clas,
java.lang.String meth)
Deprecated.
Specified by: level2
in interface ITrace
Returns: true
if a trace level of at least 2
is in effect for the specified class and method.
level2
public boolean level2 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
level3
public boolean level3 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
Specified by: level3
in interface ITrace
Parameters: clas
- Java class for which trace is being checked.
May be specified either as:
the Java Class
object; or
an object whose string value is the fully qualified class name
meth
- name of method for which to check trace.
Returns: true
if waveset is currently logging
LEVEL3
trace points for the specified class and method;
false
otherwise.
level3
public boolean level3 (java.lang.String clas,
java.lang.String meth)
Deprecated.
Specified by: level3
in interface ITrace
Returns: true
if a trace level of at least 3
is in effect for the specified class and method.
level3
public boolean level3 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
level4
public boolean level4 (java.lang.Class clas,
java.lang.String meth)
Deprecated.
Specified by: level4
in interface ITrace
Parameters: clas
- Java class for which trace is being checked.
May be specified either as:
the Java Class
object; or
an object whose string value is the fully qualified class name
meth
- name of method for which to check trace.
Returns: true
if waveset is currently logging
LEVEL4
trace points for the specified class and method;
false
otherwise.
level4
public boolean level4 (java.lang.String clas,
java.lang.String meth)
Deprecated.
Specified by: level4
in interface ITrace
Returns: true
if a trace level of at least 4
is in effect for the specified class and method.
level4
public boolean level4 (java.lang.Object clas,
java.lang.String meth)
Deprecated.
getFullyQualifiedMethodName
protected static java.lang.String getFullyQualifiedMethodName (java.lang.Object clas,
java.lang.String meth)
Deprecated.
getClassName
public static java.lang.String getClassName (java.lang.Object o)
Deprecated.
getTraceLevel
public static int getTraceLevel (java.lang.String scope)
Deprecated. Queries the trace level specified for a scope.
Returns: -1
if no trace level is specified
for exactly the specified scope.
setTraceLevel
public static void setTraceLevel (int level,
java.lang.String scope)
Deprecated. Persistently add or update a trace level
(by updating LogConfig.properties).
clearTraceLevel
public static void clearTraceLevel (java.lang.String scope)
Deprecated. Persistently remove the trace level configured for a specific scope.
clearTraceLevels
public static void clearTraceLevels (java.lang.String scope)
Deprecated. Persistently remove all configured trace levels within a specified scope.
listTraceLevels
public static void listTraceLevels (java.io.PrintWriter out,
java.lang.String scope)
Deprecated.
entry
public void entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application. Trivial
methods, such as getters and setters, generally don't have
entry or exit trace points because of the added overhead.
Parameters: reqLevel
- - the requested level of traceclas
- - the class requesting tracemeth
- - the method requesting trace
entry
public void entry (long level,
java.lang.Class c,
java.lang.String meth)
Deprecated. Description copied from interface: ITrace
Traces method entry
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: entry
in interface ITrace
entry
public void entry (long level,
java.lang.String c,
java.lang.String meth)
Deprecated. Description copied from interface: ITrace
Traces method entry
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: entry
in interface ITrace
entry
public void entry (long reqLevel,
java.lang.Class c,
java.lang.String meth,
java.lang.String input)
Deprecated. Description copied from interface: ITrace
Traces method entry (with preformatted input)
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: entry
in interface ITrace
entry
public void entry (long reqLevel,
java.lang.String c,
java.lang.String meth,
java.lang.String input)
Deprecated. Description copied from interface: ITrace
Traces method entry (with preformatted input)
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: entry
in interface ITrace
entry
public void entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application. This method
accepts a client parameter so that it can be logged. Trivial
methods, such as getters and setters, generally don't have
entry or exit trace points because of the added overhead.
entry
public void entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Object[] parms)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application. This method
also accepts an array of objects if you wish to trace the
arguments comming into a method. Trivial methods, such as
getters and setters, generally don't have entry or exit trace
points because of the added overhead.
entry
public void entry (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.Object[] args)
Deprecated. Description copied from interface: ITrace
Traces method entry (with an array of args)
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: entry
in interface ITrace
entry
public void entry (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.Object[] args)
Deprecated. Description copied from interface: ITrace
Traces method entry (with an array of args)
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: entry
in interface ITrace
entry
public void entry (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.Object[] parms)
Deprecated. An entry trace point should be added to every significant
method to track movement through an application. This method
also accepts an array of objects if you wish to trace the
arguments comming into a method and accepts a client parameter,
so that it can be logged as well. Trivial methods, such as
getters and setters, generally don't have entry or exit trace
points because of the added overhead.
exit
public void exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. An exit trace point should be added to every significant
method to track movement through an application. Trivial
methods, such as getters and setters, generally don't have
entry or exit trace points because of the added overhead.
exit
public void exit (long level,
java.lang.Class clas,
java.lang.String meth)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.String clas,
java.lang.String meth)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Object retVal)
Deprecated. An exit trace point should be added to every significant
method to track movement through an application. Trivial
methods, such as getters and setters, generally don't have
entry or exit trace points because of the added overhead.
exit
public void exit (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.Object retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.Class clas,
java.lang.String meth,
int retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.Class clas,
java.lang.String meth,
long retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.Class clas,
java.lang.String meth,
boolean retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.Object retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.String clas,
java.lang.String meth,
int retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.String clas,
java.lang.String meth,
long retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long level,
java.lang.String clas,
java.lang.String meth,
boolean retVal)
Deprecated. Description copied from interface: ITrace
Traces method exit
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exit
in interface ITrace
exit
public void exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.Object retVal)
Deprecated. An exit trace point should be added to every significant
method to track movement through an application. This method
accepts a client parameter so that it can be logged. Trivial
methods, such as getters and setters, generally don't have
entry or exit trace points because of the added overhead.
exit
public void exit (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
long retVal)
Deprecated. Gary is using this, make sure its part of the new diggs
flush
public void flush (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String msg)
Deprecated.
info
public void info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String msg)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application.
info
public void info (long level,
java.lang.Class c,
java.lang.String method,
java.lang.String msg)
Deprecated. Description copied from interface: ITrace
Traces method information
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: info
in interface ITrace
info
public void info (long level,
java.lang.String c,
java.lang.String method,
java.lang.String msg)
Deprecated. Description copied from interface: ITrace
Traces method information
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: info
in interface ITrace
info
public void info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.String msg)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application. This method accepts a client parameter so
that it can be logged.
info
public void info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Object[] parms)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application. This method takes in an array of objects
and will interate through the array and call the toString()
method on each object in the array.
info
public void info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
Message msg)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application. This method takes in an array of objects
and will interate through the array and call the toString()
method on each object in the array.
info
public void info (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client,
java.lang.Object[] parms)
Deprecated. An info trace point should be added to every significant
section of a method to track movement through a method/
application. This method takes in an array of objects
and will interate through the array and call the toString()
method on each object in the array and also accepts a client
parameter so that it can be logged.
variable
public void variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
java.lang.Object value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
This method is the same as info(long,Object,String,String)
except that this method constructs the "label=value" message for you.
It is trivial to construct this string,
but the object creation overhead is not trivial.
This method constructs the message string
only if the method is actually being traced.
This method is therefore faster if the method is NOT being traced,
and produces less "garbage" (i.e., fewer unreferenced Java objects).
variable
public void variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
java.lang.Object o)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
java.lang.Object o)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
boolean value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
This method is the same as info(long,Object,String,String)
except that this method constructs the "label=value" message for you.
It is trivial to construct this string,
but the object creation overhead is not trivial.
This method constructs the message string
only if the method is actually being traced.
This method is therefore faster if the method is NOT being traced,
and produces less "garbage" (i.e., fewer unreferenced Java objects).
variable
public void variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
boolean b)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
boolean b)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
long value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
This method is the same as info(long,Object,String,String)
except that this method constructs the "label=value" message for you.
It is trivial to construct this string,
but the object creation overhead is not trivial.
This method constructs the message string
only if the method is actually being traced.
This method is therefore faster if the method is NOT being traced,
and produces less "garbage" (i.e., fewer unreferenced Java objects).
variable
public void variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
long l)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
long l)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String label,
int value)
Deprecated. Use this method to trace the value of significant variables
(e.g., those used to condition branches in the code).
This method is the same as info(long,Object,String,String)
except that this method constructs the "label=value" message for you.
It is trivial to construct this string,
but the object creation overhead is not trivial.
This method constructs the message string
only if the method is actually being traced.
This method is therefore faster if the method is NOT being traced,
and produces less "garbage" (i.e., fewer unreferenced Java objects).
variable
public void variable (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.String label,
int i)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
variable
public void variable (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.String label,
int i)
Deprecated. Description copied from interface: ITrace
Traces a method variable
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: variable
in interface ITrace
data
public void data (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
byte[] data)
Deprecated. Logs an array of bytes.
data
public void data (long level,
java.lang.Class clas,
java.lang.String meth,
byte[] data)
Deprecated. Description copied from interface: ITrace
Traces method data
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: data
in interface ITrace
data
public void data (long level,
java.lang.String clas,
java.lang.String meth,
byte[] data)
Deprecated. Description copied from interface: ITrace
Traces method data
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: data
in interface ITrace
data
public void data (long reqLevel,
java.lang.Object clas,
java.lang.String client,
java.lang.String meth,
byte[] data)
Deprecated. Logs an array of bytes. This method accepts a client
parameter so that it can be logged.
stackTrace
public void stackTrace (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. Writes a stack trace to the trace file.
stackTrace
public void stackTrace (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.String client)
Deprecated. Writes a stack trace to the trace file. This method
accepts a client parameter so that it can be logged.
exception
public void exception (long reqLevel,
java.lang.Object clas,
java.lang.String meth,
java.lang.Throwable exception)
Deprecated. Logs an exception.
exception
public void exception (long level,
java.lang.Class clas,
java.lang.String meth,
java.lang.Throwable th)
Deprecated. Description copied from interface: ITrace
Traces an exception
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exception
in interface ITrace
exception
public void exception (long level,
java.lang.String clas,
java.lang.String meth,
java.lang.Throwable th)
Deprecated. Description copied from interface: ITrace
Traces an exception
if the trace level in effect for the specified class
meets or exceeds the specified level.
Specified by: exception
in interface ITrace
isLogging
public boolean isLogging (long reqLevel,
java.lang.Object clas,
java.lang.String meth)
Deprecated. Are we tracing the specified method at the specified level?
setLogging
public void setLogging (boolean state)
Deprecated. Set if trace is enabled. If true, logging will be enabled in memory,
to make a change to the state of the tracer persistently you must
modify the SystemConfiguration object setttings via the ui or console.
getIntLevel
public static int getIntLevel (long reqLevel)
Deprecated.
Returns: int level corresponding to long constant (defined by JLOG). See Also: getLongLevel(int)
getLongLevel
public static long getLongLevel (int intLevel)
Deprecated.
Returns: long constant (defined by JLOG)
corresponding to specified int level. See Also: getIntLevel(long)
shutdown
public static void shutdown ()
throws WavesetException
Deprecated. Shutdown the singleton and release any resources.
Throws:
WavesetException
println
protected static void println (java.lang.Object o)
Deprecated. Ubiquitous macro.