io.opentracing.propagation

Interface HttpHeaderWriter

public interface HttpHeaderWriter

HttpHeaderWriter is a built-in carrier for Tracer.inject(). HttpHeaderWriter implementations allows Tracers to write key:value String pairs into arbitrary HTTP header representations. In this way, HttpHeaderWriter prevents a tight coupling between OpenTracing and any particular Java HTTP Header representation.

See Also:

Tracer.inject(io.opentracing.SpanContext, Object)

Method Summary

Modifier and Type	Method and Description
void	put(String key, String value) Puts a key:value pair into the HTTP header map.

Method Detail

put

void put(String key,
         String value)

Puts a key:value pair into the HTTP header map. Note that headers added via put() will often share the HTTP header map with other application data. As such, Tracers should use a unique prefix or substring to identify their header map entries.

Parameters:

key - a key suitable for use in an HTTP header (i.e., case-insensitive, no special characters, etc)

value - a value suitable for use in an HTTP header (i.e., URL-escaped)

See Also:

Tracer.inject(io.opentracing.SpanContext, Object)