public class MockServletResponse extends Object implements HttpServletResponse, MockHttpResponse
HttpServletResponse
for mocking purposes.
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 |
---|
MockServletResponse() |
Modifier and Type | Method and Description |
---|---|
void |
addCookie(Cookie cookie) |
void |
addDateHeader(String name,
long date) |
void |
addHeader(String name,
String value) |
void |
addIntHeader(String name,
int value) |
MockServletResponse |
assertBody(String text)
Throws an
AssertionError if the response body does not contain the expected text. |
MockServletResponse |
assertBodyContains(String... substrings)
Throws an
AssertionError if the response body does not contain all of the expected substrings. |
MockServletResponse |
assertBodyMatches(String pattern)
Throws an
AssertionError if the response body does not match the specified pattern. |
MockServletResponse |
assertBodyMatchesRE(String regExp)
Throws an
AssertionError if the response body does not match the specified regular expression. |
MockServletResponse |
assertCharset(String value)
Throws an
AssertionError if the response does not contain the expected character encoding. |
MockServletResponse |
assertHeader(String name,
String value)
Throws an
AssertionError if the response does not contain the expected header value. |
MockServletResponse |
assertHeaderContains(String name,
String... substrings)
Throws an
AssertionError if the response header does not contain all of the expected substrings. |
MockServletResponse |
assertStatus(int status)
Throws an
AssertionError if the response status does not match the expected status. |
MockServletResponse |
bufferSize(int value)
Fluent setter for
bufferSize(int) . |
MockServletResponse |
characterEncoding(String value)
Fluent setter for
setCharacterEncoding(String) . |
boolean |
containsHeader(String name) |
MockServletResponse |
contentLength(int value)
Fluent setter for
setContentLength(int) . |
MockServletResponse |
contentType(String value)
Fluent setter for
setContentType(String) . |
static MockServletResponse |
create()
Creates a new servlet response.
|
String |
encodeRedirectUrl(String url) |
String |
encodeRedirectURL(String url) |
String |
encodeUrl(String url) |
String |
encodeURL(String url) |
void |
flushBuffer() |
byte[] |
getBody()
Returns the body of the request.
|
String |
getBodyAsString()
Returns the body of the request as a string.
|
int |
getBufferSize() |
String |
getCharacterEncoding() |
long |
getContentLength()
Returns the content length.
|
String |
getContentType() |
String |
getHeader(String name) |
Collection<String> |
getHeaderNames() |
Map<String,String[]> |
getHeaders()
Returns the headers of the response.
|
Collection<String> |
getHeaders(String name) |
Locale |
getLocale() |
String |
getMessage()
Returns the response message.
|
ServletOutputStream |
getOutputStream() |
int |
getStatus()
Returns the status code of the response.
|
PrintWriter |
getWriter() |
MockServletResponse |
header(String name,
String value)
Fluent setter for
setHeader(String,String) . |
boolean |
isCommitted() |
MockServletResponse |
locale(Locale value)
Fluent setter for
setLocale(Locale) . |
void |
reset() |
void |
resetBuffer() |
void |
sendError(int sc) |
void |
sendError(int sc,
String msg) |
void |
sendRedirect(String location) |
void |
setBufferSize(int size) |
void |
setCharacterEncoding(String charset) |
void |
setContentLength(int len) |
void |
setContentLengthLong(long len) |
void |
setContentType(String type) |
void |
setDateHeader(String name,
long date) |
void |
setHeader(String name,
String value) |
void |
setIntHeader(String name,
int value) |
void |
setLocale(Locale loc) |
void |
setStatus(int sc) |
void |
setStatus(int sc,
String sm) |
MockServletResponse |
status(int value)
Fluent setter for
setStatus(int) . |
public MockServletResponse()
public static MockServletResponse create()
public long getContentLength()
public String getMessage()
getMessage
in interface MockHttpResponse
public String getCharacterEncoding()
getCharacterEncoding
in interface ServletResponse
public String getContentType()
getContentType
in interface ServletResponse
public ServletOutputStream getOutputStream() throws IOException
getOutputStream
in interface ServletResponse
IOException
public PrintWriter getWriter() throws IOException
getWriter
in interface ServletResponse
IOException
public void setCharacterEncoding(String charset)
setCharacterEncoding
in interface ServletResponse
public MockServletResponse characterEncoding(String value)
setCharacterEncoding(String)
.value
- The new property value.public void setContentLength(int len)
setContentLength
in interface ServletResponse
public MockServletResponse contentLength(int value)
setContentLength(int)
.value
- The new property value.public void setContentLengthLong(long len)
setContentLengthLong
in interface ServletResponse
public void setContentType(String type)
setContentType
in interface ServletResponse
public MockServletResponse contentType(String value)
setContentType(String)
.value
- The new property value.public void setBufferSize(int size)
setBufferSize
in interface ServletResponse
public MockServletResponse bufferSize(int value)
bufferSize(int)
.value
- The new property value.public int getBufferSize()
getBufferSize
in interface ServletResponse
public void flushBuffer() throws IOException
flushBuffer
in interface ServletResponse
IOException
public void resetBuffer()
resetBuffer
in interface ServletResponse
public boolean isCommitted()
isCommitted
in interface ServletResponse
public void reset()
reset
in interface ServletResponse
public void setLocale(Locale loc)
setLocale
in interface ServletResponse
public MockServletResponse locale(Locale value)
setLocale(Locale)
.value
- The new property value.public Locale getLocale()
getLocale
in interface ServletResponse
public void addCookie(Cookie cookie)
addCookie
in interface HttpServletResponse
public boolean containsHeader(String name)
containsHeader
in interface HttpServletResponse
public String encodeURL(String url)
encodeURL
in interface HttpServletResponse
public String encodeRedirectURL(String url)
encodeRedirectURL
in interface HttpServletResponse
public String encodeUrl(String url)
encodeUrl
in interface HttpServletResponse
public String encodeRedirectUrl(String url)
encodeRedirectUrl
in interface HttpServletResponse
public void sendError(int sc, String msg) throws IOException
sendError
in interface HttpServletResponse
IOException
public void sendError(int sc) throws IOException
sendError
in interface HttpServletResponse
IOException
public void sendRedirect(String location) throws IOException
sendRedirect
in interface HttpServletResponse
IOException
public void setDateHeader(String name, long date)
setDateHeader
in interface HttpServletResponse
public void addDateHeader(String name, long date)
addDateHeader
in interface HttpServletResponse
public void setHeader(String name, String value)
setHeader
in interface HttpServletResponse
public void addHeader(String name, String value)
addHeader
in interface HttpServletResponse
public MockServletResponse header(String name, String value)
setHeader(String,String)
.name
- The header name.value
- The new header value.public void setIntHeader(String name, int value)
setIntHeader
in interface HttpServletResponse
public void addIntHeader(String name, int value)
addIntHeader
in interface HttpServletResponse
public void setStatus(int sc)
setStatus
in interface HttpServletResponse
public MockServletResponse status(int value)
setStatus(int)
.value
- The new property value.public void setStatus(int sc, String sm)
setStatus
in interface HttpServletResponse
public int getStatus()
MockHttpResponse
getStatus
in interface HttpServletResponse
getStatus
in interface MockHttpResponse
public String getHeader(String name)
getHeader
in interface HttpServletResponse
public Collection<String> getHeaders(String name)
getHeaders
in interface HttpServletResponse
public Collection<String> getHeaderNames()
getHeaderNames
in interface HttpServletResponse
public String getBodyAsString()
public MockServletResponse assertStatus(int status) throws AssertionError
AssertionError
if the response status does not match the expected status.status
- The expected status.AssertionError
- Thrown if status does not match.public MockServletResponse assertBody(String text) throws AssertionError
AssertionError
if the response body does not contain the expected text.text
- The expected text of the body.AssertionError
- Thrown if the body does not contain the expected text.public MockServletResponse assertBodyContains(String... substrings) throws AssertionError
AssertionError
if the response body does not contain all of the expected substrings.substrings
- The expected substrings.AssertionError
- Thrown if the body does not contain one or more of the expected substrings.public MockServletResponse assertBodyMatches(String pattern) throws AssertionError
AssertionError
if the response body does not match the specified pattern.
A pattern is a simple string containing
pattern
- The pattern to match against.AssertionError
- Thrown if the body does not match the specified pattern.public MockServletResponse assertBodyMatchesRE(String regExp) throws AssertionError
AssertionError
if the response body does not match the specified regular expression.
A pattern is a simple string containing
regExp
- The regular expression to match against.AssertionError
- Thrown if the body does not match the specified regular expression.public MockServletResponse assertCharset(String value)
AssertionError
if the response does not contain the expected character encoding.value
- The expected character encoding.AssertionError
- Thrown if the response does not contain the expected character encoding.public MockServletResponse assertHeader(String name, String value)
AssertionError
if the response does not contain the expected header value.name
- The header name.value
- The expected header value.AssertionError
- Thrown if the response does not contain the expected header value.public MockServletResponse assertHeaderContains(String name, String... substrings)
AssertionError
if the response header does not contain all of the expected substrings.name
- The header name.substrings
- The expected substrings.AssertionError
- Thrown if the header does not contain one or more of the expected substrings.public byte[] getBody()
getBody
in interface MockHttpResponse
public Map<String,String[]> getHeaders()
MockHttpResponse
getHeaders
in interface MockHttpResponse
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.