io.micrometer.tracing.http.Request Maven / Gradle / Ivy
/**
* Copyright 2022 the original author or 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
*
* https://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.micrometer.tracing.http;
import java.util.Collection;
import io.micrometer.observation.transport.Kind;
/**
* This API is taken from OpenZipkin Brave.
*
* Abstract request type used for parsing and sampling.
*
* @author OpenZipkin Brave Authors
* @author Marcin Grzejszczak
* @since 1.10.0
*/
public interface Request {
/**
* Returns the header names.
* @return collection of header names
*/
Collection headerNames();
/**
* Returns the transport kind.
* @return the remote kind describing the direction and type of the request
*/
Kind kind();
/**
* Returns the underlying request object.
* @return the underlying request object or {@code null} if there is none
*/
Object unwrap();
}