MockHttpServletResponse (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

org.springframework.mock.web
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 the HttpServletResponse interface. Supports the Servlet 2.4 API level.

Used for testing the web framework; also useful for testing application controllers.

Since:

1.0.2

Author:

Juergen Hoeller, Rod Johnson

Field Summary
static int	DEFAULT_SERVER_PORT

 

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
MockHttpServletResponse()

 

Method Summary
void	addCookie(Cookie cookie)
void	addDateHeader(String name, long value)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
boolean	containsHeader(String name)
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url)
String	encodeUrl(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
byte[]	getContentAsByteArray()
String	getContentAsString()
int	getContentLength()
String	getContentType()
Cookie	getCookie(String name)
Cookie[]	getCookies()
String	getErrorMessage()
String	getForwardedUrl()
Object	getHeader(String name)           Return the primary value for the given header, if any.
Set	getHeaderNames()           Return the names of all specified headers as a Set of Strings.
List	getHeaders(String name)           Return all values for the given header as a List of value objects.
String	getIncludedUrl()
Locale	getLocale()
ServletOutputStream	getOutputStream()
String	getRedirectedUrl()
int	getStatus()
PrintWriter	getWriter()
boolean	isCommitted()
boolean	isOutputStreamAccessAllowed()           Return whether getOutputStream() access is allowed.
boolean	isWriterAccessAllowed()           Return whether getOutputStream() access is allowed.
void	reset()
void	resetBuffer()
void	sendError(int status)
void	sendError(int status, String errorMessage)
void	sendRedirect(String url)
void	setBufferSize(int bufferSize)
void	setCharacterEncoding(String characterEncoding)
void	setCommitted(boolean committed)
void	setContentLength(int contentLength)
void	setContentType(String contentType)
void	setDateHeader(String name, long value)
void	setForwardedUrl(String forwardedUrl)
void	setHeader(String name, String value)
void	setIncludedUrl(String includedUrl)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
void	setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)           Set whether getOutputStream() access is allowed.
void	setStatus(int status)
void	setStatus(int status, String errorMessage)
void	setWriterAccessAllowed(boolean writerAccessAllowed)           Set whether getWriter() access is allowed.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

DEFAULT_SERVER_PORT

public static final int DEFAULT_SERVER_PORT

See Also:

Constant Field Values

MockHttpServletResponse

public MockHttpServletResponse()

setOutputStreamAccessAllowed

public void setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)

Set whether getOutputStream() access is allowed.

Default is true.

isOutputStreamAccessAllowed

public boolean isOutputStreamAccessAllowed()

Return whether getOutputStream() access is allowed.

setWriterAccessAllowed

public void setWriterAccessAllowed(boolean writerAccessAllowed)

Set whether getWriter() access is allowed.

Default is true.

isWriterAccessAllowed

public boolean isWriterAccessAllowed()

Return whether getOutputStream() access is allowed.

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

Specified by:

setCharacterEncoding in interface ServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getOutputStream

public ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface ServletResponse

getWriter

public PrintWriter getWriter()
                      throws UnsupportedEncodingException

Specified by:

getWriter in interface ServletResponse

Throws:

UnsupportedEncodingException

getContentAsByteArray

public byte[] getContentAsByteArray()

getContentAsString

public String getContentAsString()
                          throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

setContentLength

public void setContentLength(int contentLength)

Specified by:

setContentLength in interface ServletResponse

getContentLength

public int getContentLength()

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

setBufferSize

public void setBufferSize(int bufferSize)

Specified by:

setBufferSize in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()

Specified by:

flushBuffer in interface ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

setCommitted

public void setCommitted(boolean committed)

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

getCookies

public Cookie[] getCookies()

getCookie

public Cookie getCookie(String name)

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HttpServletResponse

getHeaderNames

public Set getHeaderNames()

Return the names of all specified headers as a Set of Strings.

Returns:

the Set of header name Strings, or an empty Set if none

getHeader

public Object getHeader(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

public List getHeaders(String name)

public String encodeURL(String url)

public String encodeRedirectURL(String url)

public String encodeUrl(String url)

public String encodeRedirectUrl(String url)

public void sendError(int status,
                      String errorMessage)
               throws IOException

public void sendError(int status)
               throws IOException

public void sendRedirect(String url)
                  throws IOException

public String getRedirectedUrl()

public void setDateHeader(String name,
                          long value)

public void addDateHeader(String name,
                          long value)

public void setHeader(String name,
                      String value)

public void addHeader(String name,
                      String value)

public void setIntHeader(String name,
                         int value)

public void addIntHeader(String name,
                         int value)

public void setStatus(int status)

public void setStatus(int status,
                      String errorMessage)

public int getStatus()

public String getErrorMessage()

public void setForwardedUrl(String forwardedUrl)

public String getForwardedUrl()

public void setIncludedUrl(String includedUrl)

public String getIncludedUrl()