org.eclipse.edc.spi.system.health.HealthCheckService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boot-spi Show documentation

edc :: boot-spi

The newest version!

/*
 *  Copyright (c) 2022 Microsoft Corporation
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Microsoft Corporation - Initial implementation
 *
 */

package org.eclipse.edc.spi.system.health;

import org.eclipse.edc.runtime.metamodel.annotation.ExtensionPoint;

/**
 * Provides information about the connector's health status.
 * The three different health aspects are based on Kubernetes' definition.
 * 
 * Implementors should not forward every incoming request directly to the providers, since that does not scale, might
 * cause bottlenecks and can clog the system. Instead, all providers should be queried ("crawled") in a periodic manner and the results
 * should be cached internally.
 */
@ExtensionPoint
public interface HealthCheckService {

    void addLivenessProvider(LivenessProvider provider);

    void addReadinessProvider(ReadinessProvider provider);

    void addStartupStatusProvider(StartupStatusProvider provider);

    HealthStatus isLive();

    HealthStatus isReady();

    HealthStatus getStartupStatus();
}