org.cojen.dirmi.trace

Class ScopedTraceHandler

java.lang.Object

org.cojen.dirmi.trace.ScopedTraceHandler

All Implemented Interfaces:

TraceHandler

Direct Known Subclasses:

SimpleHandler

public abstract class ScopedTraceHandler
extends Object
implements TraceHandler

Abstract trace handler which gathers data on traced methods and reports it upon scope exit. A scope is created when a thread enters a traced method for the first time. If the traced method is marked as root, then a child scope is created. A traced method marked as graft cannot create scopes -- it can only participate in existing ones.

When the traced method that created the scope exits, the scope exits, and gathered data is reported. If a parent scope exists, this data is transferred to it as well.

Author:

Brian S O'Neill

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScopedTraceHandler.MethodData
static class	ScopedTraceHandler.Scope

Constructor Summary

Constructors

Constructor and Description
ScopedTraceHandler(TraceToolbox toolbox)

Method Summary

Modifier and Type	Method and Description
void	enterMethod(int mid) Called by a traced method upon entry.
void	enterMethod(int mid, Object... arguments) Called by a traced method upon entry.
void	enterMethod(int mid, Object argument) Called by a traced method upon entry.
void	exitMethod(int mid) Called by a traced method upon exit.
void	exitMethod(int mid, long timeNanos) Called by a traced method upon exit.
void	exitMethod(int mid, Object result) Called by a traced method upon exit.
void	exitMethod(int mid, Object result, long timeNanos) Called by a traced method upon exit.
void	exitMethod(int mid, Throwable t) Called by a traced method upon exit caused by a thrown exception.
void	exitMethod(int mid, Throwable t, long timeNanos) Called by a traced method upon exit caused by a thrown exception.
protected TraceToolbox	getToolbox()
TraceModes	getTraceModes(String className) Always returns TraceModes.ALL_USER.
protected abstract void	report(ScopedTraceHandler.Scope scope) Called when a scope exits, allowing subclasses to report on the data it gathered.
protected Object	scopeGet(String key) Retrieve an arbitrary key-value pair from the current scope, unless there is no current scope.
protected boolean	scopePut(String key, Object value) Add an arbitrary key-value pair to the current scope, unless there is no current scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScopedTraceHandler

public ScopedTraceHandler(TraceToolbox toolbox)

Method Detail

getTraceModes

public TraceModes getTraceModes(String className)

Always returns TraceModes.ALL_USER.

Specified by:

getTraceModes in interface TraceHandler

Parameters:

className - full name of class which may contain traced methods

Returns:

modes or null if none allowed

enterMethod

public void enterMethod(int mid)

Description copied from interface: TraceHandler

Called by a traced method upon entry.

Specified by:

enterMethod in interface TraceHandler

Parameters:

mid - method id

enterMethod

public void enterMethod(int mid,
                        Object argument)

Description copied from interface: TraceHandler

Called by a traced method upon entry. This method is never called if the trace was not configured to pass arguments or if the traced method has no arguments.

Specified by:

enterMethod in interface TraceHandler

Parameters:

mid - method id

argument - argument passed to method; is "this" for non-static method

enterMethod

public void enterMethod(int mid,
                        Object... arguments)

Description copied from interface: TraceHandler

Called by a traced method upon entry. This method is never called if the trace was not configured to pass arguments or if the traced method has no arguments.

Specified by:

enterMethod in interface TraceHandler

Parameters:

mid - method id

arguments - arguments passed to method; first is "this" for non-static method

exitMethod

public void exitMethod(int mid)

Description copied from interface: TraceHandler

Called by a traced method upon exit.

Specified by:

exitMethod in interface TraceHandler

Parameters:

mid - method id

exitMethod

public void exitMethod(int mid,
                       long timeNanos)

Description copied from interface: TraceHandler

Called by a traced method upon exit. This method is never called if the trace was not configured to measure execution time.

Specified by:

exitMethod in interface TraceHandler

Parameters:

mid - method id

timeNanos - total execution time of method, in nanoseconds

exitMethod

public void exitMethod(int mid,
                       Object result)

Description copied from interface: TraceHandler

Called by a traced method upon exit. This method is never called if the trace was not configured to pass return values or if the traced method returns void.

Specified by:

exitMethod in interface TraceHandler

Parameters:

mid - method id

result - method return value

exitMethod

public void exitMethod(int mid,
                       Object result,
                       long timeNanos)

Description copied from interface: TraceHandler

Called by a traced method upon exit. This method is never called if the trace was not configured to pass return values and measure execution time.

Specified by:

exitMethod in interface TraceHandler

Parameters:

mid - method id

result - method return value

timeNanos - total execution time of method, in nanoseconds

exitMethod

public void exitMethod(int mid,
                       Throwable t)

Description copied from interface: TraceHandler

Called by a traced method upon exit caused by a thrown exception. This method is never called if the trace was not configured to pass thrown exceptions.

Specified by:

exitMethod in interface TraceHandler

Parameters:

mid - method id

t - exception thrown by method

exitMethod

public void exitMethod(int mid,
                       Throwable t,
                       long timeNanos)

Description copied from interface: TraceHandler

Called by a traced method upon exit caused by a thrown exception. This method is never called if the trace was not configured to pass thrown exceptions and measure execution time.

Specified by:

exitMethod in interface TraceHandler

Parameters:

mid - method id

t - exception thrown by method

timeNanos - total execution time of method, in nanoseconds

getToolbox

protected TraceToolbox getToolbox()

scopePut

protected boolean scopePut(String key,
                           Object value)

Add an arbitrary key-value pair to the current scope, unless there is no current scope.

Returns:

true if in a scope

scopeGet

protected Object scopeGet(String key)

Retrieve an arbitrary key-value pair from the current scope, unless there is no current scope.

report

protected abstract void report(ScopedTraceHandler.Scope scope)

Called when a scope exits, allowing subclasses to report on the data it gathered.