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.web;
018
019import org.springframework.boot.actuate.endpoint.ExposableEndpoint;
020
021/**
022 * Interface that can be implemented by an {@link ExposableEndpoint} that is mapped to a
023 * root web path.
024 *
025 * @author Phillip Webb
026 * @since 2.0.0
027 * @see PathMapper
028 */
029@FunctionalInterface
030public interface PathMappedEndpoint {
031
032        /**
033         * Return the root path of the endpoint, relative to the context that exposes it. For
034         * example, a root path of {@code example} would be exposed under the URL
035         * "/{actuator-context}/example".
036         * @return the root path for the endpoint
037         */
038        String getRootPath();
039
040}