org.cojen.dirmi

Annotation Type Trace

@Retention(value=RUNTIME)
 @Target(value={METHOD,CONSTRUCTOR})
public @interface Trace

Method annotation which indicates that it can be traced. In order to enable tracing, the TraceAgent must be installed. Method tracing is not limited to remote methods. Any method can be traced, even if no remote features of Dirmi are being used.

When using this annotation on remote interfaces, tracing is applied only to client-side invocations. For server-side tracing, the implementing class must provide its own trace annotations.

Because method tracing increases execution overhead, use the feature judiciously. Ideal candidates are those which perform complex calculations or depend on external resources.

Author:

Brian S O'Neill

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	args Set to true to pass method arguments to trace handler.
boolean	exception Set to true to pass thrown exception to trace handler.
boolean	graft Set to true to indicate to trace handlers that this trace should be ignored unless the current thread is already being traced.
String	operation Optionally specify an operation name to pass to trace handler.
boolean	result Set to true to pass method return value to trace handler.
boolean	root Set to true to indicate to trace handlers that this trace should be reported as a call entry root, even if the current thread is already being traced.
boolean	time Set to false to disable method execution time measuring.

Element Detail

operation

public abstract String operation

Optionally specify an operation name to pass to trace handler.

Default:

""

args

public abstract boolean args

Set to true to pass method arguments to trace handler.

Default:

false

result

public abstract boolean result

Set to true to pass method return value to trace handler.

Default:

false

exception

public abstract boolean exception

Set to true to pass thrown exception to trace handler.

Default:

false

time

public abstract boolean time

Set to false to disable method execution time measuring.

Default:

true

root

public abstract boolean root

Set to true to indicate to trace handlers that this trace should be reported as a call entry root, even if the current thread is already being traced.

Default:

false

graft

public abstract boolean graft

Set to true to indicate to trace handlers that this trace should be ignored unless the current thread is already being traced. In general, set graft for methods which are expected to run quickly.

Default:

false