001/*
002 * Copyright 2002-2013 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.server;
018
019import java.io.Closeable;
020import java.io.Flushable;
021import java.io.IOException;
022
023import org.springframework.http.HttpOutputMessage;
024import org.springframework.http.HttpStatus;
025
026/**
027 * Represents a server-side HTTP response.
028 *
029 * @author Arjen Poutsma
030 * @since 3.0
031 */
032public interface ServerHttpResponse extends HttpOutputMessage, Flushable, Closeable {
033
034        /**
035         * Set the HTTP status code of the response.
036         * @param status the HTTP status as an HttpStatus enum value
037         */
038        void setStatusCode(HttpStatus status);
039
040        /**
041         * Ensure that the headers and the content of the response are written out.
042         * <p>After the first flush, headers can no longer be changed.
043         * Only further content writing and content flushing is possible.
044         */
045        @Override
046        void flush() throws IOException;
047
048        /**
049         * Close this response, freeing any resources created.
050         */
051        @Override
052        void close();
053
054}