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.Operation;
020
021/**
022 * An operation on a web endpoint.
023 *
024 * @author Andy Wilkinson
025 * @author Phillip Webb
026 * @since 2.0.0
027 */
028public interface WebOperation extends Operation {
029
030        /**
031         * Returns the ID of the operation that uniquely identifies it within its endpoint.
032         * @return the ID
033         */
034        String getId();
035
036        /**
037         * Returns if the underlying operation is blocking.
038         * @return {@code true} if the operation is blocking
039         */
040        boolean isBlocking();
041
042        /**
043         * Returns the predicate for requests that can be handled by this operation.
044         * @return the predicate
045         */
046        WebOperationRequestPredicate getRequestPredicate();
047
048}