io.opentelemetry.baggage

Interface BaggageManager

All Known Implementing Classes:

DefaultBaggageManager

@ThreadSafe
public interface BaggageManager

Object for creating new Baggages and Baggages based on the current context.

This class returns builders that can be used to create the implementation-dependent Baggages.

Implementations may have different constraints and are free to convert entry contexts to their own subtypes. This means callers cannot assume the current context is the same instance as the one placed into scope.

Since:

0.9.0

Method Summary

Modifier and Type	Method and Description
Baggage.Builder	baggageBuilder() Returns a new Baggage.Builder.
Baggage	getCurrentBaggage() Returns the current Baggage.
io.opentelemetry.context.Scope	withContext(Baggage distContext) Enters the scope of code where the given Baggage is in the current context (replacing the previous Baggage) and returns an object that represents that scope.

Method Detail

getCurrentBaggage

Baggage getCurrentBaggage()

Returns the current Baggage.

Returns:

the current Baggage.

Since:

0.9.0

baggageBuilder

Baggage.Builder baggageBuilder()

Returns a new Baggage.Builder.

Returns:

a new Baggage.Builder.

Since:

0.9.0

withContext

io.opentelemetry.context.Scope withContext(Baggage distContext)

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

Parameters:

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

Returns:

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

Since:

0.9.0