io.opentracing.propagation.TextMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentracing-api Show documentation

OpenTracing Java API

There is a newer version: 0.33.0

/*
 * Copyright 2016-2017 The OpenTracing 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.opentracing.propagation;

import io.opentracing.SpanContext;
import java.util.Iterator;

import java.util.Map;

/**
 * TextMap is a built-in carrier for Tracer.inject() and Tracer.extract(). TextMap implementations allows Tracers to
 * read and write key:value String pairs from arbitrary underlying sources of data.
 *
 * @see io.opentracing.Tracer#inject(SpanContext, Format, Object)
 * @see io.opentracing.Tracer#extract(Format, Object)
 */
public interface TextMap extends Iterable> {
    /**
     * Gets an iterator over arbitrary key:value pairs from the TextMapReader.
     *
     * @return entries in the TextMap backing store; note that for some Formats, the iterator may include entries that
     * were never injected by a Tracer implementation (e.g., unrelated HTTP headers)
     *
     * @see io.opentracing.Tracer#extract(Format, Object)
     * @see Format.Builtin#TEXT_MAP
     * @see Format.Builtin#HTTP_HEADERS
     */
    Iterator> iterator();

    /**
     * Puts a key:value pair into the TextMapWriter's backing store.
     *
     * @param key a String, possibly with constraints dictated by the particular Format this TextMap is paired with
     * @param value a String, possibly with constraints dictated by the particular Format this TextMap is paired with
     *
     * @see io.opentracing.Tracer#inject(io.opentracing.SpanContext, Format, Object)
     * @see Format.Builtin#TEXT_MAP
     * @see Format.Builtin#HTTP_HEADERS
     */
    void put(String key, String value);
}