Class ResponseFacade
- All Implemented Interfaces:
HttpServletResponse,ServletResponse
- Author:
- Remy Maucherat
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ResponseThe wrapped response.protected static final StringManagerThe string manager for this package.Fields inherited from interface javax.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY -
Constructor Summary
ConstructorsConstructorDescriptionResponseFacade(Response response) Construct a wrapper for the specified response. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the specified cookie to the response.voidaddDateHeader(String name, long date) 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.voidclear()Clear facade.protected Objectclone()Prevent cloning the facade.booleancontainsHeader(String name) Returns a boolean indicating whether the named response header has already been set.encodeRedirectUrl(String url) encodeRedirectURL(String url) Encodes the specified URL for use in thesendRedirectmethod or, if encoding is not needed, returns the URL unchanged.Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.voidfinish()voidForces any content in the buffer to be written to the client.intReturns the actual buffer size used for the response.Returns the name of the character encoding (MIME charset) used for the body sent in this response.Returns 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.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.booleanReturns a boolean indicating if the response has been committed.booleanvoidreset()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.voidvoidsendError(int sc) 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.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 len) 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.voidsetDateHeader(String name, long date) Sets a response header with the given name and date-value.voidSets 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.voidsetStatus(int sc) Sets the status code for this response.voidSets the status code and message for this response.voidsetTrailerFields(Supplier<Map<String, String>> supplier) Configure the supplier of the trailer headers.
-
Field Details
-
sm
The string manager for this package. -
response
The wrapped response.
-
-
Constructor Details
-
ResponseFacade
Construct a wrapper for the specified response.- Parameters:
response- The response to be wrapped
-
-
Method Details
-
clear
public void clear()Clear facade. -
clone
Prevent cloning the facade.- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
finish
public void finish() -
isFinished
public boolean isFinished() -
getContentWritten
public long getContentWritten() -
getCharacterEncoding
Description 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 interfaceServletResponse- Returns:
- a
Stringspecifying the name of the character encoding, for example,UTF-8
- explicitly per request using
-
getOutputStream
Description 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 interfaceServletResponse- Returns:
- a
ServletOutputStreamfor writing binary data - Throws:
IOException- if an input or output exception occurred- See Also:
-
getWriter
Description 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 interfaceServletResponse- Returns:
- a
PrintWriterobject that can return character data to the client - Throws:
UnsupportedEncodingException- if the character encoding returned bygetCharacterEncodingcannot be usedIOException- if an input or output exception occurred- See Also:
-
setContentLength
public void setContentLength(int len) 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 interfaceServletResponse- Parameters:
len- an integer specifying the length of the content being returned to the client; sets the Content-Length header
-
setContentLengthLong
public 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 interfaceServletResponse- Parameters:
length- an integer specifying the length of the content being returned to the client; sets the Content-Length header
-
setContentType
Description 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 interfaceServletResponse- Parameters:
type- aStringspecifying the MIME type of the content- See Also:
-
setBufferSize
public 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 interfaceServletResponse- Parameters:
size- the preferred buffer size- See Also:
-
getBufferSize
public 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 interfaceServletResponse- Returns:
- the actual buffer size used
- See Also:
-
flushBuffer
Description 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 interfaceServletResponse- Throws:
IOException- if an I/O occurs during the flushing of the response- See Also:
-
resetBuffer
public 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 interfaceServletResponse- See Also:
-
isCommitted
public 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 interfaceServletResponse- Returns:
- a boolean indicating if the response has been committed
- See Also:
-
reset
public 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 interfaceServletResponse- See Also:
-
setLocale
Description 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 interfaceServletResponse- Parameters:
loc- the locale of the response- See Also:
-
getLocale
Description 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 interfaceServletResponse- 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:
-
addCookie
Description copied from interface:javax.servlet.http.HttpServletResponseAdds the specified cookie to the response. This method can be called multiple times to set more than one cookie.- Specified by:
addCookiein interfaceHttpServletResponse- Parameters:
cookie- the Cookie to return to the client
-
containsHeader
Description copied from interface:javax.servlet.http.HttpServletResponseReturns a boolean indicating whether the named response header has already been set.- Specified by:
containsHeaderin interfaceHttpServletResponse- Parameters:
name- the header name- Returns:
trueif the named response header has already been set;falseotherwise
-
encodeURL
Description 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 interfaceHttpServletResponse- Parameters:
url- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
encodeRedirectURL
Description 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 interfaceHttpServletResponse- Parameters:
url- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
- See Also:
-
sendEarlyHints
public void sendEarlyHints() -
encodeUrl
- Specified by:
encodeUrlin interfaceHttpServletResponse- Parameters:
url- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
encodeRedirectUrl
- Specified by:
encodeRedirectUrlin interfaceHttpServletResponse- Parameters:
url- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
-
sendError
Description copied from interface:javax.servlet.http.HttpServletResponseSends 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.
- Specified by:
sendErrorin interfaceHttpServletResponse- Parameters:
sc- the error status codemsg- the descriptive message- Throws:
IOException- If an input or output exception occurs
-
sendError
Description copied from interface:javax.servlet.http.HttpServletResponseSends 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.- Specified by:
sendErrorin interfaceHttpServletResponse- Parameters:
sc- the error status code- Throws:
IOException- If an input or output exception occurs
-
sendRedirect
Description 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 interfaceHttpServletResponse- Parameters:
location- the redirect location URL (may be absolute or relative)- Throws:
IOException- If an input or output exception occurs
-
setDateHeader
Description 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 interfaceHttpServletResponse- Parameters:
name- the name of the header to setdate- the assigned date value- See Also:
-
addDateHeader
Description 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 interfaceHttpServletResponse- Parameters:
name- the name of the header to setdate- the additional date value- See Also:
-
setHeader
Description 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 interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- 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:
-
addHeader
Description 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 interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- 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:
-
setIntHeader
Description 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 interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- the assigned integer value- See Also:
-
addIntHeader
Description 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 interfaceHttpServletResponse- Parameters:
name- the name of the headervalue- the assigned integer value- See Also:
-
setStatus
public void setStatus(int sc) 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 interfaceHttpServletResponse- Parameters:
sc- the status code- See Also:
-
setStatus
Description copied from interface:javax.servlet.http.HttpServletResponseSets the status code and message for this response.- Specified by:
setStatusin interfaceHttpServletResponse- Parameters:
sc- the status codesm- the status message
-
getContentType
Description 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 interfaceServletResponse- Returns:
- a
Stringspecifying the content type, for example,text/html; charset=UTF-8, or null
-
setCharacterEncoding
Description 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 interfaceServletResponse- Parameters:
encoding- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)- See Also:
-
getStatus
public int getStatus()Description copied from interface:javax.servlet.http.HttpServletResponseGet the HTTP status code for this Response.- Specified by:
getStatusin interfaceHttpServletResponse- Returns:
- The HTTP status code for this Response
-
getHeader
Description 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 interfaceHttpServletResponse- 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 .
-
getHeaderNames
Description copied from interface:javax.servlet.http.HttpServletResponseGet the header names set for this HTTP response.- Specified by:
getHeaderNamesin interfaceHttpServletResponse- Returns:
- The header names set for this HTTP response.
-
getHeaders
Description copied from interface:javax.servlet.http.HttpServletResponseReturn a Collection of all the header values associated with the specified header name.- Specified by:
getHeadersin interfaceHttpServletResponse- 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.
-
setTrailerFields
Description 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 interfaceHttpServletResponse- Parameters:
supplier- The supplier for the trailer headers
-
getTrailerFields
Description copied from interface:javax.servlet.http.HttpServletResponseObtain the supplier of the trailer headers.
The default implementation returns null.- Specified by:
getTrailerFieldsin interfaceHttpServletResponse- Returns:
- The supplier for the trailer headers
-