Package kieker.monitoring.core.registry

Enum Class TraceRegistry

java.lang.Object

java.lang.Enum<TraceRegistry>

kieker.monitoring.core.registry.TraceRegistry

All Implemented Interfaces:

Serializable, Comparable<TraceRegistry>, Constable

public enum TraceRegistry
extends Enum<TraceRegistry>

Since:

1.5

Author:

Jan Waller

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The singleton instance.

Method Summary

Modifier and Type	Method	Description
final TraceMetadata	getTrace()	Gets a Trace for the current thread.
final ApplicationTraceMetadata	registerTrace()	This creates a new unique Trace object and registers it.
final void	setParentTraceId(Thread t, long traceId, int orderId)	Sets the parent for the next created trace inside this thread.
final void	unregisterTrace()	Unregisters the current Trace object.
static TraceRegistry	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TraceRegistry[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final TraceRegistry INSTANCE

The singleton instance.

Method Details

values

public static TraceRegistry[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TraceRegistry valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getTrace

public final TraceMetadata getTrace()

Gets a Trace for the current thread. If no trace is active, null is returned.

Returns:

Trace object or null

registerTrace

public final ApplicationTraceMetadata registerTrace()

This creates a new unique Trace object and registers it.

Returns:

Trace object

unregisterTrace

public final void unregisterTrace()

Unregisters the current Trace object. Future calls of getTrace() will either return null or the enclosing trace object.

setParentTraceId

public final void setParentTraceId(Thread t,
 long traceId,
 int orderId)

Sets the parent for the next created trace inside this thread. This method should be used by probes in connection with SpliEvents.

Parameters:

t - the thread the new trace belongs to

traceId - the parent trace id

orderId - the parent order id