rocks.inspectit.agent.java.sdk.opentracing.propagation

Class AbstractPropagator<C>

java.lang.Object

rocks.inspectit.agent.java.sdk.opentracing.propagation.AbstractPropagator<C>

Type Parameters:

C - type of carrier

All Implemented Interfaces:

Propagator<C>

Direct Known Subclasses:

TextMapPropagator, UrlEncodingPropagator

public abstract class AbstractPropagator<C>
extends java.lang.Object
implements Propagator<C>

Abstract Propagator that knows what is injected and extracted from the carrier. Implementing classes must only provide injectBaggage(Object, String, String) and extractBaggage(Object) methods, where they can deal with any needed operations as encoding for example.

Constructor Summary

Constructors

Constructor and Description
AbstractPropagator()

Method Summary

Modifier and Type	Method and Description
SpanContextImpl	extract(C carrier) Extract the span context from the carrier.
protected abstract java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>	extractBaggage(C carrier) Gets all baggage (not only tracing related) from the carrier.
void	inject(SpanContextImpl spanContext, C carrier) Injects the span context to the carrier.
protected abstract void	injectBaggage(C carrier, java.lang.String key, java.lang.String value) Injects one baggage item to the carrier.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPropagator

public AbstractPropagator()

Method Detail

injectBaggage

protected abstract void injectBaggage(C carrier,
                                      java.lang.String key,
                                      java.lang.String value)

Injects one baggage item to the carrier. Sub-class is responsible of providing exactly this key/value once extractBaggage(Object) is called, but can wrap the key/value in what ever they want.

Parameters:

carrier - carrier

key - key

value - value

extractBaggage

protected abstract java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> extractBaggage(C carrier)

Gets all baggage (not only tracing related) from the carrier. For example the HTTP carrier would here provide all headers. Subclasses can deal here with additional operations as encoding.

Parameters:

carrier - carrier

Returns:

Itarbale

inject

public void inject(SpanContextImpl spanContext,
                   C carrier)

Injects the span context to the carrier.

Specified by:

inject in interface Propagator<C>

Parameters:

spanContext - context

carrier - carrier

extract

public SpanContextImpl extract(C carrier)

Extract the span context from the carrier.

Specified by:

extract in interface Propagator<C>

Parameters:

carrier - carrier

Returns:

span context