org.apache.juneau.rest.mock

Class MockServletResponse

java.lang.Object

org.apache.juneau.rest.mock.MockServletResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, MockHttpResponse

public class MockServletResponse
extends Object
implements javax.servlet.http.HttpServletResponse, MockHttpResponse

An implementation of HttpServletResponse for mocking purposes.

See Also:

• Overview > juneau-rest-server > Serverless Unit Testing

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 and Description
MockServletResponse()

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.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.
boolean	containsHeader(String name)
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.
javax.servlet.ServletOutputStream	getOutputStream()
int	getStatus() Returns the status code of the response.
PrintWriter	getWriter()
boolean	isCommitted()
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockServletResponse

public MockServletResponse()

Method Detail

create

public static MockServletResponse create()

Creates a new servlet response.

Returns:

A new response.

getContentLength

public long getContentLength()

Returns the content length.

Returns:

The content length.

getMessage

public String getMessage()

Returns the response message.

Specified by:

getMessage in interface MockHttpResponse

Returns:

The response message.

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Throws:

IOException

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface javax.servlet.ServletResponse

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface javax.servlet.ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface javax.servlet.ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

sendError

public void sendError(int sc,
                      String msg)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Throws:

IOException

setDateHeader

public void setDateHeader(String name,
                          long date)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                          long date)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int sc,
                      String sm)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

getStatus

public int getStatus()

Description copied from interface: MockHttpResponse

Returns the status code of the response.

Specified by:

getStatus in interface javax.servlet.http.HttpServletResponse

Specified by:

getStatus in interface MockHttpResponse

Returns:

The status code of the response.

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletResponse

getBodyAsString

public String getBodyAsString()

Returns the body of the request as a string.

Returns:

The body of the request as a string.

assertStatus

public MockServletResponse assertStatus(int status)
                                 throws AssertionError

Throws an AssertionError if the response status does not match the expected status.

Parameters:

status - The expected status.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if status does not match.

assertBody

public MockServletResponse assertBody(String text)
                               throws AssertionError

Throws an AssertionError if the response body does not contain the expected text.

Parameters:

text - The expected text of the body.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the body does not contain the expected text.

assertBodyContains

public MockServletResponse assertBodyContains(String... substrings)
                                       throws AssertionError

Throws an AssertionError if the response body does not contain all of the expected substrings.

Parameters:

substrings - The expected substrings.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the body does not contain one or more of the expected substrings.

assertBodyMatches

public MockServletResponse assertBodyMatches(String pattern)
                                      throws AssertionError

Throws an AssertionError if the response body does not match the specified pattern.

A pattern is a simple string containing "*" to represent zero or more arbitrary characters.

Parameters:

pattern - The pattern to match against.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the body does not match the specified pattern.

assertBodyMatchesRE

public MockServletResponse assertBodyMatchesRE(String regExp)
                                        throws AssertionError

Throws an AssertionError if the response body does not match the specified regular expression.

A pattern is a simple string containing "*" to represent zero or more arbitrary characters.

Parameters:

regExp - The regular expression to match against.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the body does not match the specified regular expression.

assertCharset

public MockServletResponse assertCharset(String value)

Throws an AssertionError if the response does not contain the expected character encoding.

Parameters:

value - The expected character encoding.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the response does not contain the expected character encoding.

assertHeader

public MockServletResponse assertHeader(String name,
                                        String value)

Throws an AssertionError if the response does not contain the expected header value.

Parameters:

name - The header name.

value - The expected header value.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the response does not contain the expected header value.

assertHeaderContains

public MockServletResponse assertHeaderContains(String name,
                                                String... substrings)

Throws an AssertionError if the response header does not contain all of the expected substrings.

Parameters:

name - The header name.

substrings - The expected substrings.

Returns:

This object (for method chaining).

Throws:

AssertionError - Thrown if the header does not contain one or more of the expected substrings.

getBody

public byte[] getBody()

Returns the body of the request.

Specified by:

getBody in interface MockHttpResponse

Returns:

The body of the request.

getHeaders

public Map<String,String[]> getHeaders()

Description copied from interface: MockHttpResponse

Returns the headers of the response.

Specified by:

getHeaders in interface MockHttpResponse

Returns:

The headers of the response.