public class Response extends Object implements HttpServletResponse
| Modifier and Type | Field and Description | 
|---|---|
| protected boolean | appCommittedThe application commit flag. | 
| protected Connector | connectorDeprecated. 
 Unused | 
| protected Response | coyoteResponseCoyote response. | 
| protected ResponseFacade | facadeThe facade associated with this response. | 
| protected SimpleDateFormat | formatDeprecated. 
 Unused. This will be removed in Tomcat 10 | 
| protected boolean | includedThe included flag. | 
| protected static String | infoDescriptive information about this Response implementation. | 
| protected OutputBuffer | outputBufferThe associated output buffer. | 
| protected CoyoteOutputStream | outputStreamThe associated output stream. | 
| protected CharChunk | redirectURLCCRecyclable buffer to hold the redirect URL. | 
| protected Request | requestThe request with which this response is associated. | 
| protected static StringManager | sm | 
| protected UEncoder | urlEncoderURL encoder. | 
| protected boolean | usingOutputStreamUsing output stream flag. | 
| protected boolean | usingWriterUsing writer flag. | 
| protected CoyoteWriter | writerThe associated writer. | 
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 and Description | 
|---|
| Response() | 
| 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(String name,
             long value)Add the specified date header to the specified value. | 
| void | addHeader(String name,
         String value)Add the specified header to the specified value. | 
| void | addIntHeader(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(String name)Has the specified header been set already in this response? | 
| ServletOutputStream | createOutputStream()Deprecated.  | 
| String | encodeRedirectUrl(String url)Deprecated. 
 As of Version 2.1 of the Java Servlet API, use
   encodeRedirectURL()instead. | 
| String | encodeRedirectURL(String url)Encode the session identifier associated with this response
 into the specified redirect URL, if necessary. | 
| String | encodeUrl(String url)Deprecated. 
 As of Version 2.1 of the Java Servlet API, use
   encodeURL()instead. | 
| String | encodeURL(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. | 
| StringBuffer | generateCookieString(Cookie cookie) | 
| int | getBufferSize()Returns the actual buffer size used for the response. | 
| long | getBytesWritten(boolean flush) | 
| String | getCharacterEncoding()Returns the name of the character encoding (MIME charset) used for the
 body sent in this response. | 
| Connector | getConnector()Deprecated.  | 
| int | getContentLength() | 
| String | getContentType()Returns the content type used for the MIME body sent in this response. | 
| long | getContentWritten() | 
| Context | getContext() | 
| Response | getCoyoteResponse() | 
| String | getHeader(String name)Return the value for the specified header, or  nullif this
 header has not been set. | 
| Collection<String> | getHeaderNames()Get the header names set for this HTTP response. | 
| Collection<String> | getHeaders(String name)Return a Collection of all the header values associated with the
 specified header name. | 
| boolean | getIncluded()Deprecated.  | 
| String | getInfo() | 
| Locale | getLocale()Returns the locale specified for this response using the
  ServletResponse.setLocale(java.util.Locale)method. | 
| String | getMessage() | 
| ServletOutputStream | getOutputStream()Returns a  ServletOutputStreamsuitable for writing binary data in
 the response. | 
| 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() | 
| HttpServletResponse | getResponse() | 
| int | getStatus()Get the HTTP status code for this Response. | 
| OutputStream | getStream()Deprecated.  | 
| PrintWriter | getWriter()Returns a  PrintWriterobject that can send character text to
 the client. | 
| 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(String location)Return  trueif 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,
     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 acknowledgement of a request. | 
| void | sendError(int status)Send an error response with the specified status and a
 default message. | 
| void | sendError(int status,
         String message)Send an error response with the specified status and message. | 
| void | sendRedirect(String location)Send a temporary redirect to the specified redirect location URL. | 
| void | sendRedirect(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(String charset)Overrides the name of the character encoding used in the body
 of the request. | 
| 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(String type)Set the content type for this Response. | 
| void | setContext(Context context)Deprecated.  | 
| void | setCoyoteResponse(Response coyoteResponse)Set the Coyote response. | 
| void | setDateHeader(String name,
             long value)Set the specified date header to the specified value. | 
| boolean | setError()Set the error flag. | 
| boolean | setErrorReported() | 
| void | setHeader(String name,
         String value)Set the specified header to the specified value. | 
| void | setIncluded(boolean included)Deprecated.  | 
| void | setIntHeader(String name,
            int value)Set the specified integer header to the specified value. | 
| void | setLocale(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,
         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 String | toAbsolute(String location)Convert (if necessary) and return the absolute URL that represents the
 resource referenced by this possibly relative URL. | 
| protected String | toEncoded(String url,
         String sessionId)Return the specified URL with the specified session identifier
 suitably encoded. | 
protected static final StringManager sm
protected static final String info
@Deprecated protected SimpleDateFormat format
@Deprecated protected Connector connector
protected Response coyoteResponse
protected OutputBuffer outputBuffer
protected CoyoteOutputStream outputStream
protected CoyoteWriter writer
protected boolean appCommitted
protected boolean included
protected boolean usingOutputStream
protected boolean usingWriter
protected final UEncoder urlEncoder
protected CharChunk redirectURLCC
protected Request request
protected ResponseFacade facade
@Deprecated public Connector getConnector()
public void setConnector(Connector connector)
connector - The new connectorpublic void setCoyoteResponse(Response coyoteResponse)
coyoteResponse - The Coyote responsepublic Response getCoyoteResponse()
public Context getContext()
@Deprecated public void setContext(Context context)
getContextPath(),
 and thus enables parsing of the request URI.context - The newly associated Contextpublic void recycle()
public void clearEncoders()
public long getContentWritten()
public long getBytesWritten(boolean flush)
flush - if true will perform a buffer flush firstpublic void setAppCommitted(boolean appCommitted)
appCommitted - The new application committed flag valuepublic boolean isAppCommitted()
true if the application has committed the response@Deprecated public boolean getIncluded()
@Deprecated public void setIncluded(boolean included)
included - true if we are currently inside a
  RequestDispatcher.include(), else falsepublic String getInfo()
<description>/<version>.public Request getRequest()
public void setRequest(Request request)
request - The new associated requestpublic HttpServletResponse getResponse()
ServletResponse for which this object
 is the facade.@Deprecated public OutputStream getStream()
public void setSuspended(boolean suspended)
suspended - The new suspended flag valuepublic boolean isSuspended()
true if the response is suspendedpublic boolean isClosed()
true if the response has been closedpublic boolean setError()
false if the error flag was already setpublic boolean isError()
true if the response has encountered an errorpublic boolean isErrorReportRequired()
public boolean setErrorReported()
@Deprecated public ServletOutputStream createOutputStream() throws IOException
IOException - if an input/output error occurspublic void finishResponse()
                    throws IOException
IOException - if an input/output error occurspublic int getContentLength()
public String getContentType()
ServletResponseServletResponse.setContentType(java.lang.String) before the response is committed. If no content
 type has been specified, this method returns null. If a content type has
 been specified and a character encoding has been explicitly or implicitly
 specified as described in ServletResponse.getCharacterEncoding(), the charset
 parameter is included in the string returned. If no character encoding
 has been specified, the charset parameter is omitted.getContentType in interface ServletResponsenull if no content type was set.public PrintWriter getReporter() throws IOException
IOException - if an input/output error occurspublic void flushBuffer()
                 throws IOException
flushBuffer in interface ServletResponseIOException - if an input/output error occursServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public int getBufferSize()
ServletResponsegetBufferSize in interface ServletResponseServletResponse.setBufferSize(int), 
ServletResponse.flushBuffer(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public String getCharacterEncoding()
ServletResponseServletResponse.setCharacterEncoding(java.lang.String) or
 ServletResponse.setContentType(java.lang.String) methods, or implicitly using the
 ServletResponse.setLocale(java.util.Locale) method. Explicit specifications take precedence over
 implicit specifications. Calls made to these methods after
 getWriter has been called or after the response has been
 committed have no effect on the character encoding. If no character
 encoding has been specified, ISO-8859-1 is returned.
 See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
getCharacterEncoding in interface ServletResponsepublic ServletOutputStream getOutputStream() throws IOException
ServletResponseServletOutputStream suitable for writing binary data in
 the response. The servlet container does not encode the binary data.
 
 Calling flush() on the ServletOutputStream commits the response. Either
 this method or ServletResponse.getWriter() may be called to write the body, not
 both.
getOutputStream in interface ServletResponseIllegalStateException - if getWriter has
  already been called for this responseIOException - if an input/output error occursServletResponse.getWriter()public Locale getLocale()
ServletResponseServletResponse.setLocale(java.util.Locale) method. Calls made to setLocale after the
 response is committed have no effect.getLocale in interface ServletResponseServletResponse.setLocale(java.util.Locale)public PrintWriter getWriter() throws IOException
ServletResponsePrintWriter object that can send character text to
 the client. The PrintWriter uses the character encoding
 returned by ServletResponse.getCharacterEncoding(). If the response's character
 encoding has not been specified as described in
 getCharacterEncoding (i.e., the method just returns the
 default value ISO-8859-1), getWriter updates it
 to ISO-8859-1.
 
 Calling flush() on the PrintWriter commits the response.
 
 Either this method or ServletResponse.getOutputStream() may be called to write the
 body, not both.
getWriter in interface ServletResponseIllegalStateException - if getOutputStream has
  already been called for this responseIOException - if an input/output error occursServletResponse.getOutputStream(), 
ServletResponse.setCharacterEncoding(java.lang.String)public boolean isCommitted()
isCommitted in interface ServletResponsetrue if the response has been committedServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.flushBuffer(), 
ServletResponse.reset()public void reset()
reset in interface ServletResponseIllegalStateException - if this response has already
  been committedServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.flushBuffer(), 
ServletResponse.isCommitted()public void resetBuffer()
resetBuffer in interface ServletResponseIllegalStateException - if the response has already
  been committedServletResponse.setBufferSize(int), 
ServletResponse.getBufferSize(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public void resetBuffer(boolean resetWriterStreamFlags)
resetWriterStreamFlags - true if the internal
        usingWriter, usingOutputStream,
        isCharacterEncodingSet flags should also be resetIllegalStateException - if the response has already
  been committedpublic void setBufferSize(int size)
setBufferSize in interface ServletResponsesize - The new buffer sizeIllegalStateException - if this method is called after
  output has been committed for this responseServletResponse.getBufferSize(), 
ServletResponse.flushBuffer(), 
ServletResponse.isCommitted(), 
ServletResponse.reset()public void setContentLength(int length)
setContentLength in interface ServletResponselength - The new content lengthpublic void setContentType(String type)
setContentType in interface ServletResponsetype - The new content typeServletResponse.setLocale(java.util.Locale), 
ServletResponse.setCharacterEncoding(java.lang.String), 
ServletResponse.getOutputStream(), 
ServletResponse.getWriter()public void setCharacterEncoding(String charset)
setCharacterEncoding in interface ServletResponsecharset - String containing the name of the character encoding.#setLocalepublic void setLocale(Locale locale)
setLocale in interface ServletResponselocale - The new localeServletResponse.getLocale(), 
ServletResponse.setContentType(java.lang.String), 
ServletResponse.setCharacterEncoding(java.lang.String)public String getHeader(String name)
HttpServletResponsenull 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.getHeader in interface HttpServletResponsename - Header name to look uppublic Collection<String> getHeaderNames()
HttpServletResponsegetHeaderNames in interface HttpServletResponsepublic Collection<String> getHeaders(String name)
HttpServletResponsegetHeaders in interface HttpServletResponsename - Header name to look uppublic String getMessage()
sendError()
 for this Response.public int getStatus()
HttpServletResponsegetStatus in interface HttpServletResponse@Deprecated public void reset(int status, String message)
status - The new HTTP statusmessage - The associated text messageIllegalStateException - if this response has already been
  committedpublic void addCookie(Cookie cookie)
addCookie in interface HttpServletResponsecookie - Cookie to be addedpublic void addSessionCookieInternal(Cookie cookie)
cookie - The new session cookie to add the responsepublic StringBuffer generateCookieString(Cookie cookie)
public void addDateHeader(String name, long value)
addDateHeader in interface HttpServletResponsename - Name of the header to setvalue - Date value to be setHttpServletResponse.setDateHeader(java.lang.String, long)public void addHeader(String name, String value)
addHeader in interface HttpServletResponsename - Name of the header to setvalue - Value to be setHttpServletResponse.setHeader(java.lang.String, java.lang.String)public void addIntHeader(String name, int value)
addIntHeader in interface HttpServletResponsename - Name of the header to setvalue - Integer value to be setHttpServletResponse.setIntHeader(java.lang.String, int)public boolean containsHeader(String name)
containsHeader in interface HttpServletResponsename - Name of the header to checktrue if the header has been setpublic String encodeRedirectURL(String url)
encodeRedirectURL in interface HttpServletResponseurl - URL to be encodedtrue if the URL was encodedHttpServletResponse.sendRedirect(java.lang.String), 
HttpServletResponse.encodeUrl(java.lang.String)@Deprecated public String encodeRedirectUrl(String url)
encodeRedirectURL() instead.encodeRedirectUrl in interface HttpServletResponseurl - URL to be encodedtrue if the URL was encodedpublic String encodeURL(String url)
encodeURL in interface HttpServletResponseurl - URL to be encodedtrue if the URL was encoded@Deprecated public String encodeUrl(String url)
encodeURL() instead.encodeUrl in interface HttpServletResponseurl - URL to be encodedtrue if the URL was encodedpublic void sendAcknowledgement()
                         throws IOException
IOException - if an input/output error occurspublic void sendError(int status)
               throws IOException
sendError in interface HttpServletResponsestatus - HTTP status code to sendIllegalStateException - if this response has
  already been committedIOException - if an input/output error occurspublic void sendError(int status,
             String message)
               throws IOException
sendError in interface HttpServletResponsestatus - HTTP status code to sendmessage - Corresponding message to sendIllegalStateException - if this response has
  already been committedIOException - if an input/output error occurspublic void sendRedirect(String location) throws IOException
sendRedirect in interface HttpServletResponselocation - Location URL to redirect toIllegalStateException - if this response has
  already been committedIOException - if an input/output error occurspublic void sendRedirect(String location, int status) throws IOException
HttpServletResponse.SC_FOUND (302). No attempt is made to
 validate the status code.location - Location URL to redirect tostatus - HTTP status code that will be sentIOException - an IO exception occurredpublic void setDateHeader(String name, long value)
setDateHeader in interface HttpServletResponsename - Name of the header to setvalue - Date value to be setHttpServletResponse.containsHeader(java.lang.String), 
HttpServletResponse.addDateHeader(java.lang.String, long)public void setHeader(String name, String value)
setHeader in interface HttpServletResponsename - Name of the header to setvalue - Value to be setHttpServletResponse.containsHeader(java.lang.String), 
HttpServletResponse.addHeader(java.lang.String, java.lang.String)public void setIntHeader(String name, int value)
setIntHeader in interface HttpServletResponsename - Name of the header to setvalue - Integer value to be setHttpServletResponse.containsHeader(java.lang.String), 
HttpServletResponse.addIntHeader(java.lang.String, int)public void setStatus(int status)
setStatus in interface HttpServletResponsestatus - The new HTTP statusHttpServletResponse.sendError(int, java.lang.String)@Deprecated public void setStatus(int status, String message)
setStatus in interface HttpServletResponsestatus - The new HTTP statusmessage - The associated text messageprotected boolean isEncodeable(String location)
true if the specified URL should be encoded with
 a session identifier.  This will be true if all of the following
 conditions are met:
 location - Absolute URL to be validatedtrue if the URL should be encodedprotected String toAbsolute(String location)
location - URL to be (possibly) converted and then returnedIllegalArgumentException - if a MalformedURLException is
  thrown when converting the relative URL to an absolute oneCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.