io.opentelemetry.baggage

Class BaggageUtils

java.lang.Object

io.opentelemetry.baggage.BaggageUtils

@Immutable
public final class BaggageUtils
extends Object

Utility methods for accessing the Baggage contained in the Context.

Since:

0.9.0

Method Summary

Modifier and Type	Method and Description
static io.opentelemetry.context.Scope	currentContextWith(Baggage baggage) Returns a new Scope encapsulating the provided Baggage added to the current Context.
static Baggage	getBaggage(io.grpc.Context context) Returns the Baggage from the specified Context, falling back to an empty Baggage.
static Baggage	getBaggageWithoutDefault(io.grpc.Context context) Returns the Baggage from the specified Context.
static Baggage	getCurrentBaggage() Returns the Baggage from the current context, falling back to an empty Baggage.
static io.grpc.Context	withBaggage(Baggage baggage, 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

withBaggage

public static io.grpc.Context withBaggage(Baggage baggage,
                                          io.grpc.Context context)

Creates a new Context with the given value set.

Parameters:

baggage - the value to be set.

context - the parent Context.

Returns:

a new context with the given value set.

Since:

0.9.0

getCurrentBaggage

public static Baggage getCurrentBaggage()

Returns the Baggage from the current context, falling back to an empty Baggage.

Returns:

the Baggage from the current context.

Since:

0.9.0

getBaggage

public static Baggage getBaggage(io.grpc.Context context)

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

Parameters:

context - the specified Context.

Returns:

the Baggage from the specified Context.

Since:

0.9.0

getBaggageWithoutDefault

@Nullable
public static Baggage getBaggageWithoutDefault(io.grpc.Context context)

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

Parameters:

context - the specified Context.

Returns:

the Baggage from the specified Context.

Since:

0.9.0

currentContextWith

public static io.opentelemetry.context.Scope currentContextWith(Baggage baggage)

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

Parameters:

baggage - the Baggage to be added to the current Context.

Returns:

the Scope for the updated Context.

Since:

0.9.0