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 SimpleDateFormatDeprecated.Unused.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 intprotected static final StringManagerprotected final UEncoderURL encoder.protected booleanUsing output stream flag.protected booleanUsing writer flag.protected CoyoteWriterThe associated writer.Fields inherited from interface javax.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) Adds a response header with the given name and date-value.voidAdds a response header with the given name and value.voidaddIntHeader(String name, int value) Adds a response header with the given name and integer value.voidaddSessionCookieInternal(Cookie cookie) Special method for adding a session cookie as we should be overriding any previous.booleancontainsHeader(String name) Returns a boolean indicating whether the named response header has already been set.encodeRedirectUrl(String url) Deprecated.encodeRedirectURL(String url) Encodes the specified URL for use in thesendRedirectmethod or, if encoding is not needed, returns the URL unchanged.Deprecated.As of Version 2.1 of the Java Servlet API, useencodeURL()instead.Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.voidPerform whatever actions are required to flush and close the output stream or writer, in a single operation.voidForces any content in the buffer to be written to the client.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.booleanReturns a boolean indicating if the response has 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()Clears any data that exists in the buffer as well as the status code and headers.voidClears the content of the underlying buffer in the response without clearing headers or status code.voidresetBuffer(boolean resetWriterStreamFlags) Reset the data buffer and the using Writer/Stream flags but not any status or header information.voidvoidDeprecated.Unused.voidsendAcknowledgement(ContinueResponseTiming continueResponseTiming) Send an acknowledgement of a request.voidvoidsendError(int status) Sends an error response to the client using the specified status code and clears the buffer.voidSends an error response to the client using the specified status code and clears the output buffer.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) Sets the preferred buffer size for the body of the response.voidsetCharacterEncoding(String encoding) Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.voidsetContentLength(int length) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.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) Sets the content type of the response being sent to the client, if the response has not been committed yet.voidsetCoyoteResponse(Response coyoteResponse) Set the Coyote response.voidsetDateHeader(String name, long value) Sets a response header with the given name and date-value.booleansetError()Deprecated.This method will be changed to return void in Tomcat 11 onwardsbooleanvoidSets a response header with the given name and value.voidsetIntHeader(String name, int value) Sets a response header with the given name and integer value.voidSets the locale of the response, if the response has not been committed yet.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) Sets the status code for this response.voidDeprecated.As of Version 2.1 of the Java Servlet API, this method has been deprecated due to the ambiguous meaning of the message parameter.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
- 
SC_EARLY_HINTSprotected static final int SC_EARLY_HINTS- See Also:
 
- 
formatDeprecated.Unused. This will be removed in Tomcat 10The date format we will use for creating date headers.
- 
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()
- 
resetErrorpublic void resetError()
- 
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:javax.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:
- a Stringspecifying the content type, for example,text/html; charset=UTF-8, or null
 
- 
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
 
- 
flushBufferDescription copied from interface:javax.servlet.ServletResponseForces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.- Specified by:
- flushBufferin interface- ServletResponse
- Throws:
- IOException- if an I/O occurs during the flushing of the response
- See Also:
 
- 
getBufferSizepublic int getBufferSize()Description copied from interface:javax.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
- See Also:
 
- 
getCharacterEncodingDescription copied from interface:javax.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:
- a Stringspecifying the name of the character encoding, for example,UTF-8
 
- explicitly per request using 
- 
getOutputStreamDescription copied from interface:javax.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:
- a ServletOutputStreamfor writing binary data
- Throws:
- IOException- if an input or output exception occurred
- See Also:
 
- 
getLocaleDescription copied from interface:javax.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 specified for this response using the ServletResponse.setLocale(java.util.Locale)method. If no locale has been specified, the container's default locale is returned.
- See Also:
 
- 
getWriterDescription copied from interface:javax.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:
- a PrintWriterobject that can return character data to the client
- Throws:
- UnsupportedEncodingException- if the character encoding returned by- getCharacterEncodingcannot be used
- IOException- if an input or output exception occurred
- See Also:
 
- 
isCommittedpublic boolean isCommitted()Description copied from interface:javax.servlet.ServletResponseReturns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.- Specified by:
- isCommittedin interface- ServletResponse
- Returns:
- a boolean indicating if the response has been committed
- See Also:
 
- 
resetpublic void reset()Description copied from interface:javax.servlet.ServletResponseClears any data that exists in the buffer as well as the status code and headers. If the response has been committed, this method throws anIllegalStateException.- Specified by:
- resetin interface- ServletResponse
- See Also:
 
- 
resetBufferpublic void resetBuffer()Description copied from interface:javax.servlet.ServletResponseClears the content of the underlying buffer in the response without clearing headers or status code. If the response has been committed, this method throws anIllegalStateException.- Specified by:
- resetBufferin interface- ServletResponse
- 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) Description copied from interface:javax.servlet.ServletResponseSets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found usinggetBufferSize.A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly. This method must be called before any response body content is written; if content has been written or the response object has been committed, this method throws an IllegalStateException.- Specified by:
- setBufferSizein interface- ServletResponse
- Parameters:
- size- the preferred buffer size
- See Also:
 
- 
setContentLengthpublic void setContentLength(int length) Description copied from interface:javax.servlet.ServletResponseSets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
- setContentLengthin interface- ServletResponse
- Parameters:
- length- an integer specifying the length of the content being returned to the client; sets the Content-Length header
 
- 
setContentLengthLongpublic void setContentLengthLong(long length) Description copied from interface:javax.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
 
- 
setContentTypeDescription copied from interface:javax.servlet.ServletResponseSets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example,text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called beforegetWriteris called.This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after getWriterhas been called or after the response has been committed.Containers must communicate the content type and 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 Content-Typeheader is used.- Specified by:
- setContentTypein interface- ServletResponse
- Parameters:
- type- a- Stringspecifying the MIME type of the content
- See Also:
 
- 
setCharacterEncodingDescription copied from interface:javax.servlet.ServletResponseSets 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 container default, ServletContext default,ServletResponse.setContentType(java.lang.String)orServletResponse.setLocale(java.util.Locale), this method overrides it. CallingServletResponse.setContentType(java.lang.String)with theStringoftext/htmland calling this method with theStringofUTF-8is equivalent with callingsetContentTypewith theStringoftext/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 getWriterhas 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-Typeheader 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:
- setCharacterEncodingin interface- ServletResponse
- Parameters:
- encoding- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
- See Also:
 
- 
setLocaleDescription copied from interface:javax.servlet.ServletResponseSets the locale of the response, if the response has not been committed yet. It also sets the response's character encoding appropriately for the locale, if the character encoding has not been explicitly set usingServletResponse.setContentType(java.lang.String)orServletResponse.setCharacterEncoding(java.lang.String),getWriterhasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains alocale-encoding-mapping-listelement, and that element provides a mapping for the given locale, that mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.This method may be called repeatedly to change locale and character encoding. The method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after ServletResponse.setContentType(java.lang.String)has been called with a charset specification, afterServletResponse.setCharacterEncoding(java.lang.String)has been called, aftergetWriterhas been called, or after the response has been committed.Containers must communicate the locale and 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 locale is communicated via the Content-Languageheader, the character encoding as part of theContent-Typeheader 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:
- setLocalein interface- ServletResponse
- Parameters:
- locale- the locale of the response
- See Also:
 
- 
getHeaderDescription copied from interface:javax.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:javax.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:javax.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:javax.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
- 
addDateHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseAdds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.- Specified by:
- addDateHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header to set
- value- the additional date value
- See Also:
 
- 
addHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseAdds a response header with the given name and value. This method allows response headers to have multiple values.- Specified by:
- addHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header
- value- the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
- See Also:
 
- 
addIntHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseAdds a response header with the given name and integer value. This method allows response headers to have multiple values.- Specified by:
- addIntHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header
- value- the assigned integer value
- See Also:
 
- 
containsHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseReturns a boolean indicating whether the named response header has already been set.- Specified by:
- containsHeaderin interface- HttpServletResponse
- Parameters:
- name- the header name
- Returns:
- trueif the named response header has already been set;- falseotherwise
 
- 
setTrailerFieldsDescription copied from interface:javax.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:javax.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
 
- 
encodeRedirectURLDescription copied from interface:javax.servlet.http.HttpServletResponseEncodes the specified URL for use in thesendRedirectmethod or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from theencodeURLmethod.All URLs sent to the HttpServletResponse.sendRedirectmethod should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.- Specified by:
- encodeRedirectURLin interface- HttpServletResponse
- Parameters:
- url- the url to be encoded.
- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
- See Also:
 
- 
encodeRedirectUrlDeprecated.- Specified by:
- encodeRedirectUrlin interface- HttpServletResponse
- Parameters:
- url- the url to be encoded.
- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
 
- 
encodeURLDescription copied from interface:javax.servlet.http.HttpServletResponseEncodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies. - Specified by:
- encodeURLin interface- HttpServletResponse
- Parameters:
- url- the url to be encoded.
- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
 
- 
encodeUrlDeprecated.As of Version 2.1 of the Java Servlet API, useencodeURL()instead.Encode 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
 
- 
sendAcknowledgementDeprecated.Unused. Will be removed in Tomcat 10. UsesendAcknowledgement(ContinueResponseTiming).Send an acknowledgement of a request.- Throws:
- IOException- if an input/output error occurs
 
- 
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
 
- 
sendEarlyHintspublic void sendEarlyHints()
- 
sendErrorSends an error response to the client using the specified status code and clears the buffer. This is equivalent to callingHttpServletResponse.sendError(int, String)with the same status code andnullfor the message.Calling sendErrorwith a status code of 103 differs from the usual behavior. Sending 103 will trigger the container to send a "103 Early Hints" informational response including all current headers. The application can continue to use the request and response after calling sendError with a 103 status code, including triggering a more typical response of any type.Starting with Tomcat 12, applications should use sendEarlyHints().- Specified by:
- sendErrorin interface- HttpServletResponse
- Parameters:
- status- the error status code
- Throws:
- IOException- If an input or output exception occurs
 
- 
sendErrorSends an error response to the client using the specified status code and clears the output buffer. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter.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. Calling sendErrorwith a status code of 103 differs from the usual behavior. Sending 103 will trigger the container to send a "103 Early Hints" informational response including all current headers. The application can continue to use the request and response after calling sendError with a 103 status code, including triggering a more typical response of any type.Starting with Tomcat 12, applications should use sendEarlyHints().- Specified by:
- sendErrorin interface- HttpServletResponse
- Parameters:
- status- the error status code
- message- the descriptive message
- Throws:
- IOException- If an input or output exception occurs
 
- 
sendRedirectDescription copied from interface:javax.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
 
- 
setDateHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseSets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. ThecontainsHeadermethod can be used to test for the presence of a header before setting its value.- Specified by:
- setDateHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header to set
- value- the assigned date value
- See Also:
 
- 
setHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseSets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeadermethod can be used to test for the presence of a header before setting its value.- Specified by:
- setHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header
- value- the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
- See Also:
 
- 
setIntHeaderDescription copied from interface:javax.servlet.http.HttpServletResponseSets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeadermethod can be used to test for the presence of a header before setting its value.- Specified by:
- setIntHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header
- value- the assigned integer value
- See Also:
 
- 
setStatuspublic void setStatus(int status) Description copied from interface:javax.servlet.http.HttpServletResponseSets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, thesendErrormethod should be used instead.The container clears the buffer and sets the Location header, preserving cookies and other headers. - Specified by:
- setStatusin interface- HttpServletResponse
- Parameters:
- status- the status code
- See Also:
 
- 
setStatusDeprecated.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:
- setStatusin interface- HttpServletResponse
- Parameters:
- status- The new HTTP status
- message- The associated text message
 
- 
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
 
 
-