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;
018
019/**
020 * Enumeration of filter dispatcher types, identical to
021 * {@link javax.servlet.DispatcherType} and used in configuration as the servlet API may
022 * not be present.
023 *
024 * @author Stephane Nicoll
025 * @since 2.0.0
026 */
027public enum DispatcherType {
028
029        /**
030         * Apply the filter on "RequestDispatcher.forward()" calls.
031         */
032        FORWARD,
033
034        /**
035         * Apply the filter on "RequestDispatcher.include()" calls.
036         */
037        INCLUDE,
038
039        /**
040         * Apply the filter on ordinary client calls.
041         */
042        REQUEST,
043
044        /**
045         * Apply the filter under calls dispatched from an AsyncContext.
046         */
047        ASYNC,
048
049        /**
050         * Apply the filter when an error is handled.
051         */
052        ERROR
053
054}