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.autoconfigure.health;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.context.annotation.Conditional;
026
027/**
028 * {@link Conditional} that checks whether or not a default health indicator is enabled.
029 * Matches if the value of the {@code management.health.<name>.enabled} property is
030 * {@code true}. Otherwise, matches if the value of the
031 * {@code management.health.defaults.enabled} property is {@code true} or if it is not
032 * configured.
033 *
034 * @author Stephane Nicoll
035 * @since 2.0.0
036 */
037@Retention(RetentionPolicy.RUNTIME)
038@Target({ ElementType.TYPE, ElementType.METHOD })
039@Documented
040@Conditional(OnEnabledHealthIndicatorCondition.class)
041public @interface ConditionalOnEnabledHealthIndicator {
042
043        /**
044         * The name of the health indicator.
045         * @return the name of the health indicator
046         */
047        String value();
048
049}