/*
 * Copyright 2012-2017 the original author or authors.
 *
 * 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 org.springframework.boot.actuate.endpoint.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.boot.actuate.endpoint.DefaultEnablement;
import org.springframework.boot.actuate.endpoint.EndpointExposure;

/**
 * Identifies a type as being an endpoint.
 *
 * @author Andy Wilkinson
 * @since 2.0.0
 * @see AnnotationEndpointDiscoverer
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Endpoint {

	/**
	 * The id of the endpoint.
	 * @return the id
	 */
	String id();

	/**
	 * Defines the {@link EndpointExposure technologies} over which the endpoint should be
	 * exposed. By default, all technologies are supported.
	 * @return the supported endpoint exposure technologies
	 */
	EndpointExposure[] exposure() default {};

	/**
	 * Defines the {@link DefaultEnablement} of the endpoint. By default, the endpoint's
	 * enablement defaults to the "default" settings.
	 * @return the default enablement
	 */
	DefaultEnablement defaultEnablement() default DefaultEnablement.NEUTRAL;

}
