Class Response

src/main/java/net/freeutils/httpserver/HTTPServer.java:1572–1862

The Response class encapsulates a single HTTP response.

     * The {@code Response} class encapsulates a single HTTP response.
     */
    public class Response implements Closeable {

        protected OutputStream out; // the underlying output stream
        protected OutputStream[] encoders = new OutputStream[4]; // chained encoder streams
        protected Headers headers;
        protected boolean discardBody;
        protected int state; // nothing sent, headers sent, or closed
        protected Request req; // request used in determining client capabilities

        /**
         * Constructs a Response whose output is written to the given stream.
         *
         * @param out the stream to which the response is written
         */
        public Response(OutputStream out) {
            this.out = out;
            this.headers = new Headers();
        }

        /**
         * Sets whether this response's body is discarded or sent.
         *
         * @param discardBody specifies whether the body is discarded or not
         */
        public void setDiscardBody(boolean discardBody) {
            this.discardBody = discardBody;
        }

        /**
         * Sets the request which is used in determining the capabilities
         * supported by the client (e.g. compression, encoding, etc.)
         *
         * @param req the request
         */
        public void setClientCapabilities(Request req) { this.req = req; }

        /**
         * Returns the request headers collection.
         *
         * @return the request headers collection
         */
        public Headers getHeaders() { return headers; }

        /**
         * Returns the underlying output stream to which the response is written.
         * Except for special cases, you should use {@link #getBody()} instead.
         *
         * @return the underlying output stream to which the response is written
         */
        public OutputStream getOutputStream() { return out; }

        /**
         * Returns whether the response headers were already sent.
         *
         * @return whether the response headers were already sent
         */
        public boolean headersSent() { return state == 1; }