类 MockHttpServletResponse
- java.lang.Object
- org.springframework.mock.web.MockHttpServletResponse
- 所有已实现的接口:
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.
- 从以下版本开始:
- 1.0.2
- 作者:
- Juergen Hoeller, Rod Johnson, Brian Clozel, Vedran Pavic, Sebastien Deleuze, Sam Brannen
字段概要
从接口继承的字段 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
构造器概要
构造器 构造器 说明 MockHttpServletResponse()
方法概要
所有方法 实例方法 具体方法 已过时的方法 修饰符和类型 方法 说明 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)
已过时。String
encodeRedirectURL(String url)
The default implementation delegates toencodeURL(java.lang.String)
, returning the given URL String as-is.String
encodeUrl(String url)
已过时。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)
已过时。void
setWriterAccessAllowed(boolean writerAccessAllowed)
Set whethergetWriter()
access is allowed.从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 javax.servlet.http.HttpServletResponse
getTrailerFields, setTrailerFields
构造器详细资料
MockHttpServletResponse
public MockHttpServletResponse()
方法详细资料
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)
从接口复制的说明: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.- 指定者:
setCharacterEncoding
在接口中ServletResponse
- 参数:
characterEncoding
- a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)- 另请参阅:
ServletResponse.setContentType(java.lang.String)
,ServletResponse.setLocale(java.util.Locale)
getCharacterEncoding
@Nullable public String getCharacterEncoding()
从接口复制的说明: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.
- 指定者:
getCharacterEncoding
在接口中ServletResponse
- 返回:
- a
String
specifying the name of the character encoding, for example,UTF-8
getOutputStream
public ServletOutputStream getOutputStream()
从接口复制的说明: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.- 指定者:
getOutputStream
在接口中ServletResponse
- 返回:
- a
ServletOutputStream
for writing binary data - 另请参阅:
ServletResponse.getWriter()
,ServletResponse.reset()
getWriter
public PrintWriter getWriter() throws UnsupportedEncodingException
从接口复制的说明: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.- 指定者:
getWriter
在接口中ServletResponse
- 返回:
- a
PrintWriter
object that can return character data to the client - 抛出:
UnsupportedEncodingException
- if the character encoding returned bygetCharacterEncoding
cannot be used- 另请参阅:
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
.- 返回:
- the content as a
String
- 抛出:
UnsupportedEncodingException
- if the character encoding is not supported- 另请参阅:
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
.- 返回:
- the content as a
String
- 抛出:
UnsupportedEncodingException
- if the character encoding is not supported- 从以下版本开始:
- 5.2
- 另请参阅:
getContentAsString()
setContentLength
public void setContentLength(int contentLength)
从接口复制的说明:javax.servlet.ServletResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- 指定者:
setContentLength
在接口中ServletResponse
- 参数:
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)
从接口复制的说明:javax.servlet.ServletResponse
Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.- 指定者:
setContentLengthLong
在接口中ServletResponse
- 参数:
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)
从接口复制的说明: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.- 指定者:
setContentType
在接口中ServletResponse
- 参数:
contentType
- aString
specifying the MIME type of the content- 另请参阅:
ServletResponse.setLocale(java.util.Locale)
,ServletResponse.setCharacterEncoding(java.lang.String)
,ServletResponse.getOutputStream()
,ServletResponse.getWriter()
getContentType
@Nullable public String getContentType()
从接口复制的说明: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.- 指定者:
getContentType
在接口中ServletResponse
- 返回:
- a
String
specifying the content type, for example,text/html; charset=UTF-8
, or null
setBufferSize
public void setBufferSize(int bufferSize)
从接口复制的说明: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
.- 指定者:
setBufferSize
在接口中ServletResponse
- 参数:
bufferSize
- the preferred buffer size- 另请参阅:
ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
,ServletResponse.reset()
getBufferSize
public int getBufferSize()
从接口复制的说明:javax.servlet.ServletResponse
Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.- 指定者:
getBufferSize
在接口中ServletResponse
- 返回:
- the actual buffer size used
- 另请参阅:
ServletResponse.setBufferSize(int)
,ServletResponse.flushBuffer()
,ServletResponse.isCommitted()
,ServletResponse.reset()
flushBuffer
public void flushBuffer()
从接口复制的说明: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.
resetBuffer
public void resetBuffer()
从接口复制的说明: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
.
setCommitted
public void setCommitted(boolean committed)
isCommitted
public boolean isCommitted()
从接口复制的说明: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.- 指定者:
isCommitted
在接口中ServletResponse
- 返回:
- a boolean indicating if the response has been committed
- 另请参阅:
ServletResponse.setBufferSize(int)
,ServletResponse.getBufferSize()
,ServletResponse.flushBuffer()
,ServletResponse.reset()
reset
public void reset()
从接口复制的说明: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
.
setLocale
public void setLocale(Locale locale)
从接口复制的说明: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.- 指定者:
setLocale
在接口中ServletResponse
- 参数:
locale
- the locale of the response- 另请参阅:
ServletResponse.getLocale()
,ServletResponse.setContentType(java.lang.String)
,ServletResponse.setCharacterEncoding(java.lang.String)
getLocale
public Locale getLocale()
从接口复制的说明: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.- 指定者:
getLocale
在接口中ServletResponse
- 返回:
- the Locale for this response.
- 另请参阅:
ServletResponse.setLocale(java.util.Locale)
addCookie
public void addCookie(Cookie cookie)
从接口复制的说明:javax.servlet.http.HttpServletResponse
Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.- 指定者:
addCookie
在接口中HttpServletResponse
- 参数:
cookie
- the Cookie to return to the client
getCookies
public Cookie[] getCookies()
containsHeader
public boolean containsHeader(String name)
从接口复制的说明:javax.servlet.http.HttpServletResponse
Returns a boolean indicating whether the named response header has already been set.- 指定者:
containsHeader
在接口中HttpServletResponse
- 参数:
name
- the header name- 返回:
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
.- 指定者:
getHeaderNames
在接口中HttpServletResponse
- 返回:
- 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.- 指定者:
getHeader
在接口中HttpServletResponse
- 参数:
name
- the name of the header- 返回:
- 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.- 指定者:
getHeaders
在接口中HttpServletResponse
- 参数:
name
- the name of the header- 返回:
- 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.
- 参数:
name
- the name of the header- 返回:
- 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.- 参数:
name
- the name of the header- 返回:
- 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.
- 指定者:
encodeURL
在接口中HttpServletResponse
- 参数:
url
- the url to be encoded.- 返回:
- 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.- 指定者:
encodeRedirectURL
在接口中HttpServletResponse
- 参数:
url
- the url to be encoded.- 返回:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
- 另请参阅:
HttpServletResponse.sendRedirect(java.lang.String)
,HttpServletResponse.encodeUrl(java.lang.String)
encodeUrl
@Deprecated public String encodeUrl(String url)
已过时。- 指定者:
encodeUrl
在接口中HttpServletResponse
- 参数:
url
- the url to be encoded.- 返回:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
encodeRedirectUrl
@Deprecated public String encodeRedirectUrl(String url)
已过时。- 指定者:
encodeRedirectUrl
在接口中HttpServletResponse
- 参数:
url
- the url to be encoded.- 返回:
- the encoded URL if encoding is needed; the unchanged URL otherwise.
sendError
public void sendError(int status, String errorMessage) throws IOException
从接口复制的说明: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.
- 指定者:
sendError
在接口中HttpServletResponse
- 参数:
status
- the error status codeerrorMessage
- the descriptive message- 抛出:
IOException
- If an input or output exception occurs
sendError
public void sendError(int status) throws IOException
从接口复制的说明: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.
- 指定者:
sendError
在接口中HttpServletResponse
- 参数:
status
- the error status code- 抛出:
IOException
- If an input or output exception occurs
sendRedirect
public void sendRedirect(String url) throws IOException
从接口复制的说明: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.
- 指定者:
sendRedirect
在接口中HttpServletResponse
- 参数:
url
- the redirect location URL- 抛出:
IOException
- If an input or output exception occurs
getRedirectedUrl
@Nullable public String getRedirectedUrl()
setDateHeader
public void setDateHeader(String name, long value)
从接口复制的说明: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.- 指定者:
setDateHeader
在接口中HttpServletResponse
- 参数:
name
- the name of the header to setvalue
- the assigned date value- 另请参阅:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addDateHeader(java.lang.String, long)
addDateHeader
public void addDateHeader(String name, long value)
从接口复制的说明: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.- 指定者:
addDateHeader
在接口中HttpServletResponse
- 参数:
name
- the name of the header to setvalue
- the additional date value- 另请参阅:
HttpServletResponse.setDateHeader(java.lang.String, long)
getDateHeader
public long getDateHeader(String name)
setHeader
public void setHeader(String name, String value)
从接口复制的说明: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.- 指定者:
setHeader
在接口中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)
addHeader
public void addHeader(String name, String value)
从接口复制的说明:javax.servlet.http.HttpServletResponse
Adds a response header with the given name and value. This method allows response headers to have multiple values.- 指定者:
addHeader
在接口中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)
setIntHeader
public void setIntHeader(String name, int value)
从接口复制的说明: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.- 指定者:
setIntHeader
在接口中HttpServletResponse
- 参数:
name
- the name of the headervalue
- the assigned integer value- 另请参阅:
HttpServletResponse.containsHeader(java.lang.String)
,HttpServletResponse.addIntHeader(java.lang.String, int)
addIntHeader
public void addIntHeader(String name, int value)
从接口复制的说明:javax.servlet.http.HttpServletResponse
Adds a response header with the given name and integer value. This method allows response headers to have multiple values.- 指定者:
addIntHeader
在接口中HttpServletResponse
- 参数:
name
- the name of the headervalue
- the assigned integer value- 另请参阅:
HttpServletResponse.setIntHeader(java.lang.String, int)
setStatus
public void setStatus(int status)
从接口复制的说明: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.
- 指定者:
setStatus
在接口中HttpServletResponse
- 参数:
status
- the status code- 另请参阅:
HttpServletResponse.sendError(int, java.lang.String)
setStatus
@Deprecated public void setStatus(int status, String errorMessage)
已过时。- 指定者:
setStatus
在接口中HttpServletResponse
- 参数:
status
- the status codeerrorMessage
- the status message
getStatus
public int getStatus()
从接口复制的说明:javax.servlet.http.HttpServletResponse
Gets the current status code of this response.- 指定者:
getStatus
在接口中HttpServletResponse
- 返回:
- 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()