Class TraceContext

java.lang.Object

com.soklet.TraceContext

@ThreadSafe
public final class TraceContext
extends Object

Parsed W3C trace context from traceparent and tracestate HTTP header values.

This type models the normalized trace context understood by Soklet. Future-version extension fields are ignored and not preserved.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object object)
static @NonNull Optional<TraceContext>	fromHeaderValues(@Nullable Collection<@NonNull String> traceparentHeaderValues, @Nullable List<@NonNull String> tracestateHeaderValues)	Parses W3C trace context from physical HTTP header values.
@NonNull String	getParentId()	Returns the 16-character lowercase hexadecimal parent identifier.
@NonNull Integer	getTraceFlags()	Returns the trace flags as an unsigned 8-bit value represented by an Integer.
@NonNull String	getTraceId()	Returns the 32-character lowercase hexadecimal trace identifier.
@NonNull List<@NonNull TraceStateEntry>	getTraceStateEntries()	Returns the normalized W3C tracestate entries.
int	hashCode()
@NonNull Boolean	isSampled()	Is the W3C sampled flag set?
@NonNull String	toString()
@NonNull String	toTraceparentHeaderValue()	Returns this context in W3C traceparent header value form.
@NonNull Optional<String>	toTracestateHeaderValue()	Returns this context's normalized W3C tracestate header value.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

fromHeaderValues

public static @NonNull Optional<TraceContext> fromHeaderValues(@Nullable Collection<@NonNull String> traceparentHeaderValues,
 @Nullable List<@NonNull String> tracestateHeaderValues)

Parses W3C trace context from physical HTTP header values.

Parameters:

traceparentHeaderValues - the physical traceparent header values

tracestateHeaderValues - the physical tracestate header values, in arrival order

Returns:

the parsed trace context, or Optional.empty() if no valid traceparent is available

getTraceId

public @NonNull String getTraceId()

Returns the 32-character lowercase hexadecimal trace identifier.

Returns:

the trace identifier

getParentId

public @NonNull String getParentId()

Returns the 16-character lowercase hexadecimal parent identifier.

Returns:

the parent identifier

getTraceFlags

public @NonNull Integer getTraceFlags()

Returns the trace flags as an unsigned 8-bit value represented by an Integer.

Returns:

the trace flags, in the range 0..255

isSampled

public @NonNull Boolean isSampled()

Is the W3C sampled flag set?

Returns:

true if the sampled flag is set

getTraceStateEntries

public @NonNull List<@NonNull TraceStateEntry> getTraceStateEntries()

Returns the normalized W3C tracestate entries.

Returns:

the trace-state entries, or an empty list if none are present

toTraceparentHeaderValue

public @NonNull String toTraceparentHeaderValue()

Returns this context in W3C traceparent header value form.

Returns:

the traceparent header value

toTracestateHeaderValue

public @NonNull Optional<String> toTracestateHeaderValue()

Returns this context's normalized W3C tracestate header value.

Returns:

the tracestate header value, or Optional.empty() if none is present

toString

public @NonNull String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object