io.gravitee.node.api.healthcheck.ProbeEvaluator Maven / Gradle / Ivy

Go to download

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

There is a newer version: 7.0.2

package io.gravitee.node.api.healthcheck;

import java.util.Map;
import java.util.Set;
import java.util.concurrent.CompletableFuture;

/**
 * This registry that holds all the registered probes (see {@link ProbeManager}) and allows evaluating them in a single call.
 *
 * @author Jeoffrey HAEYAERT (jeoffrey.haeyaert at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface ProbeEvaluator {
    /**
     * Evaluate all the registered probes.
     * In case a {@link Probe} is cacheable, the probe will be checked again only if the time elapsed since the last evaluation is above a particular threshold.
     *
     * @return a {@link CompletableFuture} with the map of all evaluated probes.
     */
    CompletableFuture> evaluate();

    /**
     * Same as {@link ProbeEvaluator#evaluate(Set)} but only for the probes id given
     * In case a {@link Probe} is cacheable, the probe will be checked again only if the time elapsed since the last evaluation is above a particular threshold.
     *
     * @param probeIds the ids of the probes to evaluate
     * @return a {@link CompletableFuture} with the map of all evaluated probes.
     */
    CompletableFuture> evaluate(final Set probeIds);
}