001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.actuate.health;
018
019import reactor.core.publisher.Mono;
020
021/**
022 * Defines the {@link Health} of an arbitrary system or component.
023 * <p>
024 * This is non blocking contract that is meant to be used in a reactive application. See
025 * {@link HealthIndicator} for the traditional contract.
026 *
027 * @author Stephane Nicoll
028 * @since 2.0.0
029 * @see HealthIndicator
030 */
031@FunctionalInterface
032public interface ReactiveHealthIndicator {
033
034        /**
035         * Provide the indicator of health.
036         * @return a {@link Mono} that provides the {@link Health}
037         */
038        Mono<Health> health();
039
040}