001/*
002 * Copyright 2002-2018 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.http;
018
019import java.io.IOException;
020import java.io.InputStream;
021
022/**
023 * Represents an HTTP input message, consisting of {@linkplain #getHeaders() headers}
024 * and a readable {@linkplain #getBody() body}.
025 *
026 * <p>Typically implemented by an HTTP request handle on the server side,
027 * or an HTTP response handle on the client side.
028 *
029 * @author Arjen Poutsma
030 * @since 3.0
031 */
032public interface HttpInputMessage extends HttpMessage {
033
034        /**
035         * Return the body of the message as an input stream.
036         * @return the input stream body (never {@code null})
037         * @throws IOException in case of I/O errors
038         */
039        InputStream getBody() throws IOException;
040
041}