HttpServletResponse Class

Adds the specified cookie to the response.

Sets the "Content-Length" in the response header. Note that the "Content-Length" header is set automatically by most of the write() methods. So unless you're writing directly to the ServletOutputStream, you do not need to set this header.

Sets the "Content-Length" in the response header. Note that the "Content-Length" header is set automatically by most of the write() methods. So unless you're writing directly to the ServletOutputStream, you do not need to set this header.

Returns the "Content-Length" defined in the response header. Returns null if the "Content-Length" is not defined or is less than zero.

Used to set/update the "Content-Type" response header (e.g. "text/html; charset=utf-8").

Returns the "Content-Type" defined in the response header (e.g. "text/html; charset=utf-8").

Sets the name of the character encoding used in the response. Default is "UTF-8".

Returns the name of the character encoding used in the response.

Sets the locale of the response. The locale is communicated via the "Content-Language" header and the character encoding in the "Content-Type" header.

Returns the locale specified for this response using the setLocale() method.

Adds a response header with the given name and value. According to spec, http response headers should be allowed to have multiple values. However, this implementation does not currently allow response headers to have multiple values.

Sets a response header with the given name and value.

Returns a boolean indicating whether the named response header has already been set.

Sets a response header with the given name and date-value.

Adds a response header with the given name and date-value. According to spec, http response headers should be allowed to have multiple values. However, this implementation does not currently allow response headers to have multiple values.

Sets a response header with the given name and integer value.

Adds a response header with the given name and integer value. According to spec, http response headers should be allowed to have multiple values. However, this implementation does not currently allow response headers to have multiple values.

Sets the preferred buffer size for the body of the response. A larger buffer allows more content to be sent to the client at a time. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.

This method must be called before any response body content is written.

Returns the buffer size used for the response.

Sends an error response to the client using the specified status. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Sends an error response to the client using the specified status code and clearing the buffer.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Sends a temporary redirect response to the client using the specified redirect location URL.

Sends a temporary or permanent redirect response to the client using the specified redirect location URL.

Used to write a block of text in the response body. You should only call this method once.

Used to write a block of text in the response body. Will automatically try to gzip compress the text if "Accept-Encoding" supports gzip compression. You should only call this method once.

Used to write bytes to the response body. You should only call this method once.

Used to write bytes to the response body. Will automatically try to compress the byte array if "Accept-Encoding" supports gzip compression. You should only call this method once.

Used to write contents of a file into the response body. Automatically compresses the file content if the client supports gzip compression. You should only call this method once.

Used to write contents of a file into the response body. Automatically compresses the file content if the client supports gzip compression. You should only call this method once.

Used to transfer bytes from an input stream to the response body.

Returns an output stream for writing the body of an http response. Automatically encrypts the data if the connection is SSL/TLS encrypted. Note that by default, if the request header includes a keep-alive directive, the response header will include a keep-alive response. As such, you must explicitely set the content length, set the "Connection" header to "Close", or chunk the output using chunked encoding. Example:

      //IMPORTANT: Set response headers before getting the output stream!
        response.setContentLength(54674);

      //Get output stream
        java.io.OutputStream outputStream = response.getOutputStream();

      //Transfer bytes from an input stream to the output stream
        byte[] b = new byte[1024];
        int x=0;
        while ( (x = inputStream.read(b)) != -1) {
            outputStream.write(b,0,x);
        }

      //Close the input and output streams
        outputStream.close();
        inputStream.close();    

Returns a PrintWriter object that can send character text to the client.

Returns the raw HTTP response header.

Returns the raw HTTP response header.

Clears the status code and headers. This method is called automatically after each new http request to free up server resources. You do not need to call this method explicitly from your application.

Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written. This method is called automatically after each http request to free up server resources. You do not need to call this method explicitly from your application.

According to spec, this method is supposed to clear the content buffer. However, this implementation doesn't use a content buffer. All content is written immediately.

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

According to spec, this method is supposed to encode the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. This is important for browsers that don't support cookies. In our case, sessions are maintained using cookies so we return the URL unchanged.

According to spec, this method is supposed to encode the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes logic to determine whether the session ID needs to be encoded in the URL. This is important for browsers that don't support cookies. In our case, sessions are maintained using cookies so we return the URL unchanged.