io.opentelemetry.correlationcontext

Class CorrelationsContextUtils

java.lang.Object

io.opentelemetry.correlationcontext.CorrelationsContextUtils

@Immutable
public final class CorrelationsContextUtils
extends Object

Utility methods for accessing the CorrelationContext contained in the Context.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
static io.opentelemetry.context.Scope	currentContextWith(CorrelationContext corrContext) Returns a new Scope encapsulating the provided CorrelationContext added to the current Context.
static CorrelationContext	getCorrelationContext(io.grpc.Context context) Returns the CorrelationContext from the specified Context, falling back to an empty CorrelationContext.
static CorrelationContext	getCorrelationContextWithoutDefault(io.grpc.Context context) Returns the CorrelationContext from the specified Context.
static CorrelationContext	getCurrentCorrelationContext() Returns the CorrelationContext from the current Context, falling back to an empty CorrelationContext.
static io.grpc.Context	withCorrelationContext(CorrelationContext corrContext, io.grpc.Context context) Creates a new Context with the given value set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withCorrelationContext

public static io.grpc.Context withCorrelationContext(CorrelationContext corrContext,
                                                     io.grpc.Context context)

Creates a new Context with the given value set.

Parameters:

corrContext - the value to be set.

context - the parent Context.

Returns:

a new context with the given value set.

Since:

0.1.0

getCurrentCorrelationContext

public static CorrelationContext getCurrentCorrelationContext()

Returns the CorrelationContext from the current Context, falling back to an empty CorrelationContext.

Returns:

the CorrelationContext from the current Context.

Since:

0.3.0

getCorrelationContext

public static CorrelationContext getCorrelationContext(io.grpc.Context context)

Returns the CorrelationContext from the specified Context, falling back to an empty CorrelationContext.

Parameters:

context - the specified Context.

Returns:

the CorrelationContext from the specified Context.

Since:

0.3.0

getCorrelationContextWithoutDefault

@Nullable
public static CorrelationContext getCorrelationContextWithoutDefault(io.grpc.Context context)

Returns the CorrelationContext from the specified Context. If none is found, this method returns {code null}.

Parameters:

context - the specified Context.

Returns:

the CorrelationContext from the specified Context.

Since:

0.1.0

currentContextWith

public static io.opentelemetry.context.Scope currentContextWith(CorrelationContext corrContext)

Returns a new Scope encapsulating the provided CorrelationContext added to the current Context.

Parameters:

corrContext - the CorrelationContext to be added to the current Context.

Returns:

the Scope for the updated Context.

Since:

0.1.0