Class Response
- All Implemented Interfaces:
- HttpServletResponse,- ServletResponse
- Author:
- Remy Maucherat, Craig R. McClanahan
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected booleanThe application commit flag.protected ResponseCoyote response.protected ResponseFacadeThe facade associated with this response.protected booleanThe included flag.protected final OutputBufferThe associated output buffer.protected CoyoteOutputStreamThe associated output stream.protected final CharChunkRecyclable buffer to hold the redirect URL.protected RequestThe request with which this response is associated.protected static final StringManagerprotected final UEncoderURL encoder.protected booleanUsing output stream flag.protected booleanUsing writer flag.protected CoyoteWriterThe associated writer.Fields inherited from interface jakarta.servlet.http.HttpServletResponseSC_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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd the specified Cookie to those that will be included with this Response.voidaddDateHeader(String name, long value) Add the specified date header to the specified value.voidAdd the specified header to the specified value.voidaddIntHeader(String name, int value) Add the specified integer header to the specified value.voidaddSessionCookieInternal(Cookie cookie) Special method for adding a session cookie as we should be overriding any previous.booleancontainsHeader(String name) Has the specified header been set already in this response?encodeRedirectURL(String url) Encode the session identifier associated with this response into the specified redirect URL, if necessary.Encode the session identifier associated with this response into the specified URL, if necessary.voidPerform whatever actions are required to flush and close the output stream or writer, in a single operation.voidFlush the buffer and commit this response.generateCookieString(Cookie cookie) intReturns the actual buffer size used for the response.longgetBytesWritten(boolean flush) Returns the name of the character encoding (MIME charset) used for the body sent in this response.intReturns the content type used for the MIME body sent in this response.longReturn the value for the specified header, ornullif this header has not been set.Get the header names set for this HTTP response.getHeaders(String name) Return a Collection of all the header values associated with the specified header name.Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)method.Returns aServletOutputStreamsuitable for writing binary data in the response.Return a PrintWriter that can be used to render error messages, regardless of whether a stream or writer has already been acquired.intGet the HTTP status code for this Response.Obtain the supplier of the trailer headers.Returns aPrintWriterobject that can send character text to the client.booleanApplication commit flag accessor.booleanisClosed()Closed flag accessor.booleanHas the output of this response already been committed?protected booleanisEncodeable(String location) Returntrueif the specified URL should be encoded with a session identifier.booleanisError()Error flag accessor.booleanbooleanSuspended flag accessor.voidrecycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.voidreset()Clear any content written to the buffer.voidReset the data buffer but not any status or header information.voidresetBuffer(boolean resetWriterStreamFlags) Reset the data buffer and the using Writer/Stream flags but not any status or header information.voidsendAcknowledgement(ContinueResponseTiming continueResponseTiming) Send an acknowledgement of a request.voidsendError(int status) Send an error response with the specified status and a default message.voidSend an error response with the specified status and message.voidsendRedirect(String location) Sends a redirect response to the client using the specified redirect location URL with the status codeHttpServletResponse.SC_FOUND302 (Found), clears the response buffer and commits the response.voidsendRedirect(String location, int status) Internal method that allows a redirect to be sent with a status other thanHttpServletResponse.SC_FOUND(302).voidsetAppCommitted(boolean appCommitted) Set the application commit flag.voidsetBufferSize(int size) Set the buffer size to be used for this Response.voidsetCharacterEncoding(String encoding) Overrides the name of the character encoding used in the body of the request.voidsetContentLength(int length) Set the content length (in bytes) for this Response.voidsetContentLengthLong(long length) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.voidsetContentType(String type) Set the content type for this Response.voidsetCoyoteResponse(Response coyoteResponse) Set the Coyote response.voidsetDateHeader(String name, long value) Set the specified date header to the specified value.booleansetError()Deprecated.This method will be changed to return void in Tomcat 11 onwardsbooleanvoidSet the specified header to the specified value.voidsetIntHeader(String name, int value) Set the specified integer header to the specified value.voidSet the Locale that is appropriate for this response, including setting the appropriate character encoding.voidsetRequest(Request request) Set the Request with which this Response is associated.voidsetResponse(HttpServletResponse applicationResponse) Set a wrapped HttpServletResponse to pass to the application.voidsetStatus(int status) Set the HTTP status to be returned with this response.voidsetSuspended(boolean suspended) Set the suspended flag.voidsetTrailerFields(Supplier<Map<String, String>> supplier) Configure the supplier of the trailer headers.protected StringtoAbsolute(String location) Convert (if necessary) and return the absolute URL that represents the resource referenced by this possibly relative URL.protected StringReturn the specified URL with the specified session identifier suitably encoded.
- 
Field Details- 
sm
- 
coyoteResponseCoyote response.
- 
outputBufferThe associated output buffer.
- 
outputStreamThe associated output stream.
- 
writerThe associated writer.
- 
appCommittedprotected boolean appCommittedThe application commit flag.
- 
includedprotected boolean includedThe included flag.
- 
usingOutputStreamprotected boolean usingOutputStreamUsing output stream flag.
- 
usingWriterprotected boolean usingWriterUsing writer flag.
- 
urlEncoderURL encoder.
- 
redirectURLCCRecyclable buffer to hold the redirect URL.
- 
requestThe request with which this response is associated.
- 
facadeThe facade associated with this response.
 
- 
- 
Constructor Details- 
Responsepublic Response()
- 
Responsepublic Response(int outputBufferSize) 
 
- 
- 
Method Details- 
setCoyoteResponseSet the Coyote response.- Parameters:
- coyoteResponse- The Coyote response
 
- 
getCoyoteResponse- Returns:
- the Coyote response.
 
- 
getContext- Returns:
- the Context within which this Request is being processed.
 
- 
recyclepublic void recycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.
- 
getCookies
- 
getContentWrittenpublic long getContentWritten()- Returns:
- the number of bytes the application has actually written to the output stream. This excludes chunking, compression, etc. as well as headers.
 
- 
getBytesWrittenpublic long getBytesWritten(boolean flush) - Parameters:
- flush- if- truewill perform a buffer flush first
- Returns:
- the number of bytes the actually written to the socket. This includes chunking, compression, etc. but excludes headers.
 
- 
setAppCommittedpublic void setAppCommitted(boolean appCommitted) Set the application commit flag.- Parameters:
- appCommitted- The new application committed flag value
 
- 
isAppCommittedpublic boolean isAppCommitted()Application commit flag accessor.- Returns:
- trueif the application has committed the response
 
- 
getRequest- Returns:
- the Request with which this Response is associated.
 
- 
setRequestSet the Request with which this Response is associated.- Parameters:
- request- The new associated request
 
- 
getResponse- Returns:
- the ServletResponsefor which this object is the facade.
 
- 
setResponseSet a wrapped HttpServletResponse to pass to the application. Components wishing to wrap the response should obtain the response viagetResponse(), wrap it and then call this method with the wrapped response.- Parameters:
- applicationResponse- The wrapped response to pass to the application
 
- 
setSuspendedpublic void setSuspended(boolean suspended) Set the suspended flag.- Parameters:
- suspended- The new suspended flag value
 
- 
isSuspendedpublic boolean isSuspended()Suspended flag accessor.- Returns:
- trueif the response is suspended
 
- 
isClosedpublic boolean isClosed()Closed flag accessor.- Returns:
- trueif the response has been closed
 
- 
setErrorDeprecated.This method will be changed to return void in Tomcat 11 onwardsSet the error flag.- Returns:
- falseif the error flag was already set
 
- 
isErrorpublic boolean isError()Error flag accessor.- Returns:
- trueif the response has encountered an error
 
- 
isErrorReportRequiredpublic boolean isErrorReportRequired()
- 
setErrorReportedpublic boolean setErrorReported()
- 
finishResponsePerform whatever actions are required to flush and close the output stream or writer, in a single operation.- Throws:
- IOException- if an input/output error occurs
 
- 
getContentLengthpublic int getContentLength()- Returns:
- the content length that was set or calculated for this Response.
 
- 
getContentTypeDescription copied from interface:jakarta.servlet.ServletResponseReturns the content type used for the MIME body sent in this response. The content type proper must have been specified usingServletResponse.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 inServletResponse.getCharacterEncoding(), the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.- Specified by:
- getContentTypein interface- ServletResponse
- Returns:
- the content type that was set or calculated for this response, or nullif no content type was set.
 
- 
getReporterReturn 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:
- IOException- if an input/output error occurs
 
- 
flushBufferFlush the buffer and commit this response.- Specified by:
- flushBufferin interface- ServletResponse
- Throws:
- IOException- if an input/output error occurs
- See Also:
 
- 
getBufferSizepublic int getBufferSize()Description copied from interface:jakarta.servlet.ServletResponseReturns the actual buffer size used for the response. If no buffering is used, this method returns 0.- Specified by:
- getBufferSizein interface- ServletResponse
- Returns:
- the actual buffer size used for this Response.
- See Also:
 
- 
getCharacterEncodingDescription copied from interface:jakarta.servlet.ServletResponseReturns the name of the character encoding (MIME charset) used for the body sent in this response. The charset for the MIME body response can be specified explicitly or implicitly. The priority order for specifying the response body is:- explicitly per request using ServletResponse.setCharacterEncoding(java.lang.String)andServletResponse.setContentType(java.lang.String)
- implicitly per request using ServletResponse.setLocale(java.util.Locale)
- per web application via the deployment descriptor or
 ServletContext.setRequestCharacterEncoding(String)
- container default via vendor specific configuration
- ISO-8859-1
 ServletResponse.setCharacterEncoding(java.lang.String),ServletResponse.setContentType(java.lang.String)orServletResponse.setLocale(java.util.Locale)aftergetWriterhas 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-1is returned.See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME. - Specified by:
- getCharacterEncodingin interface- ServletResponse
- Returns:
- the character encoding used for this Response.
 
- explicitly per request using 
- 
getOutputStreamDescription copied from interface:jakarta.servlet.ServletResponseReturns aServletOutputStreamsuitable 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.- Specified by:
- getOutputStreamin interface- ServletResponse
- Returns:
- the servlet output stream associated with this Response.
- Throws:
- IllegalStateException- if- getWriterhas already been called for this response
- IOException- if an input/output error occurs
- See Also:
 
- 
getLocaleDescription copied from interface:jakarta.servlet.ServletResponseReturns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)method. Calls made tosetLocaleafter the response is committed have no effect.- Specified by:
- getLocalein interface- ServletResponse
- Returns:
- the Locale assigned to this response.
- See Also:
 
- 
getWriterDescription copied from interface:jakarta.servlet.ServletResponseReturns aPrintWriterobject that can send character text to the client. ThePrintWriteruses the character encoding returned byServletResponse.getCharacterEncoding(). If the response's character encoding has not been specified as described ingetCharacterEncoding(i.e., the method just returns the default valueISO-8859-1),getWriterupdates it toISO-8859-1.Calling flush() on the PrintWritercommits the response.Either this method or ServletResponse.getOutputStream()may be called to write the body, not both.- Specified by:
- getWriterin interface- ServletResponse
- Returns:
- the writer associated with this Response.
- Throws:
- IllegalStateException- if- getOutputStreamhas already been called for this response
- IOException- if an input/output error occurs
- See Also:
 
- 
isCommittedpublic boolean isCommitted()Has the output of this response already been committed?- Specified by:
- isCommittedin interface- ServletResponse
- Returns:
- trueif the response has been committed
- See Also:
 
- 
resetpublic void reset()Clear any content written to the buffer.- Specified by:
- resetin interface- ServletResponse
- Throws:
- IllegalStateException- if this response has already been committed
- See Also:
 
- 
resetBufferpublic void resetBuffer()Reset the data buffer but not any status or header information.- Specified by:
- resetBufferin interface- ServletResponse
- Throws:
- IllegalStateException- if the response has already been committed
- See Also:
 
- 
resetBufferpublic void resetBuffer(boolean resetWriterStreamFlags) Reset the data buffer and the using Writer/Stream flags but not any status or header information.- Parameters:
- resetWriterStreamFlags-- trueif the internal- usingWriter,- usingOutputStream,- isCharacterEncodingSetflags should also be reset
- Throws:
- IllegalStateException- if the response has already been committed
 
- 
setBufferSizepublic void setBufferSize(int size) Set the buffer size to be used for this Response.- Specified by:
- setBufferSizein interface- ServletResponse
- Parameters:
- size- The new buffer size
- Throws:
- IllegalStateException- if this method is called after output has been committed for this response
- See Also:
 
- 
setContentLengthpublic void setContentLength(int length) Set the content length (in bytes) for this Response.- Specified by:
- setContentLengthin interface- ServletResponse
- Parameters:
- length- The new content length
 
- 
setContentLengthLongpublic void setContentLengthLong(long length) Description copied from interface:jakarta.servlet.ServletResponseSets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
- setContentLengthLongin interface- ServletResponse
- Parameters:
- length- an integer specifying the length of the content being returned to the client; sets the Content-Length header
 
- 
setContentTypeSet the content type for this Response.- Specified by:
- setContentTypein interface- ServletResponse
- Parameters:
- type- The new content type
- See Also:
 
- 
setCharacterEncodingOverrides the name of the character encoding used in the body of the request. This method must be called prior to reading request parameters or reading input using getReader().- Specified by:
- setCharacterEncodingin interface- ServletResponse
- Parameters:
- encoding- String containing the name of the character encoding.
- See Also:
 
- 
setLocaleSet the Locale that is appropriate for this response, including setting the appropriate character encoding.- Specified by:
- setLocalein interface- ServletResponse
- Parameters:
- locale- The new locale
- See Also:
 
- 
getHeaderDescription copied from interface:jakarta.servlet.http.HttpServletResponseReturn the value for the specified header, ornullif this header has not been set. If more than one value was added for this name, only the first is returned; useHttpServletResponse.getHeaders(String)to retrieve all of them.- Specified by:
- getHeaderin interface- HttpServletResponse
- Parameters:
- name- Header name to look up
- Returns:
- The first value for the specified header. This is the raw value so if multiple values are specified in the first header then they will be returned as a single header value .
 
- 
getHeaderNamesDescription copied from interface:jakarta.servlet.http.HttpServletResponseGet the header names set for this HTTP response.- Specified by:
- getHeaderNamesin interface- HttpServletResponse
- Returns:
- The header names set for this HTTP response.
 
- 
getHeadersDescription copied from interface:jakarta.servlet.http.HttpServletResponseReturn a Collection of all the header values associated with the specified header name.- Specified by:
- getHeadersin interface- HttpServletResponse
- Parameters:
- name- Header name to look up
- Returns:
- The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.
 
- 
getMessage- Returns:
- the error message that was set with sendError()for this Response.
 
- 
getStatuspublic int getStatus()Description copied from interface:jakarta.servlet.http.HttpServletResponseGet the HTTP status code for this Response.- Specified by:
- getStatusin interface- HttpServletResponse
- Returns:
- The HTTP status code for this Response
 
- 
addCookieAdd the specified Cookie to those that will be included with this Response.- Specified by:
- addCookiein interface- HttpServletResponse
- Parameters:
- cookie- Cookie to be added
 
- 
addSessionCookieInternalSpecial method for adding a session cookie as we should be overriding any previous.- Parameters:
- cookie- The new session cookie to add the response
 
- 
generateCookieString
- 
addDateHeaderAdd the specified date header to the specified value.- Specified by:
- addDateHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to set
- value- Date value to be set
- See Also:
 
- 
addHeaderAdd the specified header to the specified value.- Specified by:
- addHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to set
- value- Value to be set
- See Also:
 
- 
addIntHeaderAdd the specified integer header to the specified value.- Specified by:
- addIntHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to set
- value- Integer value to be set
- See Also:
 
- 
containsHeaderHas the specified header been set already in this response?- Specified by:
- containsHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to check
- Returns:
- trueif the header has been set
 
- 
setTrailerFieldsDescription copied from interface:jakarta.servlet.http.HttpServletResponseConfigure the supplier of the trailer headers. The supplier will be called in the scope of the thread that completes the response.
 Trailers that don't meet the requirements of RFC 7230, section 4.1.2 will be ignored.
 The default implementation is a NO-OP.- Specified by:
- setTrailerFieldsin interface- HttpServletResponse
- Parameters:
- supplier- The supplier for the trailer headers
 
- 
getTrailerFieldsDescription copied from interface:jakarta.servlet.http.HttpServletResponseObtain the supplier of the trailer headers.
 The default implementation returns null.- Specified by:
- getTrailerFieldsin interface- HttpServletResponse
- Returns:
- The supplier for the trailer headers
 
- 
encodeRedirectURLEncode the session identifier associated with this response into the specified redirect URL, if necessary.- Specified by:
- encodeRedirectURLin interface- HttpServletResponse
- Parameters:
- url- URL to be encoded
- Returns:
- trueif the URL was encoded
- See Also:
 
- 
encodeURLEncode the session identifier associated with this response into the specified URL, if necessary.- Specified by:
- encodeURLin interface- HttpServletResponse
- Parameters:
- url- URL to be encoded
- Returns:
- trueif the URL was encoded
 
- 
sendAcknowledgementSend an acknowledgement of a request.- Parameters:
- continueResponseTiming- Indicates when the request for the ACK originated so it can be compared with the configured timing for ACK responses.
- Throws:
- IOException- if an input/output error occurs
 
- 
sendErrorSend an error response with the specified status and a default message.- Specified by:
- sendErrorin interface- HttpServletResponse
- Parameters:
- status- HTTP status code to send
- Throws:
- IllegalStateException- if this response has already been committed
- IOException- if an input/output error occurs
 
- 
sendErrorSend an error response with the specified status and message.- Specified by:
- sendErrorin interface- HttpServletResponse
- Parameters:
- status- HTTP status code to send
- message- Corresponding message to send
- Throws:
- IllegalStateException- if this response has already been committed
- IOException- if an input/output error occurs
 
- 
sendRedirectDescription copied from interface:jakarta.servlet.http.HttpServletResponseSends a redirect response to the client using the specified redirect location URL with the status codeHttpServletResponse.SC_FOUND302 (Found), clears the response buffer and commits the response. The response buffer will be replaced with a short hypertext note as per RFC 9110.This method has no effect if called from an include. This method accepts both relative and absolute URLs. Absolute URLs passed to this method are used as provided as the redirect location URL. Relative URLs are converted to absolute URLs. If converting a relative URL to an absolute URL then: - If the location is relative without a leading '/' the container interprets it as relative to the current request URI.
- If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.
- If the location is relative with two leading '/' the container interprets it as a network-path reference (see RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, section 4.2 "Relative Reference").
 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. - Specified by:
- sendRedirectin interface- HttpServletResponse
- Parameters:
- location- the redirect location URL (may be absolute or relative)
- Throws:
- IOException- If an input or output exception occurs
 
- 
sendRedirectInternal method that allows a redirect to be sent with a status other thanHttpServletResponse.SC_FOUND(302). No attempt is made to validate the status code.- Parameters:
- location- Location URL to redirect to
- status- HTTP status code that will be sent
- Throws:
- IOException- an IO exception occurred
 
- 
setDateHeaderSet the specified date header to the specified value.- Specified by:
- setDateHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to set
- value- Date value to be set
- See Also:
 
- 
setHeaderSet the specified header to the specified value.- Specified by:
- setHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to set
- value- Value to be set
- See Also:
 
- 
setIntHeaderSet the specified integer header to the specified value.- Specified by:
- setIntHeaderin interface- HttpServletResponse
- Parameters:
- name- Name of the header to set
- value- Integer value to be set
- See Also:
 
- 
setStatuspublic void setStatus(int status) Set the HTTP status to be returned with this response.- Specified by:
- setStatusin interface- HttpServletResponse
- Parameters:
- status- The new HTTP status
- See Also:
 
- 
isEncodeableReturntrueif 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
- Returns:
- trueif the URL should be encoded
 
- 
toAbsoluteConvert (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
- Returns:
- the encoded URL
- Throws:
- IllegalArgumentException- if a MalformedURLException is thrown when converting the relative URL to an absolute one
 
- 
toEncodedReturn 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
- Returns:
- the encoded URL
 
 
-