org.ameba.http.ctx.CallContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ameba-lib Show documentation
Ameba Utilities
There is a newer version: 4.1.0-jdk17
/*
 * Copyright 2005-2024 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
 *
 * 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 org.ameba.http.ctx;

import com.fasterxml.jackson.annotation.JsonIgnore;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.StringJoiner;

/**
 * A CallContext stores technical information about the current request execution.
 *
 * @author Heiko Scherrer
 */
public class CallContext implements Serializable {

    /** The name or ID of the calling process. */
    private String caller;
    /** The traceId of the current call context. */
    private String traceId;
    /** Arbitrary details populated as part of the {@link CallContext}. */
    private Map details = new HashMap<>();

    /**
     * Get the name of the business transaction.
     *
     * @return As String
     */
    public String getCaller() {
        return caller;
    }

    void setCaller(String caller) {
        this.caller = caller;
    }

    /**
     * Get the current traceId.
     *
     * @return As String
     */
    public String getTraceId() {
        return traceId;
    }

    /**
     * Get the current traceId.
     *
     * @return Optional String
     */
    @JsonIgnore
    public Optional getOptionalTraceId() {
        return Optional.ofNullable(traceId);
    }

    public void setTraceId(String traceId) {
        this.traceId = traceId;
    }

    /**
     * Get a map with arbitrary details bound to the current call context thread.
     *
     * @return As Map
     */
    public Map getDetails() {
        return details;
    }

    void setDetails(Map details) {
        this.details = details;
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof CallContext)) return false;
        var that = (CallContext) o;
        return Objects.equals(caller, that.caller) && Objects.equals(traceId, that.traceId) && Objects.equals(details, that.details);
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public int hashCode() {
        return Objects.hash(caller, traceId, details);
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public String toString() {
        return new StringJoiner(", ", CallContext.class.getSimpleName() + "[", "]")
                .add("caller='" + caller + "'")
                .add("traceId='" + traceId + "'")
                .add("details=" + details)
                .toString();
    }
}