public class HttpServletResponseWrapper extends ServletResponseWrapper implements HttpServletResponse
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 and Description |
---|
HttpServletResponseWrapper(HttpServletResponse response)
Constructs a response adaptor wrapping the given response.
|
Modifier and Type | Method and Description |
---|---|
void |
addCookie(Cookie cookie)
The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.
|
void |
addDateHeader(String name,
long date)
The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
|
void |
addHeader(String name,
String value)
The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
|
void |
addIntHeader(String name,
int value)
The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
|
boolean |
containsHeader(String name)
The default behavior of this method is to call containsHeader(String name) on the wrapped response object.
|
String |
encodeRedirectUrl(String url)
Deprecated.
As of version 2.1, use
encodeRedirectURL(String url) instead |
String |
encodeRedirectURL(String url)
The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.
|
String |
encodeUrl(String url)
Deprecated.
As of version 2.1, use
encodeURL(String url) instead |
String |
encodeURL(String url)
The default behavior of this method is to call encodeURL(String url) on the wrapped response object.
|
String |
getHeader(String name)
The default behaviour of this method is to call
HttpServletResponse.getHeader(java.lang.String) on the wrapped response object. |
Collection<String> |
getHeaderNames()
The default behaviour of this method is to call
HttpServletResponse.getHeaderNames() on the wrapped response
object. |
Collection<String> |
getHeaders(String name)
The default behaviour of this method is to call
HttpServletResponse.getHeaders(java.lang.String) on the wrapped response
object. |
int |
getStatus()
The default behaviour of this method is to call
HttpServletResponse.getStatus() on the wrapped response object. |
Supplier<Map<String,String>> |
getTrailerFields()
The default behaviour of this method is to call
HttpServletResponse.getTrailerFields() on the wrapped response
object. |
void |
sendError(int sc)
The default behavior of this method is to call sendError(int sc) on the wrapped response object.
|
void |
sendError(int sc,
String msg)
The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
|
void |
sendRedirect(String location)
The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.
|
void |
setDateHeader(String name,
long date)
The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
|
void |
setHeader(String name,
String value)
The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
|
void |
setIntHeader(String name,
int value)
The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
|
void |
setStatus(int sc)
The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
|
void |
setStatus(int sc,
String sm)
Deprecated.
As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use
setStatus(int) , to send an error with a description use sendError(int, String) |
void |
setTrailerFields(Supplier<Map<String,String>> supplier)
The default behaviour of this method is to call
HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>) on the wrapped response
object. |
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
public HttpServletResponseWrapper(HttpServletResponse response)
response
- the HttpServletResponse
to be wrapped.IllegalArgumentException
- if the response is nullpublic void addCookie(Cookie cookie)
addCookie
in interface HttpServletResponse
cookie
- the Cookie to return to the clientpublic boolean containsHeader(String name)
containsHeader
in interface HttpServletResponse
name
- the header nametrue
if the named response header has already been set; false
otherwisepublic String encodeURL(String url)
encodeURL
in interface HttpServletResponse
url
- the url to be encoded.public String encodeRedirectURL(String url)
encodeRedirectURL
in interface HttpServletResponse
url
- the url to be encoded.HttpServletResponse.sendRedirect(java.lang.String)
,
HttpServletResponse.encodeUrl(java.lang.String)
@Deprecated public String encodeUrl(String url)
encodeURL(String url)
insteadencodeUrl
in interface HttpServletResponse
url
- the url to be encoded.@Deprecated public String encodeRedirectUrl(String url)
encodeRedirectURL(String url)
insteadencodeRedirectUrl
in interface HttpServletResponse
url
- the url to be encoded.public void sendError(int sc, String msg) throws IOException
sendError
in interface HttpServletResponse
sc
- the error status codemsg
- the descriptive messageIOException
- If an input or output exception occurspublic void sendError(int sc) throws IOException
sendError
in interface HttpServletResponse
sc
- the error status codeIOException
- If an input or output exception occurspublic void sendRedirect(String location) throws IOException
sendRedirect
in interface HttpServletResponse
location
- the redirect location URLIOException
- If an input or output exception occurspublic void setDateHeader(String name, long date)
setDateHeader
in interface HttpServletResponse
name
- the name of the header to setdate
- the assigned date valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addDateHeader(java.lang.String, long)
public void addDateHeader(String name, long date)
addDateHeader
in interface HttpServletResponse
name
- the name of the header to setdate
- the additional date valueHttpServletResponse.setDateHeader(java.lang.String, long)
public void setHeader(String name, String value)
setHeader
in interface HttpServletResponse
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)HttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addHeader(java.lang.String, java.lang.String)
public void addHeader(String name, String value)
addHeader
in interface HttpServletResponse
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)HttpServletResponse.setHeader(java.lang.String, java.lang.String)
public void setIntHeader(String name, int value)
setIntHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the assigned integer valueHttpServletResponse.containsHeader(java.lang.String)
,
HttpServletResponse.addIntHeader(java.lang.String, int)
public void addIntHeader(String name, int value)
addIntHeader
in interface HttpServletResponse
name
- the name of the headervalue
- the assigned integer valueHttpServletResponse.setIntHeader(java.lang.String, int)
public void setStatus(int sc)
setStatus
in interface HttpServletResponse
sc
- the status codeHttpServletResponse.sendError(int, java.lang.String)
@Deprecated public void setStatus(int sc, String sm)
setStatus(int)
, to send an error with a description use sendError(int, String)
setStatus
in interface HttpServletResponse
sc
- the status codesm
- the status messagepublic int getStatus()
HttpServletResponse.getStatus()
on the wrapped response object.getStatus
in interface HttpServletResponse
public String getHeader(String name)
HttpServletResponse.getHeader(java.lang.String)
on the wrapped response object.getHeader
in interface HttpServletResponse
name
- the name of the response header whose value to returnpublic Collection<String> getHeaders(String name)
HttpServletResponse.getHeaders(java.lang.String)
on the wrapped response
object.
Any changes to the returned Collection
must not affect this HttpServletResponseWrapper
.
getHeaders
in interface HttpServletResponse
name
- the name of the response header whose values to returnCollection
of the values of the response header with the given namepublic Collection<String> getHeaderNames()
HttpServletResponse.getHeaderNames()
on the wrapped response
object.
Any changes to the returned Collection
must not affect this HttpServletResponseWrapper
.
getHeaderNames
in interface HttpServletResponse
Collection
of the names of the response headerspublic void setTrailerFields(Supplier<Map<String,String>> supplier)
HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>)
on the wrapped response
object.setTrailerFields
in interface HttpServletResponse
supplier
- of trailer headerspublic Supplier<Map<String,String>> getTrailerFields()
HttpServletResponse.getTrailerFields()
on the wrapped response
object.getTrailerFields
in interface HttpServletResponse
Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.