001/*
002 * Copyright 2002-2016 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
021import org.springframework.web.server.adapter.HttpWebHandlerAdapter;
022import org.springframework.web.server.adapter.WebHttpHandlerBuilder;
023
024/**
025 * Contract to handle a web request.
026 *
027 * <p>Use {@link HttpWebHandlerAdapter} to adapt a {@code WebHandler} to an
028 * {@link org.springframework.http.server.reactive.HttpHandler HttpHandler}.
029 * The {@link WebHttpHandlerBuilder} provides a convenient way to do that while
030 * also optionally configuring one or more filters and/or exception handlers.
031 *
032 * @author Rossen Stoyanchev
033 * @since 5.0
034 */
035public interface WebHandler {
036
037        /**
038         * Handle the web server exchange.
039         * @param exchange the current server exchange
040         * @return {@code Mono<Void>} to indicate when request handling is complete
041         */
042        Mono<Void> handle(ServerWebExchange exchange);
043
044}