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.reactive;
018
019import reactor.core.publisher.Mono;
020
021import org.springframework.web.server.ServerWebExchange;
022
023/**
024 * Process the {@link HandlerResult}, usually returned by an {@link HandlerAdapter}.
025 *
026 * @author Rossen Stoyanchev
027 * @author Sebastien Deleuze
028 * @since 5.0
029 */
030public interface HandlerResultHandler {
031
032        /**
033         * Whether this handler supports the given {@link HandlerResult}.
034         * @param result the result object to check
035         * @return whether or not this object can use the given result
036         */
037        boolean supports(HandlerResult result);
038
039        /**
040         * Process the given result modifying response headers and/or writing data
041         * to the response.
042         * @param exchange current server exchange
043         * @param result the result from the handling
044         * @return {@code Mono<Void>} to indicate when request handling is complete.
045         */
046        Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result);
047
048}