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.web;
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.Configuration;
026import org.springframework.core.Ordered;
027import org.springframework.core.annotation.Order;
028
029/**
030 * Specialized {@link Configuration @Configuration} class that defines configuration
031 * specific for the management context. Configurations should be registered in
032 * {@code /META-INF/spring.factories} under the
033 * {@code org.springframework.boot.actuate.autoconfigure.web.ManagementContextConfiguration}
034 * key.
035 * <p>
036 * {@code ManagementContextConfiguration} classes can be ordered using {@link Order}.
037 * Ordering by implementing {@link Ordered} is not supported and will have no effect.
038 *
039 * @author Phillip Webb
040 * @author Andy Wilkinson
041 * @since 2.0.0
042 */
043@Target(ElementType.TYPE)
044@Retention(RetentionPolicy.RUNTIME)
045@Documented
046@Configuration
047public @interface ManagementContextConfiguration {
048
049        /**
050         * Specifies the type of management context that is required for this configuration to
051         * be applied.
052         * @return the required management context type
053         * @since 2.0.0
054         */
055        ManagementContextType value() default ManagementContextType.ANY;
056
057}