001/*
002 * Copyright 2012-2018 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.endpoint;
018
019import java.util.Collection;
020
021/**
022 * Information describing an endpoint that can be exposed in some technology specific way.
023 *
024 * @param <O> the type of the endpoint's operations
025 * @author Andy Wilkinson
026 * @author Phillip Webb
027 * @since 2.0.0
028 */
029public interface ExposableEndpoint<O extends Operation> {
030
031        /**
032         * Return the endpoint ID.
033         * @return the endpoint ID
034         */
035        EndpointId getEndpointId();
036
037        /**
038         * Returns if the endpoint is enabled by default.
039         * @return if the endpoint is enabled by default
040         */
041        boolean isEnableByDefault();
042
043        /**
044         * Returns the operations of the endpoint.
045         * @return the operations
046         */
047        Collection<O> getOperations();
048
049}