io.opentelemetry.correlationcontext

Class DefaultCorrelationContextManager

java.lang.Object

io.opentelemetry.correlationcontext.DefaultCorrelationContextManager

All Implemented Interfaces:

CorrelationContextManager

@ThreadSafe
public final class DefaultCorrelationContextManager
extends Object
implements CorrelationContextManager

No-op implementations of CorrelationContextManager.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
DefaultCorrelationContextManager()

Method Summary

Modifier and Type	Method and Description
CorrelationContext.Builder	contextBuilder() Returns a new Builder.
CorrelationContext	getCurrentContext() Returns the current CorrelationContext.
static CorrelationContextManager	getInstance() Returns a CorrelationContextManager singleton that is the default implementation for CorrelationContextManager.
io.opentelemetry.context.Scope	withContext(CorrelationContext distContext) Enters the scope of code where the given CorrelationContext is in the current context (replacing the previous CorrelationContext) and returns an object that represents that scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCorrelationContextManager

public DefaultCorrelationContextManager()

Method Detail

getInstance

public static CorrelationContextManager getInstance()

Returns a CorrelationContextManager singleton that is the default implementation for CorrelationContextManager.

Returns:

a CorrelationContextManager singleton that is the default implementation for CorrelationContextManager.

getCurrentContext

public CorrelationContext getCurrentContext()

Description copied from interface: CorrelationContextManager

Returns the current CorrelationContext.

Specified by:

getCurrentContext in interface CorrelationContextManager

Returns:

the current CorrelationContext.

contextBuilder

public CorrelationContext.Builder contextBuilder()

Description copied from interface: CorrelationContextManager

Returns a new Builder.

Specified by:

contextBuilder in interface CorrelationContextManager

Returns:

a new Builder.

withContext

public io.opentelemetry.context.Scope withContext(CorrelationContext distContext)

Description copied from interface: CorrelationContextManager

Enters the scope of code where the given CorrelationContext is in the current context (replacing the previous CorrelationContext) and returns an object that represents that scope. The scope is exited when the returned object is closed.

Specified by:

withContext in interface CorrelationContextManager

Parameters:

distContext - the CorrelationContext to be set as the current context.

Returns:

an object that defines a scope where the given CorrelationContext is set as the current context.