Package org.apache.coyote

Class Response

java.lang.Object
org.apache.coyote.Response
public final class Response extends Object
Response object.
Author:
James Duncan Davidson [duncan@eng.sun.com], Jason Hunter [jch@eng.sun.com], James Todd [gonzo@eng.sun.com], Harish Prabandham, Hans Bergsten [hans@gefionsoftware.com], Remy Maucherat

  • Constructor Details

    • Response

      public Response()

  • Method Details

    • getRequest

      public Request getRequest()

    • setRequest

      public void setRequest(Request req)

    • setOutputBuffer

      public void setOutputBuffer(OutputBuffer outputBuffer)

    • getMimeHeaders

      public MimeHeaders getMimeHeaders()

    • setHook

      protected void setHook(ActionHook hook)

    • setNote

      public void setNote(int pos, Object value)

    • getNote

      public Object getNote(int pos)

    • action

      public void action(ActionCode actionCode, Object param)

    • getStatus

      public int getStatus()

    • setStatus

      public void setStatus(int status)
      Set the response status.
      Parameters:
      status - The status value to set

    • getMessage

      public String getMessage()
      Get the status message.
      Returns:
      The message associated with the current status

    • setMessage

      public void setMessage(String message)
      Set the status message.
      Parameters:
      message - The status message to set

    • isCommitted

      public boolean isCommitted()

    • setCommitted

      public void setCommitted(boolean v)

    • getCommitTime

      public long getCommitTime()
      Return the time the response was committed (based on System.currentTimeMillis).
      Returns:
      the time the response was committed

    • setErrorException

      public void setErrorException(Exception ex)
      Set the error Exception that occurred during the writing of the response processing.
      Parameters:
      ex - The exception that occurred

    • getErrorException

      public Exception getErrorException()
      Get the Exception that occurred during the writing of the response.
      Returns:
      The exception that occurred

    • isExceptionPresent

      public boolean isExceptionPresent()

    • setError

      @Deprecated public boolean setError()
      Deprecated.
      This method will be changed to return void in Tomcat 11 onwards
      Set the error flag.
      Returns:
      false if the error flag was already set

    • isError

      public boolean isError()
      Error flag accessor.
      Returns:
      true if the response has encountered an error

    • isErrorReportRequired

      public boolean isErrorReportRequired()

    • setErrorReported

      public boolean setErrorReported()

    • resetError

      public void resetError()

    • reset

      public void reset() throws IllegalStateException
      Throws:
      IllegalStateException

    • containsHeader

      public boolean containsHeader(String name)
      Does the response contain the given header.
      Warning: This method always returns false for Content-Type and Content-Length.
      Parameters:
      name - The name of the header of interest
      Returns:
      true if the response contains the header.

    • setHeader

      public void setHeader(String name, String value)

    • addHeader

      public void addHeader(String name, String value)

    • addHeader

      public void addHeader(String name, String value, Charset charset)

    • setTrailerFields

      public void setTrailerFields(Supplier<Map<String,String>> supplier)

    • getTrailerFields

      public Supplier<Map<String,String>> getTrailerFields()

    • sendHeaders

      @Deprecated public void sendHeaders()
      Deprecated.
      Unused. Will be removed in Tomcat 11 onwards. Use commit().
      Signal that we're done with the headers, and body will follow.

    • commit

      public void commit()
      Signal that we're done with the headers, and body will follow.

    • getLocale

      public Locale getLocale()

    • setLocale

      public void setLocale(Locale locale)
      Called explicitly by user to set the Content-Language and the default encoding.
      Parameters:
      locale - The locale to use for this response

    • getContentLanguage

      public String getContentLanguage()
      Return the content language.
      Returns:
      The language code for the language currently associated with this response

    • setCharacterEncoding

      public void setCharacterEncoding(String characterEncoding) throws UnsupportedEncodingException
      Overrides the character encoding used in the body of the response. This method must be called prior to writing output using getWriter().
      Parameters:
      characterEncoding - The name of character encoding.
      Throws:
      UnsupportedEncodingException - If the specified name is not recognised

    • getCharset

      public Charset getCharset()

    • getCharacterEncoding

      public String getCharacterEncoding()
      Returns:
      The name of the current encoding

    • setContentType

      public void setContentType(String type)
      Sets the content type. This method must preserve any response charset that may already have been set via a call to response.setContentType(), response.setLocale(), or response.setCharacterEncoding().
      Parameters:
      type - the content type

    • setContentTypeNoCharset

      public void setContentTypeNoCharset(String type)

    • getContentType

      public String getContentType()

    • setContentLength

      public void setContentLength(long contentLength)

    • getContentLength

      public int getContentLength()

    • getContentLengthLong

      public long getContentLengthLong()

    • doWrite

      public void doWrite(ByteBuffer chunk) throws IOException
      Write a chunk of bytes.
      Parameters:
      chunk - The ByteBuffer to write
      Throws:
      IOException - If an I/O error occurs during the write

    • recycle

      public void recycle()

    • getContentWritten

      public long getContentWritten()
      Bytes written by application - i.e. before compression, chunking, etc.
      Returns:
      The total number of bytes written to the response by the application. This will not be the number of bytes written to the network which may be more or less than this value.

    • getBytesWritten

      public long getBytesWritten(boolean flush)
      Bytes written to socket - i.e. after compression, chunking, etc.
      Parameters:
      flush - Should any remaining bytes be flushed before returning the total? If false bytes remaining in the buffer will not be included in the returned value
      Returns:
      The total number of bytes written to the socket for this response

    • getWriteListener

      public WriteListener getWriteListener()

    • setWriteListener

      public void setWriteListener(WriteListener listener)

    • isReady

      public boolean isReady()

    • checkRegisterForWrite

      public boolean checkRegisterForWrite()

    • onWritePossible

      public void onWritePossible() throws IOException
      Throws:
      IOException