Serializable
, Comparable<String>
, 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>
Correlation
assigns an according (as of the enumeration)
Correlation-TID to the invoking process, this TID 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.org.refcodes.mixin.IdAccessor.IdBuilder<T extends Object,B extends org.refcodes.mixin.IdAccessor.IdBuilder<T,B>>, org.refcodes.mixin.IdAccessor.IdMutator<T extends Object>, org.refcodes.mixin.IdAccessor.IdProperty<T extends Object>
Enum Constant | Description |
---|---|
REQUEST |
A single request spanning over multiple systems.
|
SESSION |
Identifying a session for multiple requests spanning over multiple
systems. traced.
|
Modifier and Type | Method | Description |
---|---|---|
String |
getId() |
Retrieves the Correlation-TID 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-TID no matter whether there is a
Correlation-TID already assigned to the current thread or not.
|
String |
pullId() |
Returns a Correlation-TID in any case: Creates a new Correlation-TID in
case there is none yet for the current thread.
|
void |
setId(String aCorrelationId) |
Assigns the given Correlation-TID 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.
|
public static final Correlation REQUEST
public static final Correlation SESSION
public static Correlation[] values()
for (Correlation c : Correlation.values()) System.out.println(c);
public static Correlation valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic void setId(String aCorrelationId)
Thread
.public String getId()
public String pullId()
public String nextId()
public static String toFullCorrelationId()
String
with all Correlation-IDs found separated by a
Delimiter.CORRELATION_ID
character from each other. Any portion
of the full Correlation-TID not being set is represented by a "<?>"
sequence defined by Literal.UNKNOWN
.public static boolean hasAnyCorrelationId()
Copyright © 2021. All rights reserved.