Package jakarta.servlet.http
Class HttpServletResponseWrapper
java.lang.Object
jakarta.servlet.ServletResponseWrapper
jakarta.servlet.http.HttpServletResponseWrapper
- All Implemented Interfaces:
- HttpServletResponse,- ServletResponse
public class HttpServletResponseWrapper
extends ServletResponseWrapper
implements HttpServletResponse
Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers
 wishing to adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default
 to calling through to the wrapped response object.
- Since:
- Servlet 2.3
- See Also:
- 
Field SummaryFields 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 SummaryConstructorsConstructorDescriptionConstructs a response adaptor wrapping the given response.
- 
Method SummaryModifier and TypeMethodDescriptionvoidThe default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.voidaddDateHeader(String name, long date) The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.voidThe default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.voidaddIntHeader(String name, int value) The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.booleancontainsHeader(String name) The default behavior of this method is to call containsHeader(String name) on the wrapped response object.encodeRedirectURL(String url) The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.The default behavior of this method is to call encodeURL(String url) on the wrapped response object.Return 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.intGet the HTTP status code for this Response.Obtain the supplier of the trailer headers.voidsendError(int sc) The default behavior of this method is to call sendError(int sc) on the wrapped response object.voidThe default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.voidsendRedirect(String location) The default behavior of this method is to call sendRedirect(String location) on the wrapped response object.voidsetDateHeader(String name, long date) The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.voidThe default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.voidsetIntHeader(String name, int value) The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.voidsetStatus(int sc) The default behavior of this method is to call setStatus(int sc) on the wrapped response object.voidsetTrailerFields(Supplier<Map<String, String>> supplier) Configure the supplier of the trailer headers.Methods inherited from class jakarta.servlet.ServletResponseWrapperflushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponseMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.servlet.ServletResponseflushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
- 
Constructor Details- 
HttpServletResponseWrapperConstructs a response adaptor wrapping the given response.- Parameters:
- response- The response to be wrapped
- Throws:
- IllegalArgumentException- if the response is null
 
 
- 
- 
Method Details- 
addCookieThe default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.- Specified by:
- addCookiein interface- HttpServletResponse
- Parameters:
- cookie- the Cookie to return to the client
 
- 
containsHeaderThe default behavior of this method is to call containsHeader(String name) on the wrapped response object.- Specified by:
- containsHeaderin interface- HttpServletResponse
- Parameters:
- name- the header name
- Returns:
- trueif the named response header has already been set;- falseotherwise
 
- 
encodeURLThe default behavior of this method is to call encodeURL(String url) on the wrapped response object.- Specified by:
- encodeURLin interface- HttpServletResponse
- Parameters:
- url- the url to be encoded.
- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
 
- 
encodeRedirectURLThe default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.- 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:
 
- 
sendErrorThe default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.- Specified by:
- sendErrorin interface- HttpServletResponse
- Parameters:
- sc- the error status code
- msg- the descriptive message
- Throws:
- IOException- If an input or output exception occurs
 
- 
sendErrorThe default behavior of this method is to call sendError(int sc) on the wrapped response object.- Specified by:
- sendErrorin interface- HttpServletResponse
- Parameters:
- sc- the error status code
- Throws:
- IOException- If an input or output exception occurs
 
- 
sendRedirectThe default behavior of this method is to call sendRedirect(String location) on the wrapped response object.- 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
 
- 
setDateHeaderThe default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.- Specified by:
- setDateHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header to set
- date- the assigned date value
- See Also:
 
- 
addDateHeaderThe default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.- Specified by:
- addDateHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header to set
- date- the additional date value
- See Also:
 
- 
setHeaderThe default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.- 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:
 
- 
addHeaderThe default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.- 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:
 
- 
setIntHeaderThe default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.- Specified by:
- setIntHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header
- value- the assigned integer value
- See Also:
 
- 
addIntHeaderThe default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.- Specified by:
- addIntHeaderin interface- HttpServletResponse
- Parameters:
- name- the name of the header
- value- the assigned integer value
- See Also:
 
- 
setStatuspublic void setStatus(int sc) The default behavior of this method is to call setStatus(int sc) on the wrapped response object.- Specified by:
- setStatusin interface- HttpServletResponse
- Parameters:
- sc- the status code
- See Also:
 
- 
getStatuspublic int getStatus()Get the HTTP status code for this Response.The default implementation is to call HttpServletResponse.getStatus()on the wrappedHttpServletResponse.- Specified by:
- getStatusin interface- HttpServletResponse
- Returns:
- The HTTP status code for this Response
- Since:
- Servlet 3.0
 
- 
getHeaderReturn 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.The default implementation is to call HttpServletResponse.getHeader(String)on the wrappedHttpServletResponse.- 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 .
- Since:
- Servlet 3.0
 
- 
getHeadersReturn a Collection of all the header values associated with the specified header name.The default implementation is to call HttpServletResponse.getHeaders(String)on the wrappedHttpServletResponse.- 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.
- Since:
- Servlet 3.0
 
- 
getHeaderNamesGet the header names set for this HTTP response.The default implementation is to call HttpServletResponse.getHeaderNames()on the wrappedHttpServletResponse.- Specified by:
- getHeaderNamesin interface- HttpServletResponse
- Returns:
- The header names set for this HTTP response.
- Since:
- Servlet 3.0
 
- 
setTrailerFieldsConfigure 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.The default implementation is to call HttpServletResponse.setTrailerFields(Supplier)on the wrappedHttpServletResponse.- Specified by:
- setTrailerFieldsin interface- HttpServletResponse
- Parameters:
- supplier- The supplier for the trailer headers
- Since:
- Servlet 4.0
 
- 
getTrailerFieldsObtain the supplier of the trailer headers.
 The default implementation returns null.The default implementation is to call HttpServletResponse.getTrailerFields()on the wrappedHttpServletResponse.- Specified by:
- getTrailerFieldsin interface- HttpServletResponse
- Returns:
- The supplier for the trailer headers
- Since:
- Servlet 4.0
 
 
-