Package javax.servlet.http
Class HttpServletResponseWrapper
- java.lang.Object
- 
- javax.servlet.ServletResponseWrapper
- 
- javax.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:
- HttpServletResponse
 
- 
- 
Field Summary- 
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 Constructor Description HttpServletResponseWrapper(HttpServletResponse response)Constructs a response adaptor wrapping the given response.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddCookie(Cookie cookie)The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.voidaddDateHeader(java.lang.String name, long date)The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.voidaddHeader(java.lang.String name, java.lang.String value)The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.voidaddIntHeader(java.lang.String name, int value)The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.booleancontainsHeader(java.lang.String name)The default behavior of this method is to call containsHeader(String name) on the wrapped response object.java.lang.StringencodeRedirectUrl(java.lang.String url)Deprecated.As of Version 3.0 of the Java Servlet APIjava.lang.StringencodeRedirectURL(java.lang.String url)The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.java.lang.StringencodeUrl(java.lang.String url)Deprecated.As of Version 3.0 of the Java Servlet APIjava.lang.StringencodeURL(java.lang.String url)The default behavior of this method is to call encodeURL(String url) on the wrapped response object.java.lang.StringgetHeader(java.lang.String name)Return the value for the specified header, ornullif this header has not been set.java.util.Collection<java.lang.String>getHeaderNames()Get the header names set for this HTTP response.java.util.Collection<java.lang.String>getHeaders(java.lang.String name)Return a Collection of all the header values associated with the specified header name.intgetStatus()Get the HTTP status code for this Response.java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>>getTrailerFields()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.voidsendError(int sc, java.lang.String msg)The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.voidsendRedirect(java.lang.String location)The default behavior of this method is to call sendRedirect(String location) on the wrapped response object.voidsetDateHeader(java.lang.String name, long date)The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.voidsetHeader(java.lang.String name, java.lang.String value)The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.voidsetIntHeader(java.lang.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.voidsetStatus(int sc, java.lang.String sm)Deprecated.As of Version 3.0 of the Java Servlet APIvoidsetTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> supplier)Configure the supplier of the trailer headers.- 
Methods inherited from class javax.servlet.ServletResponseWrapperflushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface javax.servlet.ServletResponseflushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
 
- 
 
- 
- 
- 
Constructor Detail- 
HttpServletResponseWrapperpublic HttpServletResponseWrapper(HttpServletResponse response) Constructs a response adaptor wrapping the given response.- Parameters:
- response- The response to be wrapped
- Throws:
- java.lang.IllegalArgumentException- if the response is null
 
 
- 
 - 
Method Detail- 
addCookiepublic void addCookie(Cookie cookie) The 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
 
 - 
containsHeaderpublic boolean containsHeader(java.lang.String name) The 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
 
 - 
encodeURLpublic java.lang.String encodeURL(java.lang.String url) The 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.
 
 - 
encodeRedirectURLpublic java.lang.String encodeRedirectURL(java.lang.String url) The 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:
- HttpServletResponse.sendRedirect(java.lang.String),- HttpServletResponse.encodeUrl(java.lang.String)
 
 - 
encodeUrl@Deprecated public java.lang.String encodeUrl(java.lang.String url) Deprecated.As of Version 3.0 of the Java Servlet APIThe 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.
 
 - 
encodeRedirectUrl@Deprecated public java.lang.String encodeRedirectUrl(java.lang.String url) Deprecated.As of Version 3.0 of the Java Servlet APIThe 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.
 
 - 
sendErrorpublic void sendError(int sc, java.lang.String msg) throws java.io.IOExceptionThe 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:
- java.io.IOException- If an input or output exception occurs
 
 - 
sendErrorpublic void sendError(int sc) throws java.io.IOExceptionThe 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:
- java.io.IOException- If an input or output exception occurs
 
 - 
sendRedirectpublic void sendRedirect(java.lang.String location) throws java.io.IOExceptionThe 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:
- java.io.IOException- If an input or output exception occurs
 
 - 
setDateHeaderpublic void setDateHeader(java.lang.String name, long date)The 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:
- HttpServletResponse.containsHeader(java.lang.String),- HttpServletResponse.addDateHeader(java.lang.String, long)
 
 - 
addDateHeaderpublic void addDateHeader(java.lang.String name, long date)The 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:
- HttpServletResponse.setDateHeader(java.lang.String, long)
 
 - 
setHeaderpublic void setHeader(java.lang.String name, java.lang.String value)The 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:
- HttpServletResponse.containsHeader(java.lang.String),- HttpServletResponse.addHeader(java.lang.String, java.lang.String)
 
 - 
addHeaderpublic void addHeader(java.lang.String name, java.lang.String value)The 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:
- HttpServletResponse.setHeader(java.lang.String, java.lang.String)
 
 - 
setIntHeaderpublic void setIntHeader(java.lang.String name, int value)The 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:
- HttpServletResponse.containsHeader(java.lang.String),- HttpServletResponse.addIntHeader(java.lang.String, int)
 
 - 
addIntHeaderpublic void addIntHeader(java.lang.String name, int value)The 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:
- HttpServletResponse.setIntHeader(java.lang.String, int)
 
 - 
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:
- HttpServletResponse.sendError(int, java.lang.String)
 
 - 
setStatus@Deprecated public void setStatus(int sc, java.lang.String sm)Deprecated.As of Version 3.0 of the Java Servlet APIThe default behavior of this method is to call setStatus(int sc, String sm) on the wrapped response object.- Specified by:
- setStatusin interface- HttpServletResponse
- Parameters:
- sc- the status code
- sm- the status message
 
 - 
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
 
 - 
getHeaderpublic java.lang.String getHeader(java.lang.String name) Return 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
 
 - 
getHeaderspublic java.util.Collection<java.lang.String> getHeaders(java.lang.String name) Return 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
 
 - 
getHeaderNamespublic java.util.Collection<java.lang.String> getHeaderNames() Get 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
 
 - 
setTrailerFieldspublic void setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> supplier) Configure 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
 
 - 
getTrailerFieldspublic java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> getTrailerFields() Obtain 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
 
 
- 
 
-