com.github.kristofa.brave.ServerSpanState Maven / Gradle / Ivy

Go to download
package com.github.kristofa.brave;

import com.github.kristofa.brave.internal.Nullable;

import com.twitter.zipkin.gen.Endpoint;

/**
 * Maintains server span state.
 * 
 * @author kristof
 */
public interface ServerSpanState extends CommonSpanState {

    /**
     * Gets the Span for the server request we are currently part of.
     * 
     * Should be thread-aware to support multiple parallel requests.
     * 
     * @return Server request span for current thread. This will return the span we are part of. In case we should not trace
     *         current request null will be returned.
     */
    @Nullable
    ServerSpan getCurrentServerSpan();

    /**
     * Gets the Endpoint (ip, port, service name) for this service.
     *
     * @return Endpoint for this service.
     */
    Endpoint getServerEndpoint();

    /**
     * Set span for current request.
     * 
     * @param span Span for current request.
     */
    void setCurrentServerSpan(final ServerSpan span);

}