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.web.servlet.error;
018
019import org.springframework.stereotype.Controller;
020
021/**
022 * Marker interface used to indicate that a {@link Controller @Controller} is used to
023 * render errors. Primarily used to know the error paths that will not need to be secured.
024 *
025 * @author Phillip Webb
026 * @since 2.0.0
027 */
028@FunctionalInterface
029public interface ErrorController {
030
031        /**
032         * Returns the path of the error page.
033         * @return the error path
034         */
035        String getErrorPath();
036
037}