Class MockHttpServletResponse
- java.lang.Object
- org.springframework.mock.web.MockHttpServletResponse
- All Implemented Interfaces:
HttpServletResponse
,ServletResponse
public class MockHttpServletResponse extends Object implements HttpServletResponse
Mock implementation of theHttpServletResponse
interface.As of Spring Framework 5.0, this set of mocks is designed on a Servlet 4.0 baseline.
- Since:
- 1.0.2
- Author:
- Juergen Hoeller, Rod Johnson, Brian Clozel, Vedran Pavic, Sebastien Deleuze, Sam Brannen
Field Summary
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
Constructors Constructor Description MockHttpServletResponse()
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addCookie(Cookie cookie)
Adds the specified cookie to the response.void
addDateHeader(String name, long value)
Adds a response header with the given name and date-value.void
addHeader(String name, String value)
Adds a response header with the given name and value.void
addIncludedUrl(String includedUrl)
void
addIntHeader(String name, int value)
Adds a response header with the given name and integer value.boolean
containsHeader(String name)
Returns a boolean indicating whether the named response header has already been set.String
encodeRedirectUrl(String url)
Deprecated.String
encodeRedirectURL(String url)
The default implementation delegates toencodeURL(java.lang.String)
, returning the given URL String as-is.String
encodeUrl(String url)
Deprecated.String
encodeURL(String url)
The default implementation returns the given URL String as-is.void
flushBuffer()
Forces any content in the buffer to be written to the client.int
getBufferSize()
Returns the actual buffer size used for the response.String
getCharacterEncoding()
Returns the name of the character encoding (MIME charset) used for the body sent in this response.byte[]
getContentAsByteArray()
String
getContentAsString()
Get the content of the response body as aString
, using the charset specified for the response by the application, either throughHttpServletResponse
methods or through a charset parameter on theContent-Type
.String
getContentAsString(Charset fallbackCharset)
Get the content of the response body as aString
, using the providedfallbackCharset
if no charset has been explicitly defined and otherwise using the charset specified for the response by the application, either throughHttpServletResponse
methods or through a charset parameter on theContent-Type
.int
getContentLength()
long
getContentLengthLong()
String
getContentType()
Returns the content type used for the MIME body sent in this response.Cookie
getCookie(String name)
Cookie[]
getCookies()
long
getDateHeader(String name)
String
getErrorMessage()
String
getForwardedUrl()
String
getHeader(String name)
Return the primary value for the given header as a String, if any.Collection<String>
getHeaderNames()
Return the names of all specified headers as a Set of Strings.List<String>
getHeaders(String name)
Return all values for the given header as a List of Strings.Object
getHeaderValue(String name)
Return the primary value for the given header, if any.List<Object>
getHeaderValues(String name)
Return all values for the given header as a List of value objects.String
getIncludedUrl()
List<String>
getIncludedUrls()
Locale
getLocale()
Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)
method.ServletOutputStream
getOutputStream()
Returns aServletOutputStream
suitable for writing binary data in the response.String
getRedirectedUrl()
int
getStatus()
Gets the current status code of this response.PrintWriter
getWriter()
Returns aPrintWriter
object that can send character text to the client.boolean
isCharset()
Return whether the character encoding has been set.boolean
isCommitted()
Returns a boolean indicating if the response has been committed.boolean
isOutputStreamAccessAllowed()
Return whethergetOutputStream()
access is allowed.boolean
isWriterAccessAllowed()
Return whethergetOutputStream()
access is allowed.void
reset()
Clears any data that exists in the buffer as well as the status code, headers.void
resetBuffer()
Clears the content of the underlying buffer in the response without clearing headers or status code.void
sendError(int status)
Sends an error response to the client using the specified status code and clears the buffer.void
sendError(int status, String errorMessage)
Sends an error response to the client using the specified status and clears the buffer.void
sendRedirect(String url)
Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.void
setBufferSize(int bufferSize)
Sets the preferred buffer size for the body of the response.void
setCharacterEncoding(String characterEncoding)
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.void
setCommitted(boolean committed)
void
setContentLength(int contentLength)
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.void
setContentLengthLong(long contentLength)
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.void
setContentType(String contentType)
Sets the content type of the response being sent to the client, if the response has not been committed yet.void
setDateHeader(String name, long value)
Sets a response header with the given name and date-value.void
setForwardedUrl(String forwardedUrl)
void
setHeader(String name, String value)
Sets a response header with the given name and value.void
setIncludedUrl(String includedUrl)
void
setIntHeader(String name, int value)
Sets a response header with the given name and integer value.void
setLocale(Locale locale)
Sets the locale of the response, if the response has not been committed yet.void
setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)
Set whethergetOutputStream()
access is allowed.void
setStatus(int status)
Sets the status code for this response.void
setStatus(int status, String errorMessage)
Deprecated.void
setWriterAccessAllowed(boolean writerAccessAllowed)
Set whethergetWriter()
access is allowed.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.servlet.http.HttpServletResponse
getTrailerFields, setTrailerFields
Constructor Detail
MockHttpServletResponse
public MockHttpServletResponse()
Method Detail
setOutputStreamAccessAllowed
public void setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)
Set whethergetOutputStream()
access is allowed.Default is
true
.
isOutputStreamAccessAllowed
public boolean isOutputStreamAccessAllowed()
Return whethergetOutputStream()
access is allowed.
setWriterAccessAllowed
public void setWriterAccessAllowed(boolean writerAccessAllowed)
Set whethergetWriter()
access is allowed.Default is
true
.
isWriterAccessAllowed
public boolean isWriterAccessAllowed()
Return whethergetOutputStream()
access is allowed.
isCharset
public boolean isCharset()
Return whether the character encoding has been set.If
false
,getCharacterEncoding()
will return a default encoding value.
setCharacterEncoding
public void setCharacterEncoding(String characterEncoding)
Description copied from interface:javax.servlet.ServletResponse
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the response character encoding has already been set by theServletContext.setResponseCharacterEncoding(java.lang.String)
, deployment descriptor, or using the setContentType() or setLocale() methods, the value set in this method overrides any of those values. CallingServletResponse.setContentType(java.lang.String)
with theString
oftext/html
and calling this method with theString
ofUTF-8
is equivalent with callingsetContentType
with theString
oftext/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
getWriter
has 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-Type
header 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:
setCharacterEncoding
in interfaceServletResponse
- Parameters:
characterEncoding
- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)- See Also:
ServletResponse.setContentType(java.lang.String)
,ServletResponse.setLocale(java.util.Locale)
getCharacterEncoding
@Nullable public String getCharacterEncoding()
Description copied from interface:javax.servlet.ServletResponse
Returns the name of the character encoding (MIME charset) used for the body sent in this response. The following methods for specifying the response character encoding are consulted, in decreasing order of priority: per request, perweb-app (usingServletContext.setResponseCharacterEncoding(java.lang.String)
, deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration). The first one of these methods that yields a result is returned. Per-request, the charset for the response can be specified explicitly using theServletResponse.setCharacterEncoding(java.lang.String)
andServletResponse.setContentType(java.lang.String)
methods, or implicitly using the setLocale(java.util.Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods aftergetWriter
has 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-1
is returned.See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
- Specified by:
getCharacterEncoding
in interfaceServletResponse
- Returns:
- a
String
specifying the name of the character encoding, for example,UTF-8
getOutputStream
public ServletOutputStream getOutputStream()
Description copied from interface:javax.servlet.ServletResponse
Returns aServletOutputStream
suitable 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, except whenServletResponse.reset()
has been called.- Specified by:
getOutputStream
in interfaceServletResponse
- Returns:
- a
ServletOutputStream
for writing binary data - See Also:
ServletResponse.getWriter()
,ServletResponse.reset()
getWriter
public PrintWriter getWriter() throws UnsupportedEncodingException
Description copied from interface:javax.servlet.ServletResponse
Returns aPrintWriter
object that can send character text to the client. ThePrintWriter
uses 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
),getWriter
updates it toISO-8859-1
.Calling flush() on the
PrintWriter
commits the response.Either this method or
ServletResponse.getOutputStream()
may be called to write the body, not both, except whenServletResponse.reset()
has been called.- Specified by:
getWriter
in interfaceServletResponse
- Returns:
- a
PrintWriter
object that can return character data to the client - Throws:
UnsupportedEncodingException
- if the character encoding returned bygetCharacterEncoding
cannot be used- See Also:
ServletResponse.getOutputStream()
,ServletResponse.setCharacterEncoding(java.lang.String)
,ServletResponse.reset()
getContentAsByteArray
public byte[] getContentAsByteArray()
getContentAsString
public String getContentAsString() throws UnsupportedEncodingException
Get the content of the response body as aString
, using the charset specified for the response by the application, either throughHttpServletResponse
methods or through a charset parameter on theContent-Type
.- Returns:
- the content as a
String
- Throws:
UnsupportedEncodingException
- if the character encoding is not supported- See Also:
getContentAsString(Charset)
getContentAsString
public String getContentAsString(Charset fallbackCharset) throws UnsupportedEncodingException
Get the content of the response body as aString
, using the providedfallbackCharset
if no charset has been explicitly defined and otherwise using the charset specified for the response by the application, either throughHttpServletResponse
methods or through a charset parameter on theContent-Type
.- Returns:
- the content as a
String
- Throws:
UnsupportedEncodingException
- if the character encoding is not supported- Since:
- 5.2
- See Also:
getContentAsString()
setContentLength
public void setContentLength(int contentLength)
Description copied from interface:javax.servlet.ServletResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
setContentLength
in interfaceServletResponse
- Parameters:
contentLength
- an integer specifying the length of the content being returned to the client; sets the Content-Length header
getContentLength
public int getContentLength()
setContentLengthLong
public void setContentLengthLong(long contentLength)
Description copied from interface:javax.servlet.ServletResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- Specified by:
setContentLengthLong
in interfaceServletResponse
- Parameters:
contentLength
- a long specifying the length of the content being returned to the client; sets the Content-Length header
getContentLengthLong
public long getContentLengthLong()
setContentType
public void setContentType(@Nullable String contentType)
Description copied from interface:javax.servlet.ServletResponse
Sets 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 beforegetWriter
is 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
getWriter
has 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-Type
header is used.- Specified by:
setContentType
in interfaceServletResponse
- Parameters:
contentType
- aString
specifying the MIME type of the content- See Also:
ServletResponse.setLocale(java.util.Locale)
,ServletResponse.setCharacterEncoding(java.lang.String)
,ServletResponse.getOutputStream()
,ServletResponse.getWriter()
getContentType
@Nullable public String getContentType()
Description copied from interface:javax.servlet.ServletResponse
Returns 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()
orServletResponse.getWriter()
has been called, the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.- Specified by:
getContentType
in interfaceServletResponse
- Returns:
- a
String
specifying the content type, for example,text/html; charset=UTF-8
, or null
setBufferSize
public void setBufferSize(int bufferSize)
Description copied from interface:javax.servlet.ServletResponse
Sets 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:
setBufferSize
in interfaceServletResponse
- Parameters:
bufferSize
- the preferred buffer size- See Also:
ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
,ServletResponse.reset()
getBufferSize
public int getBufferSize()
Description copied from interface:javax.servlet.ServletResponse
Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.- Specified by:
getBufferSize
in interfaceServletResponse
- Returns:
- the actual buffer size used
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
,ServletResponse.reset()
flushBuffer
public void flushBuffer()
Description copied from interface:javax.servlet.ServletResponse
Forces 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:
flushBuffer
in interfaceServletResponse
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.isCommitted()
,ServletResponse.reset()
resetBuffer
public void resetBuffer()
Description copied from interface:javax.servlet.ServletResponse
Clears 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:
resetBuffer
in interfaceServletResponse
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.isCommitted()
,ServletResponse.reset()
setCommitted
public void setCommitted(boolean committed)
isCommitted
public boolean isCommitted()
Description copied from interface:javax.servlet.ServletResponse
Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.- Specified by:
isCommitted
in interfaceServletResponse
- Returns:
- a boolean indicating if the response has been committed
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.reset()
reset
public void reset()
Description copied from interface:javax.servlet.ServletResponse
Clears any data that exists in the buffer as well as the status code, headers. The state of callingServletResponse.getWriter()
orServletResponse.getOutputStream()
is also cleared. It is legal, for instance, to callServletResponse.getWriter()
,ServletResponse.reset()
and thenServletResponse.getOutputStream()
. IfServletResponse.getWriter()
orServletResponse.getOutputStream()
have been called before this method, then the corrresponding returned Writer or OutputStream will be staled and the behavior of using the stale object is undefined. If the response has been committed, this method throws anIllegalStateException
.- Specified by:
reset
in interfaceServletResponse
- See Also:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
setLocale
public void setLocale(Locale locale)
Description copied from interface:javax.servlet.ServletResponse
Sets 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)
,getWriter
hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains alocale-encoding-mapping-list
element, 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, aftergetWriter
has 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-Language
header, the character encoding as part of theContent-Type
header 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:
setLocale
in interfaceServletResponse
- Parameters:
locale
- the locale of the response- See Also:
ServletResponse.getLocale()
,ServletResponse.setContentType(java.lang.String)
,ServletResponse.setCharacterEncoding(java.lang.String)
getLocale
public Locale getLocale()
Description copied from interface:javax.servlet.ServletResponse
Returns the locale specified for this response using theServletResponse.setLocale(java.util.Locale)
method. Calls made tosetLocale
after the response is committed have no effect. If no locale has been specified, the container's default locale is returned.- Specified by:
getLocale
in interfaceServletResponse
- Returns:
- the Locale for this response.
- See Also:
ServletResponse.setLocale(java.util.Locale)
addCookie
public void addCookie(Cookie cookie)
Description copied from interface:javax.servlet.http.HttpServletResponse
Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.- Specified by:
addCookie
in interfaceHttpServletResponse
- Parameters:
cookie
- the Cookie to return to the client
getCookies
public Cookie[] getCookies()
containsHeader
public boolean containsHeader(String name)
Description copied from interface:javax.servlet.http.HttpServletResponse
Returns a boolean indicating whether the named response header has already been set.- Specified by:
containsHeader
in interfaceHttpServletResponse
- Parameters:
name
- the header name- Returns:
true
if the named response header has already been set;false
otherwise
getHeaderNames
public Collection<String> getHeaderNames()
Return the names of all specified headers as a Set of Strings.As of Servlet 3.0, this method is also defined in
HttpServletResponse
.- Specified by:
getHeaderNames
in interfaceHttpServletResponse
- Returns:
- the
Set
of header nameStrings
, or an emptySet
if none
getHeader
@Nullable public String getHeader(String name)
Return the primary value for the given header as a String, if any. Will return the first value in case of multiple values.As of Servlet 3.0, this method is also defined in
HttpServletResponse
. As of Spring 3.1, it returns a stringified value for Servlet 3.0 compatibility. Consider usinggetHeaderValue(String)
for raw Object access.- Specified by:
getHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the header- Returns:
- the associated header value, or
null
if none
getHeaders
public List<String> getHeaders(String name)
Return all values for the given header as a List of Strings.As of Servlet 3.0, this method is also defined in
HttpServletResponse
. As of Spring 3.1, it returns a List of stringified values for Servlet 3.0 compatibility. Consider usinggetHeaderValues(String)
for raw Object access.- Specified by:
getHeaders
in interfaceHttpServletResponse
- Parameters:
name
- the name of the header- Returns:
- the associated header values, or an empty List if none
getHeaderValue
@Nullable public Object getHeaderValue(String name)
Return the primary value for the given header, if any.Will return the first value in case of multiple values.
- Parameters:
name
- the name of the header- Returns:
- the associated header value, or
null
if none
getHeaderValues
public List<Object> getHeaderValues(String name)
Return all values for the given header as a List of value objects.- Parameters:
name
- the name of the header- Returns:
- the associated header values, or an empty List if none
encodeURL
public String encodeURL(String url)
The default implementation returns the given URL String as-is.Can be overridden in subclasses, appending a session id or the like.
- Specified by:
encodeURL
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
encodeRedirectURL
public String encodeRedirectURL(String url)
The default implementation delegates toencodeURL(java.lang.String)
, returning the given URL String as-is.Can be overridden in subclasses, appending a session id or the like in a redirect-specific fashion. For general URL encoding rules, override the common
encodeURL(java.lang.String)
method instead, applying to redirect URLs as well as to general URLs.- Specified by:
encodeRedirectURL
in interfaceHttpServletResponse
- 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 String encodeUrl(String url)
Deprecated.- Specified by:
encodeUrl
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
encodeRedirectUrl
@Deprecated public String encodeRedirectUrl(String url)
Deprecated.- Specified by:
encodeRedirectUrl
in interfaceHttpServletResponse
- Parameters:
url
- the url to be encoded.- Returns:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
sendError
public void sendError(int status, String errorMessage) throws IOException
Description copied from interface:javax.servlet.http.HttpServletResponse
Sends an error response to the client using the specified status and clears the 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". The caller is not responsible for escaping or re-encoding the message to ensure it is safe with respect to the current response encoding and content type. This aspect of safety is the responsibility of the container, as it is generating the error page containing the message. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response.
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 and the msg parameter will be ignored.
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:
sendError
in interfaceHttpServletResponse
- Parameters:
status
- the error status codeerrorMessage
- the descriptive message- Throws:
IOException
- If an input or output exception occurs
sendError
public void sendError(int status) throws IOException
Description copied from interface:javax.servlet.http.HttpServletResponse
Sends an error response to the client using the specified status code and clears the buffer. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back the error pageIf 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:
sendError
in interfaceHttpServletResponse
- Parameters:
status
- the error status code- Throws:
IOException
- If an input or output exception occurs
sendRedirect
public void sendRedirect(String url) throws IOException
Description copied from interface:javax.servlet.http.HttpServletResponse
Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer. The buffer will be replaced with the data set by this method. Calling this method sets the status code toHttpServletResponse.SC_FOUND
302 (Found). This method can accept relative URLs;the servlet container must convert the relative URL to an absolute URL before sending the response to the client. 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:
sendRedirect
in interfaceHttpServletResponse
- Parameters:
url
- the redirect location URL- Throws:
IOException
- If an input or output exception occurs
getRedirectedUrl
@Nullable public String getRedirectedUrl()
setDateHeader
public void setDateHeader(String name, long value)
Description copied from interface:javax.servlet.http.HttpServletResponse
Sets 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. ThecontainsHeader
method can be used to test for the presence of a header before setting its value.- Specified by:
setDateHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the header to setvalue
- the assigned date value- See Also:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addDateHeader(java.lang.String, long)
addDateHeader
public void addDateHeader(String name, long value)
Description copied from interface:javax.servlet.http.HttpServletResponse
Adds 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:
addDateHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the header to setvalue
- the additional date value- See Also:
HttpServletResponse.setDateHeader(java.lang.String, long)
getDateHeader
public long getDateHeader(String name)
setHeader
public void setHeader(String name, String value)
Description copied from interface:javax.servlet.http.HttpServletResponse
Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeader
method can be used to test for the presence of a header before setting its value.- Specified by:
setHeader
in 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:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addHeader(java.lang.String, java.lang.String)
addHeader
public void addHeader(String name, String value)
Description copied from interface:javax.servlet.http.HttpServletResponse
Adds a response header with the given name and value. This method allows response headers to have multiple values.- Specified by:
addHeader
in 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:
HttpServletResponse.setHeader(java.lang.String, java.lang.String)
setIntHeader
public void setIntHeader(String name, int value)
Description copied from interface:javax.servlet.http.HttpServletResponse
Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. ThecontainsHeader
method can be used to test for the presence of a header before setting its value.- Specified by:
setIntHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the headervalue
- the assigned integer value- See Also:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addIntHeader(java.lang.String, int)
addIntHeader
public void addIntHeader(String name, int value)
Description copied from interface:javax.servlet.http.HttpServletResponse
Adds a response header with the given name and integer value. This method allows response headers to have multiple values.- Specified by:
addIntHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name of the headervalue
- the assigned integer value- See Also:
HttpServletResponse.setIntHeader(java.lang.String, int)
setStatus
public void setStatus(int status)
Description copied from interface:javax.servlet.http.HttpServletResponse
Sets 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 SC_OK or SC_MOVED_TEMPORARILY status codes).
If this method is used to set an error code, then the container's error page mechanism will not be triggered. If there is an error and the caller wishes to invoke an error page defined in the web application, then
HttpServletResponse.sendError(int, java.lang.String)
must be used instead.This method preserves any cookies and other response headers.
Valid status codes are those in the 2XX, 3XX, 4XX, and 5XX ranges. Other status codes are treated as container specific.
- Specified by:
setStatus
in interfaceHttpServletResponse
- Parameters:
status
- the status code- See Also:
HttpServletResponse.sendError(int, java.lang.String)
setStatus
@Deprecated public void setStatus(int status, String errorMessage)
Deprecated.- Specified by:
setStatus
in interfaceHttpServletResponse
- Parameters:
status
- the status codeerrorMessage
- the status message
getStatus
public int getStatus()
Description copied from interface:javax.servlet.http.HttpServletResponse
Gets the current status code of this response.- Specified by:
getStatus
in interfaceHttpServletResponse
- Returns:
- the current status code of this response
getErrorMessage
@Nullable public String getErrorMessage()
setForwardedUrl
public void setForwardedUrl(@Nullable String forwardedUrl)
getForwardedUrl
@Nullable public String getForwardedUrl()
setIncludedUrl
public void setIncludedUrl(@Nullable String includedUrl)
getIncludedUrl
@Nullable public String getIncludedUrl()
addIncludedUrl
public void addIncludedUrl(String includedUrl)
getIncludedUrls
public List<String> getIncludedUrls()