Module brave

Package brave.propagation

Class B3Propagation<K>

java.lang.Object

brave.propagation.B3Propagation<K>

All Implemented Interfaces:

Propagation<K>

public final class B3Propagation<K>
extends java.lang.Object
implements Propagation<K>

Implements B3 Propagation

Nested Class Summary

Nested classes/interfaces inherited from interface brave.propagation.Propagation

Propagation.Factory, Propagation.Getter<C,K>, Propagation.KeyFactory<K>, Propagation.Setter<C,K>

Field Summary

Fields

Modifier and Type	Field	Description
static Propagation.Factory	FACTORY

Fields inherited from interface brave.propagation.Propagation

B3_SINGLE_STRING, B3_STRING

Method Summary

Modifier and Type	Method	Description
<C> TraceContext.Extractor<C>	extractor(Propagation.Getter<C,K> getter)
<C> TraceContext.Injector<C>	injector(Propagation.Setter<C,K> setter)	Replaces a propagated field with the given value.
java.util.List<K>	keys()	The propagation fields defined.

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final Propagation.Factory FACTORY

Method Detail

keys

public java.util.List<K> keys()

Description copied from interface: Propagation

The propagation fields defined. If your carrier is reused, you should delete the fields here before calling Propagation.Setter.put(Object, Object, String).

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.

Note: If your implementation carries "extra fields", such as correlation IDs, do not return the names of those fields here. If you do, they will be deleted, which can interfere with user headers.

Specified by:

keys in interface Propagation<K>

injector

public <C> TraceContext.Injector<C> injector(Propagation.Setter<C,K> setter)

Description copied from interface: Propagation

Replaces a propagated field with the given value. Saved as a constant to avoid runtime allocations. For example, a setter for an HttpURLConnection would be the method reference URLConnection.addRequestProperty(String, String)

Specified by:

injector in interface Propagation<K>

Parameters:

setter - invoked for each propagation key to add.

extractor

public <C> TraceContext.Extractor<C> extractor(Propagation.Getter<C,K> getter)

Specified by:

extractor in interface Propagation<K>

Parameters:

getter - invoked for each propagation key to get.