io.micrometer.observation.transport.SenderContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micrometer-observation Show documentation
Module containing Observation related code
There is a newer version: 1.14.1
Show newest version
/*
 * Copyright 2022 VMware, 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
 *
 * 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.observation.transport;

import io.micrometer.common.lang.NonNull;
import io.micrometer.common.lang.Nullable;
import io.micrometer.observation.Observation;

import java.util.Objects;

/**
 * Context used when sending data over the wire in a fire and forget fashion.
 *
 * @author Marcin Grzejszczak
 * @since 1.10.0
 * @param  type of the carrier object
 */
public class SenderContext extends Observation.Context {

    private final Propagator.Setter setter;

    private final Kind kind;

    @Nullable
    private C carrier;

    @Nullable
    private String remoteServiceName;

    @Nullable
    private String remoteServiceAddress;

    /**
     * Creates a new instance of {@link SenderContext}.
     * @param setter propagator setter
     * @param kind kind
     */
    public SenderContext(@NonNull Propagator.Setter setter, @NonNull Kind kind) {
        this.setter = Objects.requireNonNull(setter, "Setter must be set");
        this.kind = Objects.requireNonNull(kind, "Kind must be set");
    }

    /**
     * Creates a new instance of a {@link Kind#PRODUCER} {@link SenderContext}.
     * @param setter propagator setter
     */
    public SenderContext(@NonNull Propagator.Setter setter) {
        this(setter, Kind.PRODUCER);
    }

    @Nullable
    public C getCarrier() {
        return carrier;
    }

    public void setCarrier(C carrier) {
        this.carrier = carrier;
    }

    public Propagator.Setter getSetter() {
        return setter;
    }

    public Kind getKind() {
        return kind;
    }

    /**
     * Return optional name for the service that will be called.
     * @return optional name for the service that will be called
     */
    @Nullable
    public String getRemoteServiceName() {
        return remoteServiceName;
    }

    /**
     * Set optional name for the service that will be called.
     * @param remoteServiceName name of the service that will be called
     */
    public void setRemoteServiceName(@Nullable String remoteServiceName) {
        this.remoteServiceName = remoteServiceName;
    }

    /**
     * Return optional address for the service that will be called.
     * @return optional address for the service that will be called
     */
    @Nullable
    public String getRemoteServiceAddress() {
        return remoteServiceAddress;
    }

    /**
     * Set optional service address for the service that will be called.
     * @param remoteServiceAddress service address for the service that will be called
     */
    public void setRemoteServiceAddress(@Nullable String remoteServiceAddress) {
        this.remoteServiceAddress = remoteServiceAddress;
    }

}