/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.http;

import java.io.IOException;
import java.io.OutputStream;

Represents a HTTP output message that allows for setting a streaming body. Note that such messages typically do not support HttpOutputMessage.getBody() access.
Author:Arjen Poutsma
See Also:
Since:4.0
/** * Represents a HTTP output message that allows for setting a streaming body. * Note that such messages typically do not support {@link #getBody()} access. * * @author Arjen Poutsma * @since 4.0 * @see #setBody */
public interface StreamingHttpOutputMessage extends HttpOutputMessage {
Set the streaming body callback for this message.
Params:
  • body – the streaming body callback
/** * Set the streaming body callback for this message. * @param body the streaming body callback */
void setBody(Body body);
Defines the contract for bodies that can be written directly to an OutputStream. Useful with HTTP client libraries that provide indirect access to an OutputStream via a callback mechanism.
/** * Defines the contract for bodies that can be written directly to an * {@link OutputStream}. Useful with HTTP client libraries that provide * indirect access to an {@link OutputStream} via a callback mechanism. */
@FunctionalInterface interface Body {
Write this body to the given OutputStream.
Params:
  • outputStream – the output stream to write to
Throws:
/** * Write this body to the given {@link OutputStream}. * @param outputStream the output stream to write to * @throws IOException in case of I/O errors */
void writeTo(OutputStream outputStream) throws IOException; } }