001/*
002 * Copyright 2002-2015 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 *      https://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.web.server;
018
019import reactor.core.publisher.Mono;
020
021/**
022 * Contract for interception-style, chained processing of Web requests that may
023 * be used to implement cross-cutting, application-agnostic requirements such
024 * as security, timeouts, and others.
025 *
026 * @author Rossen Stoyanchev
027 * @since 5.0
028 */
029public interface WebFilter {
030
031        /**
032         * Process the Web request and (optionally) delegate to the next
033         * {@code WebFilter} through the given {@link WebFilterChain}.
034         * @param exchange the current server exchange
035         * @param chain provides a way to delegate to the next filter
036         * @return {@code Mono<Void>} to indicate when request processing is complete
037         */
038        Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain);
039
040}