-
Notifications
You must be signed in to change notification settings - Fork 9
/
Formatter.java
51 lines (46 loc) · 1.89 KB
/
Formatter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
* Copyright (c) 2017-2018 eBay Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.ebay.opentracing.basic;
/**
* Interface used to define the ability to marshal span context data to and from a particular
* data type. This works around the funky OpenTracing API (i.e., {@link io.opentracing.propagation.Format} and its
* uses in {@link io.opentracing.Tracer#inject(io.opentracing.SpanContext, io.opentracing.propagation.Format, Object)} /
* {@link io.opentracing.Tracer#extract(io.opentracing.propagation.Format, Object)}) that are difficult to define and
* use.
*
* @param <T> trace context type
* @param <C> carrier data object type
*/
public interface Formatter<T, C> {
/**
* Performs the work of
* {@link io.opentracing.Tracer#inject(io.opentracing.SpanContext, io.opentracing.propagation.Format, Object)}
* to apply span context to a carrier data instance.
*
* @param spanContext span context
* @param carrier carrier data container
*/
void inject(InternalSpanContext<T> spanContext, C carrier);
/**
* Performs the work of
* {@link io.opentracing.Tracer#extract(io.opentracing.propagation.Format, Object)}
* to extract span context data from a carrier data instance.
*
* @param carrier carrier data container
* @return reconstituted span context
*/
InternalSpanContext<T> extract(C carrier);
}