Top Fields Constructors Methods
io.opentelemetry.context.propagation

pack-priv final Class MultiTextMapPropagator

extends Object
implements TextMapPropagator
Class Inheritance
All Implemented Interfaces
io.opentelemetry.context.propagation.TextMapPropagator
Imports
io.opentelemetry.context.Context, java.util.ArrayList, .Arrays, .Collection, .Collections, .LinkedHashSet, .List, .Set, javax.annotation.Nullable

Field Summary

Modifier and TypeField and Description
private final Collection<String>
allFields

private final TextMapPropagator[]
textMapPropagators

Constructor Summary

AccessConstructor and Description
pack-priv
MultiTextMapPropagator(TextMapPropagator... textMapPropagators)

pack-priv
MultiTextMapPropagator(List<TextMapPropagator> textMapPropagators)

Method Summary

Modifier and TypeMethod and Description
public <C> Context
extract(Context
the Context used to store the extracted value.
context, C
holds propagation fields. For example, an outgoing message or http request.
carrier, TextMapGetter<C>
invoked for each propagation key to get data from the carrier.
getter)

Implements io.opentelemetry.context.propagation.TextMapPropagator.extract.

Extracts data from upstream.

public Collection<String>
fields()

Implements io.opentelemetry.context.propagation.TextMapPropagator.fields.

The propagation fields defined.

private static List<String>
getAllFields(TextMapPropagator[] textPropagators)

public <C> void
inject(Context
the Context containing the value to be injected.
context, C
holds propagation fields. For example, an outgoing message or http request.
carrier, TextMapSetter<C>
invoked for each propagation key to add or remove.
setter)

Implements io.opentelemetry.context.propagation.TextMapPropagator.inject.

Injects data for downstream consumers, for example as HTTP headers.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

allFieldsback to summary
private final Collection<String> allFields
textMapPropagatorsback to summary
private final TextMapPropagator[] textMapPropagators

Constructor Detail

MultiTextMapPropagatorback to summary
pack-priv MultiTextMapPropagator(TextMapPropagator... textMapPropagators)
MultiTextMapPropagatorback to summary
pack-priv MultiTextMapPropagator(List<TextMapPropagator> textMapPropagators)

Method Detail

extractback to summary
public <C> Context extract(Context context, C carrier, TextMapGetter<C> getter)

Implements io.opentelemetry.context.propagation.TextMapPropagator.extract.

Doc from io.opentelemetry.context.propagation.TextMapPropagator.extract.

Extracts data from upstream. For example, from incoming http headers. The returned Context should contain the extracted data, if any, merged with the data from the passed-in Context.

If the incoming information could not be parsed, implementations MUST return the original Context, unaltered.

Parameters
<C>
the type of carrier of the propagation fields, such as an http request.
context:Context

the Context used to store the extracted value.

carrier:C

holds propagation fields. For example, an outgoing message or http request.

getter:TextMapGetter<C>

invoked for each propagation key to get data from the carrier.

Returns:Context

the Context containing the extracted data.

Annotations
@Override
fieldsback to summary
public Collection<String> fields()

Implements io.opentelemetry.context.propagation.TextMapPropagator.fields.

Doc from io.opentelemetry.context.propagation.TextMapPropagator.fields.

The propagation fields defined. If your carrier is reused, you should delete the fields here before calling inject(Context, Object, TextMapSetter) )}.

For example, if the carrier is a single-use or immutable request object, you don't need to clear fields as they couldn't have been set before. If it is a mutable, retryable object, successive calls should clear these fields first.

Some use cases for this are:

  • Allow pre-allocation of fields, especially in systems like gRPC Metadata
  • Allow a single-pass over an iterator
Returns:Collection<String>

the fields that will be used by this formatter.

Annotations
@Override
getAllFieldsback to summary
private static List<String> getAllFields(TextMapPropagator[] textPropagators)
injectback to summary
public <C> void inject(Context context, C carrier, TextMapSetter<C> setter)

Implements io.opentelemetry.context.propagation.TextMapPropagator.inject.

Doc from io.opentelemetry.context.propagation.TextMapPropagator.inject.

Injects data for downstream consumers, for example as HTTP headers. The carrier may be null to facilitate calling this method with a lambda for the TextMapSetter, in which case that null will be passed to the TextMapSetter implementation.

Parameters
<C>
carrier of propagation fields, such as an http request
context:Context

the Context containing the value to be injected.

carrier:C

holds propagation fields. For example, an outgoing message or http request.

setter:TextMapSetter<C>

invoked for each propagation key to add or remove.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override