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.servlet.mvc.method.annotation;
018
019import org.springframework.http.server.ServerHttpResponse;
020
021/**
022 * Contract to adapt streaming async types to {@code ResponseBodyEmitter}.
023 *
024 * @author Rossen Stoyanchev
025 * @since 4.3
026 *
027 * @deprecated in 4.3.8 since 5.0 adds first-class support for reactive type
028 * return values from Spring MVC controller methods based on the pluggable
029 * {@code ReactiveAdapterRegistry} mechanism.
030 */
031@Deprecated
032public interface ResponseBodyEmitterAdapter {
033
034        /**
035         * Obtain a {@code ResponseBodyEmitter} for the given return value.
036         * If the return is the body {@code ResponseEntity} then the given
037         * {@code ServerHttpResponse} contains its status and headers.
038         * @param returnValue the return value (never {@code null})
039         * @param response the response
040         * @return the return value adapted to a {@code ResponseBodyEmitter}
041         */
042        ResponseBodyEmitter adaptToEmitter(Object returnValue, ServerHttpResponse response);
043
044}