org.refcodes.runtime

Enum Correlation

java.lang.Object

java.lang.Enum<Correlation>

org.refcodes.runtime.Correlation

All Implemented Interfaces:

Serializable, Comparable<Correlation>, org.refcodes.mixin.IdAccessor<String>, org.refcodes.mixin.IdAccessor.IdMutator<String>, org.refcodes.mixin.IdAccessor.IdProperty<String>

public enum Correlation
extends Enum<Correlation>
implements org.refcodes.mixin.IdAccessor.IdProperty<String>

The Correlation assigns an according (as of the enumeration) Correlation-ID to the invoking process, this ID is used in log files and is part of the process's request or response pay-load in order to track process execution throughout a JVM.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.IdAccessor

org.refcodes.mixin.IdAccessor.IdMutator<T>, org.refcodes.mixin.IdAccessor.IdProperty<T>

Enum Constant Summary

Enum Constants

Enum Constant and Description
REQUEST A single request spanning over multiple systems.
SESSION Identifying a session for multiple requests spanning over multiple systems. traced.

Method Summary

Modifier and Type	Method and Description
String	getId() Retrieves the Correlation-ID assigned to the current Thread.
static boolean	hasAnyCorrelationId() Evaluates whether any of the given Correlation-IDs is present (not null).
String	nextId() Creates a new Correlation-ID no matter whether there is a Correlation-ID already assigned to the current thread or not.
String	pullId() Returns a Correlation-ID in any case: Creates a new Correlation-ID in case there is none yet for the current thread.
void	setId(String aCorrelationId) Assigns the given Correlation-ID to the current Thread.
static String	toFullCorrelationId() Returns a String with all Correlation-IDs found separated by a Delimiter.CORRELATION_ID character from each other.
static Correlation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Correlation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUEST

public static final Correlation REQUEST

A single request spanning over multiple systems.

SESSION

public static final Correlation SESSION

Identifying a session for multiple requests spanning over multiple systems. traced.

Method Detail

values

public static Correlation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Correlation c : Correlation.values())
    System.out.println(c);

Returns:

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

valueOf

public static Correlation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

setId

public void setId(String aCorrelationId)

Assigns the given Correlation-ID to the current Thread.

Specified by:

setId in interface org.refcodes.mixin.IdAccessor.IdMutator<String>

Parameters:

aCorrelationId - The Correlation-ID to be assigned to the current Thread.

getId

public String getId()

Retrieves the Correlation-ID assigned to the current Thread. Call pullId() to make sure a Correlation-ID is created for the current thread if none exists yet or call nextId() in order to create a new Correlation-ID.

Specified by:

getId in interface org.refcodes.mixin.IdAccessor<String>

Returns:

The Correlation-ID of the current Thread.

pullId

public String pullId()

Returns a Correlation-ID in any case: Creates a new Correlation-ID in case there is none yet for the current thread. Else the current Correlation-ID is returned.

Returns:

The Correlation-ID as of now.

nextId

public String nextId()

Creates a new Correlation-ID no matter whether there is a Correlation-ID already assigned to the current thread or not.

toFullCorrelationId

public static String toFullCorrelationId()

Returns a String with all Correlation-IDs found separated by a Delimiter.CORRELATION_ID character from each other. Any portion of the full Correlation-ID not being set is represented by a "" sequence defined by Literal.UNKNOWN.

Returns:

The full Correlation-ID.

hasAnyCorrelationId

public static boolean hasAnyCorrelationId()

Evaluates whether any of the given Correlation-IDs is present (not null).

Returns:

True if at least one Correlation-ID is not null.