Response (Apache Tomcat 7.0.96 API Documentation)

org.apache.catalina.connector

## Class Response

- java.lang.Object
- - org.apache.catalina.connector.Response

- All Implemented Interfaces:
    HttpServletResponse, ServletResponse

      public class Response
      extends java.lang.Object
      implements HttpServletResponse

  Wrapper object for the Coyote response.
  Author:
    Remy Maucherat, Craig R. McClanahan

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected boolean` | `appCommitted` The application commit flag.
    `protected Connector` | `connector` Deprecated. Unused
    `protected Response` | `coyoteResponse` Coyote response.
    `protected ResponseFacade` | `facade` The facade associated with this response.
    `protected java.text.SimpleDateFormat` | `format` The date format we will use for creating date headers.
    `protected boolean` | `included` The included flag.
    `protected static java.lang.String` | `info` Descriptive information about this Response implementation.
    `protected OutputBuffer` | `outputBuffer` The associated output buffer.
    `protected CoyoteOutputStream` | `outputStream` The associated output stream.
    `protected CharChunk` | `redirectURLCC` Recyclable buffer to hold the redirect URL.
    `protected Request` | `request` The request with which this response is associated.
    `protected static StringManager` | `sm`
    `protected UEncoder` | `urlEncoder` URL encoder.
    `protected boolean` | `usingOutputStream` Using output stream flag.
    `protected boolean` | `usingWriter` Using writer flag.
    `protected CoyoteWriter` | `writer` The associated writer.

    - ### Fields inherited from interface javax.servlet.http.HttpServletResponse

      `SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Response()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addCookie(Cookie cookie)` Add the specified Cookie to those that will be included with this Response.
    `void` | `addDateHeader(java.lang.String name, long value)` Add the specified date header to the specified value.
    `void` | `addHeader(java.lang.String name, java.lang.String value)` Add the specified header to the specified value.
    `void` | `addIntHeader(java.lang.String name, int value)` Add the specified integer header to the specified value.
    `void` | `addSessionCookieInternal(Cookie cookie)` Special method for adding a session cookie as we should be overriding any previous
    `void` | `clearEncoders()` Clear cached encoders (to save memory for Comet requests).
    `boolean` | `containsHeader(java.lang.String name)` Has the specified header been set already in this response?
    `ServletOutputStream` | `createOutputStream()` Deprecated.
    `java.lang.String` | `encodeRedirectUrl(java.lang.String url)` Deprecated. As of Version 2.1 of the Java Servlet API, use `encodeRedirectURL()` instead.
    `java.lang.String` | `encodeRedirectURL(java.lang.String url)` Encode the session identifier associated with this response into the specified redirect URL, if necessary.
    `java.lang.String` | `encodeUrl(java.lang.String url)` Deprecated. As of Version 2.1 of the Java Servlet API, use `encodeURL()` instead.
    `java.lang.String` | `encodeURL(java.lang.String url)` Encode the session identifier associated with this response into the specified URL, if necessary.
    `void` | `finishResponse()` Perform whatever actions are required to flush and close the output stream or writer, in a single operation.
    `void` | `flushBuffer()` Flush the buffer and commit this response.
    `java.lang.StringBuffer` | `generateCookieString(Cookie cookie)`
    `int` | `getBufferSize()` Return the actual buffer size used for this Response.
    `long` | `getBytesWritten(boolean flush)` Return the number of bytes the actually written to the socket.
    `java.lang.String` | `getCharacterEncoding()` Return the character encoding used for this Response.
    `Connector` | `getConnector()` Deprecated.
    `int` | `getContentLength()` Return the content length that was set or calculated for this Response.
    `java.lang.String` | `getContentType()` Return the content type that was set or calculated for this response, or `null` if no content type was set.
    `long` | `getContentWritten()` Return the number of bytes the application has actually written to the output stream.
    `Context` | `getContext()` Return the Context within which this Request is being processed.
    `Response` | `getCoyoteResponse()` Get the Coyote response.
    `java.lang.String` | `getHeader(java.lang.String name)` Return the value for the specified header, or `null` if this header has not been set.
    `java.util.Collection<java.lang.String>` | `getHeaderNames()` Return an Iterable of all the header names set for this response.
    `java.util.Collection<java.lang.String>` | `getHeaders(java.lang.String name)` Return a Collection of all the header values associated with the specified header name.
    `boolean` | `getIncluded()` Deprecated.
    `java.lang.String` | `getInfo()` Return descriptive information about this Response implementation and the corresponding version number, in the format `<description>/<version>`.
    `java.util.Locale` | `getLocale()` Return the Locale assigned to this response.
    `java.lang.String` | `getMessage()` Return the error message that was set with `sendError()` for this Response.
    `ServletOutputStream` | `getOutputStream()` Return the servlet output stream associated with this Response.
    `java.io.PrintWriter` | `getReporter()` Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.
    `Request` | `getRequest()` Return the Request with which this Response is associated.
    `HttpServletResponse` | `getResponse()` Return the `ServletResponse` for which this object is the facade.
    `int` | `getStatus()` Return the HTTP status code associated with this Response.
    `java.io.OutputStream` | `getStream()` Deprecated.
    `java.io.PrintWriter` | `getWriter()` Return the writer associated with this Response.
    `boolean` | `isAppCommitted()` Application commit flag accessor.
    `boolean` | `isClosed()` Closed flag accessor.
    `boolean` | `isCommitted()` Has the output of this response already been committed?
    `protected boolean` | `isEncodeable(java.lang.String location)` Return `true` if the specified URL should be encoded with a session identifier.
    `boolean` | `isError()` Error flag accessor.
    `boolean` | `isErrorReportRequired()`
    `boolean` | `isSuspended()` Suspended flag accessor.
    `void` | `recycle()` Release all object references, and initialize instance variables, in preparation for reuse of this object.
    `void` | `reset()` Clear any content written to the buffer.
    `void` | `reset(int status, java.lang.String message)` Deprecated.
    `void` | `resetBuffer()` Reset the data buffer but not any status or header information.
    `void` | `resetBuffer(boolean resetWriterStreamFlags)` Reset the data buffer and the using Writer/Stream flags but not any status or header information.
    `void` | `sendAcknowledgement()` Send an acknowledgment of a request.
    `void` | `sendError(int status)` Send an error response with the specified status and a default message.
    `void` | `sendError(int status, java.lang.String message)` Send an error response with the specified status and message.
    `void` | `sendRedirect(java.lang.String location)` Send a temporary redirect to the specified redirect location URL.
    `void` | `sendRedirect(java.lang.String location, int status)` Internal method that allows a redirect to be sent with a status other than `HttpServletResponse.SC_FOUND` (302).
    `void` | `setAppCommitted(boolean appCommitted)` Set the application commit flag.
    `void` | `setBufferSize(int size)` Set the buffer size to be used for this Response.
    `void` | `setCharacterEncoding(java.lang.String charset)` Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
    `void` | `setConnector(Connector connector)` Set the Connector through which this Request was received.
    `void` | `setContentLength(int length)` Set the content length (in bytes) for this Response.
    `void` | `setContentType(java.lang.String type)` Set the content type for this Response.
    `void` | `setContext(Context context)` Deprecated.
    `void` | `setCoyoteResponse(Response coyoteResponse)` Set the Coyote response.
    `void` | `setDateHeader(java.lang.String name, long value)` Set the specified date header to the specified value.
    `boolean` | `setError()` Set the error flag.
    `boolean` | `setErrorReported()`
    `void` | `setHeader(java.lang.String name, java.lang.String value)` Set the specified header to the specified value.
    `void` | `setIncluded(boolean included)` Deprecated.
    `void` | `setIntHeader(java.lang.String name, int value)` Set the specified integer header to the specified value.
    `void` | `setLocale(java.util.Locale locale)` Set the Locale that is appropriate for this response, including setting the appropriate character encoding.
    `void` | `setRequest(Request request)` Set the Request with which this Response is associated.
    `void` | `setStatus(int status)` Set the HTTP status to be returned with this response.
    `void` | `setStatus(int status, java.lang.String message)` Deprecated. As of Version 2.1 of the Java Servlet API, this method has been deprecated due to the ambiguous meaning of the message parameter.
    `void` | `setSuspended(boolean suspended)` Set the suspended flag.
    `protected java.lang.String` | `toAbsolute(java.lang.String location)` Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL.
    `protected java.lang.String` | `toEncoded(java.lang.String url, java.lang.String sessionId)` Return the specified URL with the specified session identifier suitably encoded.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### sm

          protected static final StringManager sm

    - #### info

          protected static final java.lang.String info

      Descriptive information about this Response implementation.
      See Also:
        Constant Field Values

    - #### format

          protected java.text.SimpleDateFormat format

      The date format we will use for creating date headers.

    - #### connector

          @Deprecated
          protected Connector connector

      Deprecated. Unused
      Associated Catalina connector.

    - #### coyoteResponse

          protected Response coyoteResponse

      Coyote response.

    - #### outputBuffer

          protected OutputBuffer outputBuffer

      The associated output buffer.

    - #### outputStream

          protected CoyoteOutputStream outputStream

      The associated output stream.

    - #### writer

          protected CoyoteWriter writer

      The associated writer.

    - #### appCommitted

          protected boolean appCommitted

      The application commit flag.

    - #### included

          protected boolean included

      The included flag.

    - #### usingOutputStream

          protected boolean usingOutputStream

      Using output stream flag.

    - #### usingWriter

          protected boolean usingWriter

      Using writer flag.

    - #### urlEncoder

          protected final UEncoder urlEncoder

      URL encoder.

    - #### redirectURLCC

          protected CharChunk redirectURLCC

      Recyclable buffer to hold the redirect URL.

    - #### request

          protected Request request

      The request with which this response is associated.

    - #### facade

          protected ResponseFacade facade

      The facade associated with this response.

  - ### Constructor Detail

    - #### Response

          public Response()

  - ### Method Detail

    - #### getConnector

          @Deprecated
          public Connector getConnector()

      Deprecated.
      Return the Connector through which this Request was received.

    - #### setConnector

          public void setConnector(Connector connector)

      Set the Connector through which this Request was received.
      Parameters:
        `connector` - The new connector

    - #### setCoyoteResponse

          public void setCoyoteResponse(Response coyoteResponse)

      Set the Coyote response.
      Parameters:
        `coyoteResponse` - The Coyote response

    - #### getCoyoteResponse

          public Response getCoyoteResponse()

      Get the Coyote response.

    - #### getContext

          public Context getContext()

      Return the Context within which this Request is being processed.

    - #### setContext

          @Deprecated
          public void setContext(Context context)

      Deprecated.
      Set the Context within which this Request is being processed. This must be called as soon as the appropriate Context is identified, because it identifies the value to be returned by `getContextPath()`, and thus enables parsing of the request URI.
      Parameters:
        `context` - The newly associated Context

    - #### recycle

          public void recycle()

      Release all object references, and initialize instance variables, in preparation for reuse of this object.

    - #### clearEncoders

          public void clearEncoders()

      Clear cached encoders (to save memory for Comet requests).

    - #### getContentWritten

          public long getContentWritten()

      Return the number of bytes the application has actually written to the output stream. This excludes chunking, compression, etc. as well as headers.

    - #### getBytesWritten

          public long getBytesWritten(boolean flush)

      Return the number of bytes the actually written to the socket. This includes chunking, compression, etc. but excludes headers.

    - #### setAppCommitted

          public void setAppCommitted(boolean appCommitted)

      Set the application commit flag.
      Parameters:
        `appCommitted` - The new application committed flag value

    - #### isAppCommitted

          public boolean isAppCommitted()

      Application commit flag accessor.

    - #### getIncluded

          @Deprecated
          public boolean getIncluded()

      Deprecated.
      Return the "processing inside an include" flag.

    - #### setIncluded

          @Deprecated
          public void setIncluded(boolean included)

      Deprecated.
      Set the "processing inside an include" flag.
      Parameters:
        `included` - `true` if we are currently inside a RequestDispatcher.include(), else `false`

    - #### getInfo

          public java.lang.String getInfo()

      Return descriptive information about this Response implementation and the corresponding version number, in the format `<description>/<version>`.

    - #### getRequest

          public Request getRequest()

      Return the Request with which this Response is associated.

    - #### setRequest

          public void setRequest(Request request)

      Set the Request with which this Response is associated.
      Parameters:
        `request` - The new associated request

    - #### getResponse

          public HttpServletResponse getResponse()

      Return the `ServletResponse` for which this object is the facade.

    - #### getStream

          @Deprecated
          public java.io.OutputStream getStream()

      Deprecated.
      Return the output stream associated with this Response.

    - #### setSuspended

          public void setSuspended(boolean suspended)

      Set the suspended flag.
      Parameters:
        `suspended` - The new suspended flag value

    - #### isSuspended

          public boolean isSuspended()

      Suspended flag accessor.

    - #### isClosed

          public boolean isClosed()

      Closed flag accessor.

    - #### setError

          public boolean setError()

      Set the error flag.

    - #### isError

          public boolean isError()

      Error flag accessor.

    - #### isErrorReportRequired

          public boolean isErrorReportRequired()

    - #### setErrorReported

          public boolean setErrorReported()

    - #### createOutputStream

          @Deprecated
          public ServletOutputStream createOutputStream()
                                                 throws java.io.IOException

      Deprecated.
      Create and return a ServletOutputStream to write the content associated with this Response.
      Throws:
        `java.io.IOException` - if an input/output error occurs

    - #### finishResponse

          public void finishResponse()
                              throws java.io.IOException

      Perform whatever actions are required to flush and close the output stream or writer, in a single operation.
      Throws:
        `java.io.IOException` - if an input/output error occurs

    - #### getContentLength

          public int getContentLength()

      Return the content length that was set or calculated for this Response.

    - #### getContentType

          public java.lang.String getContentType()

      Return the content type that was set or calculated for this response, or `null` if no content type was set.
      Specified by:
        `getContentType` in interface `ServletResponse`
      Returns:
        a `String` specifying the content type, for example, `text/html; charset=UTF-8`, or null

    - #### getReporter

          public java.io.PrintWriter getReporter()
                                          throws java.io.IOException

      Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.
      Returns:
        Writer which can be used for error reports. If the response is not an error report returned using sendError or triggered by an unexpected exception thrown during the servlet processing (and only in that case), null will be returned if the response stream has already been used.
      Throws:
        `java.io.IOException` - if an input/output error occurs

    - #### flushBuffer

          public void flushBuffer()
                           throws java.io.IOException

      Flush the buffer and commit this response.
      Specified by:
        `flushBuffer` in interface `ServletResponse`
      Throws:
        `java.io.IOException` - if an input/output error occurs
      See Also:
        `ServletResponse.setBufferSize(int)`, `ServletResponse.getBufferSize()`, `ServletResponse.isCommitted()`, `ServletResponse.reset()`

    - #### getBufferSize

          public int getBufferSize()

      Return the actual buffer size used for this Response.
      Specified by:
        `getBufferSize` in interface `ServletResponse`
      Returns:
        the actual buffer size used
      See Also:
        `ServletResponse.setBufferSize(int)`, `ServletResponse.flushBuffer()`, `ServletResponse.isCommitted()`, `ServletResponse.reset()`

    - #### getCharacterEncoding

          public java.lang.String getCharacterEncoding()

      Return the character encoding used for this Response.
      Specified by:
        `getCharacterEncoding` in interface `ServletResponse`
      Returns:
        a `String` specifying the name of the character encoding, for example, `UTF-8`

    - #### getOutputStream

          public ServletOutputStream getOutputStream()
                                              throws java.io.IOException

      Return the servlet output stream associated with this Response.
      Specified by:
        `getOutputStream` in interface `ServletResponse`
      Returns:
        a `ServletOutputStream` for writing binary data
      Throws:
        `java.lang.IllegalStateException` - if `getWriter` has already been called for this response
        `java.io.IOException` - if an input/output error occurs
      See Also:
        `ServletResponse.getWriter()`

    - #### getLocale

          public java.util.Locale getLocale()

      Return the Locale assigned to this response.
      Specified by:
        `getLocale` in interface `ServletResponse`
      See Also:
        `ServletResponse.setLocale(java.util.Locale)`

    - #### getWriter

          public java.io.PrintWriter getWriter()
                                        throws java.io.IOException

      Return the writer associated with this Response.
      Specified by:
        `getWriter` in interface `ServletResponse`
      Returns:
        a `PrintWriter` object that can return character data to the client
      Throws:
        `java.lang.IllegalStateException` - if `getOutputStream` has already been called for this response
        `java.io.IOException` - if an input/output error occurs
      See Also:
        `ServletResponse.getOutputStream()`, `ServletResponse.setCharacterEncoding(java.lang.String)`

    - #### isCommitted

          public boolean isCommitted()

      Has the output of this response already been committed?
      Specified by:
        `isCommitted` in interface `ServletResponse`
      Returns:
        a boolean indicating if the response has been committed
      See Also:
        `ServletResponse.setBufferSize(int)`, `ServletResponse.getBufferSize()`, `ServletResponse.flushBuffer()`, `ServletResponse.reset()`

    - #### reset

          public void reset()

      Clear any content written to the buffer.
      Specified by:
        `reset` in interface `ServletResponse`
      Throws:
        `java.lang.IllegalStateException` - if this response has already been committed
      See Also:
        `ServletResponse.setBufferSize(int)`, `ServletResponse.getBufferSize()`, `ServletResponse.flushBuffer()`, `ServletResponse.isCommitted()`

    - #### resetBuffer

          public void resetBuffer()

      Reset the data buffer but not any status or header information.
      Specified by:
        `resetBuffer` in interface `ServletResponse`
      Throws:
        `java.lang.IllegalStateException` - if the response has already been committed
      See Also:
        `ServletResponse.setBufferSize(int)`, `ServletResponse.getBufferSize()`, `ServletResponse.isCommitted()`, `ServletResponse.reset()`

    - #### resetBuffer

          public void resetBuffer(boolean resetWriterStreamFlags)

      Reset the data buffer and the using Writer/Stream flags but not any status or header information.
      Parameters:
        `resetWriterStreamFlags` - `true` if the internal `usingWriter`, `usingOutputStream`, `isCharacterEncodingSet` flags should also be reset
      Throws:
        `java.lang.IllegalStateException` - if the response has already been committed

    - #### setBufferSize

          public void setBufferSize(int size)

      Set the buffer size to be used for this Response.
      Specified by:
        `setBufferSize` in interface `ServletResponse`
      Parameters:
        `size` - The new buffer size
      Throws:
        `java.lang.IllegalStateException` - if this method is called after output has been committed for this response
      See Also:
        `ServletResponse.getBufferSize()`, `ServletResponse.flushBuffer()`, `ServletResponse.isCommitted()`, `ServletResponse.reset()`

    - #### setContentLength

          public void setContentLength(int length)

      Set the content length (in bytes) for this Response.
      Specified by:
        `setContentLength` in interface `ServletResponse`
      Parameters:
        `length` - The new content length

    - #### setContentType

          public void setContentType(java.lang.String type)

      Set the content type for this Response.
      Specified by:
        `setContentType` in interface `ServletResponse`
      Parameters:
        `type` - The new content type
      See Also:
        `ServletResponse.setLocale(java.util.Locale)`, `ServletResponse.setCharacterEncoding(java.lang.String)`, `ServletResponse.getOutputStream()`, `ServletResponse.getWriter()`

    - #### setCharacterEncoding

          public void setCharacterEncoding(java.lang.String charset)

      Description copied from interface: `javax.servlet.ServletResponse`
      Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by `ServletResponse.setContentType(java.lang.String)` or `ServletResponse.setLocale(java.util.Locale)`, this method overrides it. Calling `ServletResponse.setContentType(java.lang.String)` with the `String` of `text/html` and calling this method with the `String` of `UTF-8` is equivalent with calling `setContentType` with the `String` of `text/html; charset=UTF-8`.

      This method can be called repeatedly to change the character encoding. This method has no effect if it is called after `getWriter` has been called or after the response has been committed.

      Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the `Content-Type` header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.

      Specified by:
        `setCharacterEncoding` in interface `ServletResponse`
      Parameters:
        `charset` - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
      See Also:
        `#setLocale`

    - #### setLocale

          public void setLocale(java.util.Locale locale)

      Set the Locale that is appropriate for this response, including setting the appropriate character encoding.
      Specified by:
        `setLocale` in interface `ServletResponse`
      Parameters:
        `locale` - The new locale
      See Also:
        `ServletResponse.getLocale()`, `ServletResponse.setContentType(java.lang.String)`, `ServletResponse.setCharacterEncoding(java.lang.String)`

    - #### getHeader

          public java.lang.String getHeader(java.lang.String name)

      Description copied from interface: `javax.servlet.http.HttpServletResponse`
      Return the value for the specified header, or `null` if this header has not been set. If more than one value was added for this name, only the first is returned; use `HttpServletResponse.getHeaders(String)` to retrieve all of them.
      Specified by:
        `getHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Header name to look up

    - #### getHeaderNames

          public java.util.Collection<java.lang.String> getHeaderNames()

      Description copied from interface: `javax.servlet.http.HttpServletResponse`
      Return an Iterable of all the header names set for this response.
      Specified by:
        `getHeaderNames` in interface `HttpServletResponse`

    - #### getHeaders

          public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)

      Description copied from interface: `javax.servlet.http.HttpServletResponse`
      Return a Collection of all the header values associated with the specified header name.
      Specified by:
        `getHeaders` in interface `HttpServletResponse`
      Parameters:
        `name` - Header name to look up

    - #### getMessage

          public java.lang.String getMessage()

      Return the error message that was set with `sendError()` for this Response.

    - #### getStatus

          public int getStatus()

      Description copied from interface: `javax.servlet.http.HttpServletResponse`
      Return the HTTP status code associated with this Response.
      Specified by:
        `getStatus` in interface `HttpServletResponse`

    - #### reset

          @Deprecated
          public void reset(int status,
                              java.lang.String message)

      Deprecated.
      Reset this response, and specify the values for the HTTP status code and corresponding message.
      Throws:
        `java.lang.IllegalStateException` - if this response has already been committed

    - #### addCookie

          public void addCookie(Cookie cookie)

      Add the specified Cookie to those that will be included with this Response.
      Specified by:
        `addCookie` in interface `HttpServletResponse`
      Parameters:
        `cookie` - Cookie to be added

    - #### addSessionCookieInternal

          public void addSessionCookieInternal(Cookie cookie)

      Special method for adding a session cookie as we should be overriding any previous
      Parameters:
        `cookie` -

    - #### generateCookieString

          public java.lang.StringBuffer generateCookieString(Cookie cookie)

    - #### addDateHeader

          public void addDateHeader(java.lang.String name,
                           long value)

      Add the specified date header to the specified value.
      Specified by:
        `addDateHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to set
        `value` - Date value to be set
      See Also:
        `HttpServletResponse.setDateHeader(java.lang.String, long)`

    - #### addHeader

          public void addHeader(java.lang.String name,
                       java.lang.String value)

      Add the specified header to the specified value.
      Specified by:
        `addHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to set
        `value` - Value to be set
      See Also:
        `HttpServletResponse.setHeader(java.lang.String, java.lang.String)`

    - #### addIntHeader

          public void addIntHeader(java.lang.String name,
                          int value)

      Add the specified integer header to the specified value.
      Specified by:
        `addIntHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to set
        `value` - Integer value to be set
      See Also:
        `HttpServletResponse.setIntHeader(java.lang.String, int)`

    - #### containsHeader

          public boolean containsHeader(java.lang.String name)

      Has the specified header been set already in this response?
      Specified by:
        `containsHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to check
      Returns:
        `true` if the named response header has already been set; `false` otherwise

    - #### encodeRedirectURL

          public java.lang.String encodeRedirectURL(java.lang.String url)

      Encode the session identifier associated with this response into the specified redirect URL, if necessary.
      Specified by:
        `encodeRedirectURL` in interface `HttpServletResponse`
      Parameters:
        `url` - URL to be encoded
      Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.
      See Also:
        `HttpServletResponse.sendRedirect(java.lang.String)`, `HttpServletResponse.encodeUrl(java.lang.String)`

    - #### encodeRedirectUrl

          @Deprecated
          public java.lang.String encodeRedirectUrl(java.lang.String url)

      Deprecated. As of Version 2.1 of the Java Servlet API, use `encodeRedirectURL()` instead.
      Encode the session identifier associated with this response into the specified redirect URL, if necessary.
      Specified by:
        `encodeRedirectUrl` in interface `HttpServletResponse`
      Parameters:
        `url` - URL to be encoded
      Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

    - #### encodeURL

          public java.lang.String encodeURL(java.lang.String url)

      Encode the session identifier associated with this response into the specified URL, if necessary.
      Specified by:
        `encodeURL` in interface `HttpServletResponse`
      Parameters:
        `url` - URL to be encoded
      Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

    - #### encodeUrl

          @Deprecated
          public java.lang.String encodeUrl(java.lang.String url)

      Deprecated. As of Version 2.1 of the Java Servlet API, use `encodeURL()` instead.
      Encode the session identifier associated with this response into the specified URL, if necessary.
      Specified by:
        `encodeUrl` in interface `HttpServletResponse`
      Parameters:
        `url` - URL to be encoded
      Returns:
        the encoded URL if encoding is needed; the unchanged URL otherwise.

    - #### sendAcknowledgement

          public void sendAcknowledgement()
                                   throws java.io.IOException

      Send an acknowledgment of a request.
      Throws:
        `java.io.IOException` - if an input/output error occurs

    - #### sendError

          public void sendError(int status)
                         throws java.io.IOException

      Send an error response with the specified status and a default message.
      Specified by:
        `sendError` in interface `HttpServletResponse`
      Parameters:
        `status` - HTTP status code to send
      Throws:
        `java.lang.IllegalStateException` - if this response has already been committed
        `java.io.IOException` - if an input/output error occurs

    - #### sendError

          public void sendError(int status,
                       java.lang.String message)
                         throws java.io.IOException

      Send an error response with the specified status and message.
      Specified by:
        `sendError` in interface `HttpServletResponse`
      Parameters:
        `status` - HTTP status code to send
        `message` - Corresponding message to send
      Throws:
        `java.lang.IllegalStateException` - if this response has already been committed
        `java.io.IOException` - if an input/output error occurs

    - #### sendRedirect

          public void sendRedirect(java.lang.String location)
                            throws java.io.IOException

      Send a temporary redirect to the specified redirect location URL.
      Specified by:
        `sendRedirect` in interface `HttpServletResponse`
      Parameters:
        `location` - Location URL to redirect to
      Throws:
        `java.lang.IllegalStateException` - if this response has already been committed
        `java.io.IOException` - if an input/output error occurs

    - #### sendRedirect

          public void sendRedirect(java.lang.String location,
                          int status)
                            throws java.io.IOException

      Internal method that allows a redirect to be sent with a status other than `HttpServletResponse.SC_FOUND` (302). No attempt is made to validate the status code.
      Throws:
        `java.io.IOException`

    - #### setDateHeader

          public void setDateHeader(java.lang.String name,
                           long value)

      Set the specified date header to the specified value.
      Specified by:
        `setDateHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to set
        `value` - Date value to be set
      See Also:
        `HttpServletResponse.containsHeader(java.lang.String)`, `HttpServletResponse.addDateHeader(java.lang.String, long)`

    - #### setHeader

          public void setHeader(java.lang.String name,
                       java.lang.String value)

      Set the specified header to the specified value.
      Specified by:
        `setHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to set
        `value` - Value to be set
      See Also:
        `HttpServletResponse.containsHeader(java.lang.String)`, `HttpServletResponse.addHeader(java.lang.String, java.lang.String)`

    - #### setIntHeader

          public void setIntHeader(java.lang.String name,
                          int value)

      Set the specified integer header to the specified value.
      Specified by:
        `setIntHeader` in interface `HttpServletResponse`
      Parameters:
        `name` - Name of the header to set
        `value` - Integer value to be set
      See Also:
        `HttpServletResponse.containsHeader(java.lang.String)`, `HttpServletResponse.addIntHeader(java.lang.String, int)`

    - #### setStatus

          public void setStatus(int status)

      Set the HTTP status to be returned with this response.
      Specified by:
        `setStatus` in interface `HttpServletResponse`
      Parameters:
        `status` - The new HTTP status
      See Also:
        `HttpServletResponse.sendError(int, java.lang.String)`

    - #### setStatus

          @Deprecated
          public void setStatus(int status,
                                  java.lang.String message)

      Deprecated. As of Version 2.1 of the Java Servlet API, this method has been deprecated due to the ambiguous meaning of the message parameter.
      Set the HTTP status and message to be returned with this response.
      Specified by:
        `setStatus` in interface `HttpServletResponse`
      Parameters:
        `status` - The new HTTP status
        `message` - The associated text message

    - #### isEncodeable

          protected boolean isEncodeable(java.lang.String location)

      Return `true` if the specified URL should be encoded with a session identifier. This will be true if all of the following conditions are met:
      - The request we are responding to asked for a valid session
      - The requested session ID was not received via a cookie
      - The specified URL points back to somewhere within the web application that is responding to this request
      Parameters:
        `location` - Absolute URL to be validated

    - #### toAbsolute

          protected java.lang.String toAbsolute(java.lang.String location)

      Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL. If this URL is already absolute, return it unchanged.
      Parameters:
        `location` - URL to be (possibly) converted and then returned
      Throws:
        `java.lang.IllegalArgumentException` - if a MalformedURLException is thrown when converting the relative URL to an absolute one

    - #### toEncoded

          protected java.lang.String toEncoded(java.lang.String url,
                                   java.lang.String sessionId)

      Return the specified URL with the specified session identifier suitably encoded.
      Parameters:
        `url` - URL to be encoded with the session id
        `sessionId` - Session id to be included in the encoded URL

Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.