|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.mock.web.MockHttpServletResponse
public class MockHttpServletResponse
Mock implementation of the javax.servlet.http.HttpServletResponse
interface. Supports the Servlet 2.5 API level.
Used for testing the web framework; also useful for testing application controllers.
Nested Class Summary | |
---|---|
private class |
MockHttpServletResponse.ResponsePrintWriter
Inner class that adapts the PrintWriter to mark the response as committed once the buffer size is exceeded. |
private class |
MockHttpServletResponse.ResponseServletOutputStream
Inner class that adapts the ServletOutputStream to mark the response as committed once the buffer size is exceeded. |
Field Summary | |
---|---|
private int |
bufferSize
|
private java.lang.String |
characterEncoding
|
private static java.lang.String |
CHARSET_PREFIX
|
private boolean |
committed
|
private java.io.ByteArrayOutputStream |
content
|
private int |
contentLength
|
private java.lang.String |
contentType
|
private java.util.List<Cookie> |
cookies
|
static int |
DEFAULT_SERVER_PORT
|
private java.lang.String |
errorMessage
|
private java.lang.String |
forwardedUrl
|
private java.util.Map<java.lang.String,HeaderValueHolder> |
headers
|
private java.util.List<java.lang.String> |
includedUrls
|
private java.util.Locale |
locale
|
private ServletOutputStream |
outputStream
|
private boolean |
outputStreamAccessAllowed
|
private java.lang.String |
redirectedUrl
|
private int |
status
|
private java.io.PrintWriter |
writer
|
private boolean |
writerAccessAllowed
|
Constructor Summary | |
---|---|
MockHttpServletResponse()
|
Method Summary | |
---|---|
void |
addCookie(Cookie cookie)
|
void |
addDateHeader(java.lang.String name,
long value)
|
void |
addHeader(java.lang.String name,
java.lang.String value)
|
private void |
addHeaderValue(java.lang.String name,
java.lang.Object value)
|
void |
addIncludedUrl(java.lang.String includedUrl)
|
void |
addIntHeader(java.lang.String name,
int value)
|
boolean |
containsHeader(java.lang.String name)
|
private void |
doAddHeaderValue(java.lang.String name,
java.lang.Object value,
boolean replace)
|
java.lang.String |
encodeRedirectUrl(java.lang.String url)
|
java.lang.String |
encodeRedirectURL(java.lang.String url)
The default implementation delegates to encodeURL(java.lang.String) ,
returning the given URL String as-is. |
java.lang.String |
encodeUrl(java.lang.String url)
|
java.lang.String |
encodeURL(java.lang.String url)
The default implementation returns the given URL String as-is. |
void |
flushBuffer()
|
int |
getBufferSize()
|
java.lang.String |
getCharacterEncoding()
|
byte[] |
getContentAsByteArray()
|
java.lang.String |
getContentAsString()
|
int |
getContentLength()
|
java.lang.String |
getContentType()
|
Cookie |
getCookie(java.lang.String name)
|
Cookie[] |
getCookies()
|
java.lang.String |
getErrorMessage()
|
java.lang.String |
getForwardedUrl()
|
java.lang.Object |
getHeader(java.lang.String name)
Return the primary value for the given header, if any. |
java.util.Set<java.lang.String> |
getHeaderNames()
Return the names of all specified headers as a Set of Strings. |
java.util.List<java.lang.Object> |
getHeaders(java.lang.String name)
Return all values for the given header as a List of value objects. |
java.lang.String |
getIncludedUrl()
|
java.util.List<java.lang.String> |
getIncludedUrls()
|
java.util.Locale |
getLocale()
|
ServletOutputStream |
getOutputStream()
|
java.lang.String |
getRedirectedUrl()
|
int |
getStatus()
|
java.io.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,
java.lang.String errorMessage)
|
void |
sendRedirect(java.lang.String url)
|
void |
setBufferSize(int bufferSize)
|
void |
setCharacterEncoding(java.lang.String characterEncoding)
|
void |
setCommitted(boolean committed)
|
private void |
setCommittedIfBufferSizeExceeded()
|
void |
setContentLength(int contentLength)
|
void |
setContentType(java.lang.String contentType)
|
void |
setDateHeader(java.lang.String name,
long value)
|
void |
setForwardedUrl(java.lang.String forwardedUrl)
|
void |
setHeader(java.lang.String name,
java.lang.String value)
|
private void |
setHeaderValue(java.lang.String name,
java.lang.Object value)
|
void |
setIncludedUrl(java.lang.String includedUrl)
|
void |
setIntHeader(java.lang.String name,
int value)
|
void |
setLocale(java.util.Locale locale)
|
void |
setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)
Set whether getOutputStream() access is allowed. |
void |
setStatus(int status)
|
void |
setStatus(int status,
java.lang.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 |
---|
public static final int DEFAULT_SERVER_PORT
private static final java.lang.String CHARSET_PREFIX
private boolean outputStreamAccessAllowed
private boolean writerAccessAllowed
private java.lang.String characterEncoding
private final java.io.ByteArrayOutputStream content
private final ServletOutputStream outputStream
private java.io.PrintWriter writer
private int contentLength
private java.lang.String contentType
private int bufferSize
private boolean committed
private java.util.Locale locale
private final java.util.List<Cookie> cookies
private final java.util.Map<java.lang.String,HeaderValueHolder> headers
private int status
private java.lang.String errorMessage
private java.lang.String redirectedUrl
private java.lang.String forwardedUrl
private final java.util.List<java.lang.String> includedUrls
Constructor Detail |
---|
public MockHttpServletResponse()
Method Detail |
---|
public void setOutputStreamAccessAllowed(boolean outputStreamAccessAllowed)
getOutputStream()
access is allowed.
Default is true
.
public boolean isOutputStreamAccessAllowed()
getOutputStream()
access is allowed.
public void setWriterAccessAllowed(boolean writerAccessAllowed)
getWriter()
access is allowed.
Default is true
.
public boolean isWriterAccessAllowed()
getOutputStream()
access is allowed.
public void setCharacterEncoding(java.lang.String characterEncoding)
public java.lang.String getCharacterEncoding()
public ServletOutputStream getOutputStream()
public java.io.PrintWriter getWriter() throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public byte[] getContentAsByteArray()
public java.lang.String getContentAsString() throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public void setContentLength(int contentLength)
public int getContentLength()
public void setContentType(java.lang.String contentType)
public java.lang.String getContentType()
public void setBufferSize(int bufferSize)
public int getBufferSize()
public void flushBuffer()
public void resetBuffer()
private void setCommittedIfBufferSizeExceeded()
public void setCommitted(boolean committed)
public boolean isCommitted()
public void reset()
public void setLocale(java.util.Locale locale)
public java.util.Locale getLocale()
public void addCookie(Cookie cookie)
public Cookie[] getCookies()
public Cookie getCookie(java.lang.String name)
public boolean containsHeader(java.lang.String name)
public java.util.Set<java.lang.String> getHeaderNames()
Set
of header name Strings
, or an empty Set
if nonepublic java.lang.Object getHeader(java.lang.String name)
Will return the first value in case of multiple values.
name
- the name of the header
null if none
public java.util.List<java.lang.Object> getHeaders(java.lang.String name)
name
- the name of the header
public java.lang.String encodeURL(java.lang.String url)
Can be overridden in subclasses, appending a session id or the like.
public java.lang.String encodeRedirectURL(java.lang.String url)
encodeURL(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, appyling
to redirect URLs as well as to general URLs.
public java.lang.String encodeUrl(java.lang.String url)
public java.lang.String encodeRedirectUrl(java.lang.String url)
public void sendError(int status, java.lang.String errorMessage) throws java.io.IOException
java.io.IOException
public void sendError(int status) throws java.io.IOException
java.io.IOException
public void sendRedirect(java.lang.String url) throws java.io.IOException
java.io.IOException
public java.lang.String getRedirectedUrl()
public void setDateHeader(java.lang.String name, long value)
public void addDateHeader(java.lang.String name, long value)
public void setHeader(java.lang.String name, java.lang.String value)
public void addHeader(java.lang.String name, java.lang.String value)
public void setIntHeader(java.lang.String name, int value)
public void addIntHeader(java.lang.String name, int value)
private void setHeaderValue(java.lang.String name, java.lang.Object value)
private void addHeaderValue(java.lang.String name, java.lang.Object value)
private void doAddHeaderValue(java.lang.String name, java.lang.Object value, boolean replace)
public void setStatus(int status)
public void setStatus(int status, java.lang.String errorMessage)
public int getStatus()
public java.lang.String getErrorMessage()
public void setForwardedUrl(java.lang.String forwardedUrl)
public java.lang.String getForwardedUrl()
public void setIncludedUrl(java.lang.String includedUrl)
public java.lang.String getIncludedUrl()
public void addIncludedUrl(java.lang.String includedUrl)
public java.util.List<java.lang.String> getIncludedUrls()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |