blob: a90f0419f9535bdccd3dc1d2812fe08e7138d7fa (
plain)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* Copyright 2017, OpenCensus Authors
*
* 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 io.opencensus.trace.propagation;
import io.opencensus.common.ExperimentalApi;
/**
* Container class for all the supported propagation formats. Currently supports only Binary format
* (see {@link BinaryFormat}) and B3 Text format (see {@link TextFormat}) but more formats will be
* added.
*
* @since 0.5
*/
public abstract class PropagationComponent {
private static final PropagationComponent NOOP_PROPAGATION_COMPONENT =
new NoopPropagationComponent();
/**
* Returns the {@link BinaryFormat} with the provided implementations. If no implementation is
* provided then no-op implementation will be used.
*
* @return the {@code BinaryFormat} implementation.
* @since 0.5
*/
public abstract BinaryFormat getBinaryFormat();
/**
* Returns the B3 {@link TextFormat} with the provided implementations. See <a
* href="https://github.com/openzipkin/b3-propagation">b3-propagation</a> for more information. If
* no implementation is provided then no-op implementation will be used.
*
* @since 0.11.0
* @return the B3 {@code TextFormat} implementation for B3.
*/
@ExperimentalApi
public abstract TextFormat getB3Format();
/**
* Returns an instance that contains no-op implementations for all the instances.
*
* @return an instance that contains no-op implementations for all the instances.
* @since 0.5
*/
public static PropagationComponent getNoopPropagationComponent() {
return NOOP_PROPAGATION_COMPONENT;
}
private static final class NoopPropagationComponent extends PropagationComponent {
@Override
public BinaryFormat getBinaryFormat() {
return BinaryFormat.getNoopBinaryFormat();
}
@Override
public TextFormat getB3Format() {
return TextFormat.getNoopTextFormat();
}
}
}
|
