io.helidon.microprofile.health.HealthCheckProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-microprofile-health Show documentation

Microprofile health check implementation

The newest version!

/*
 * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
 *
 * 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 io.helidon.microprofile.health;

import java.util.Collections;
import java.util.List;

import org.eclipse.microprofile.health.HealthCheck;

/**
 * A provider of {@link HealthCheck} instances.
 * 
 * Instances of {@link HealthCheckProvider} are discovered by the {@link io.helidon.microprofile.health.HealthCdiExtension}
 * using the {@link io.helidon.common.HelidonServiceLoader} and all of the
 * {@link HealthCheck} instances are added to the health endpoint.
 */
public interface HealthCheckProvider {
    /**
     * Return the provided readiness {@link org.eclipse.microprofile.health.HealthCheck}s.
     *
     * @return the {@link org.eclipse.microprofile.health.HealthCheck}s
     */
    default List readinessChecks() {
        return Collections.emptyList();
    }

    /**
     * Return the provided liveness {@link org.eclipse.microprofile.health.HealthCheck}s.
     *
     * @return the {@link org.eclipse.microprofile.health.HealthCheck}s
     */
    default List livenessChecks() {
        return Collections.emptyList();
    }

    /**
     * Return the provided start-up {@link org.eclipse.microprofile.health.HealthCheck}s.
     *
     * @return the {@link org.eclipse.microprofile.health.HealthCheck}s
     */
    default List startupChecks() {
        return Collections.emptyList();
    }
}