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.devtools.remote.server;
018
019import org.springframework.http.server.ServerHttpRequest;
020
021/**
022 * Provides access control for a {@link Dispatcher}.
023 *
024 * @author Phillip Webb
025 * @since 1.3.0
026 */
027@FunctionalInterface
028public interface AccessManager {
029
030        /**
031         * {@link AccessManager} that permits all requests.
032         */
033        AccessManager PERMIT_ALL = (request) -> true;
034
035        /**
036         * Determine if the specific request is allowed to be handled by the
037         * {@link Dispatcher}.
038         * @param request the request to check
039         * @return {@code true} if access is allowed.
040         */
041        boolean isAllowed(ServerHttpRequest request);
042
043}