Package net.officefloor.server.http.mock

Class MockHttpServer.MockHttpResponseImpl

java.lang.Object

net.officefloor.server.http.mock.MockHttpServer.MockHttpResponseImpl

All Implemented Interfaces:

MockHttpResponse

Direct Known Subclasses:

MockWoofServer.MockWoofResponseImpl

Enclosing class:

MockHttpServer

protected static class MockHttpServer.MockHttpResponseImpl
extends Object
implements MockHttpResponse

MockHttpResponse implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<WritableHttpCookie>	cookies	HttpResponseCookie instances.
protected final InputStream	entityInputStream	HTTP entity InputStream.
protected final Throwable	failure	Possible failure in writing the response.
protected final List<WritableHttpHeader>	headers	HttpHeader instances.
protected final MockHttpServer.MockHttpRequest	request	MockHttpServer.MockHttpRequest for this MockHttpResponse.
protected final HttpStatus	status	HttpStatus.
protected final HttpVersion	version	HttpVersion.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MockHttpResponseImpl(MockHttpServer.MockHttpRequest request, Throwable failure)	Loads with response failure.
protected	MockHttpResponseImpl(MockHttpServer.MockHttpRequest request, HttpVersion version, HttpStatus status, List<WritableHttpHeader> headers, List<WritableHttpCookie> cookies, InputStream entityInputStream)	Loads the response.

Method Summary

Modifier and Type	Method	Description
void	assertCookie(HttpResponseCookie cookie)	Asserts contains the WritableHttpCookie.
void	assertHeader(String name, String value)	Asserts contains the HttpHeader.
void	assertJson(int statusCode, Object entity, com.fasterxml.jackson.databind.ObjectMapper mapper, String... headerNameValuePairs)	Asserts the JSON response providing custom ObjectMapper.
void	assertJson(int statusCode, Object entity, String... headerNameValuePairs)	Asserts the JSON response.
void	assertResponse(int statusCode, String entity, String... headerNameValuePairs)	Asserts the contents of the HttpResponse.
void	assertStatus(int statusCode)	Assets the status of the HttpResponse.
void	assertStatus(HttpStatus status)	Assets the HttpStatus of the HttpResponse.
WritableHttpCookie	getCookie(String name)	Obtains the WritableHttpCookie by the name.
List<WritableHttpCookie>	getCookies()	Obtains the response WritableHttpCookie instances.
InputStream	getEntity()	Obtains InputStream to the response HTTP entity.
String	getEntity(Charset charset)	Obtains the HTTP entity as text.
WritableHttpHeader	getHeader(String name)	Obtains the first WritableHttpHeader by the name.
List<WritableHttpHeader>	getHeaders()	Obtains the response WritableHttpHeader instances.
<T> T	getJson(int statusCode, Class<T> clazz)	Obtains the JSON object from HTTP payload.
<T> T	getJson(int statusCode, Class<T> clazz, com.fasterxml.jackson.databind.ObjectMapper mapper)	Obtains the JSON object from HTTP payload using custom ObjectMapper.
HttpStatus	getStatus()	Obtains the HttpStatus.
HttpVersion	getVersion()	Obtains the HttpVersion.

Methods inherited from class java.lang.Object

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

Field Details

request

protected final MockHttpServer.MockHttpRequest request

MockHttpServer.MockHttpRequest for this MockHttpResponse.

version

protected final HttpVersion version

HttpVersion.

status

protected final HttpStatus status

HttpStatus.

headers

protected final List<WritableHttpHeader> headers

HttpHeader instances.

cookies

protected final List<WritableHttpCookie> cookies

HttpResponseCookie instances.

entityInputStream

protected final InputStream entityInputStream

HTTP entity InputStream.

failure

protected final Throwable failure

Possible failure in writing the response.

Constructor Details

MockHttpResponseImpl

protected MockHttpResponseImpl(MockHttpServer.MockHttpRequest request,
 HttpVersion version,
 HttpStatus status,
 List<WritableHttpHeader> headers,
 List<WritableHttpCookie> cookies,
 InputStream entityInputStream)

Loads the response.

Parameters:

request - MockHttpServer.MockHttpRequest for this MockHttpResponse.

version - HttpVersion.

status - HttpStatus.

headers - List of HttpHeader instances.

cookies - List of HttpResponseCookie instances.

entityInputStream - HTTP entity InputStream.

MockHttpResponseImpl

protected MockHttpResponseImpl(MockHttpServer.MockHttpRequest request,
 Throwable failure)

Loads with response failure.

Parameters:

request - MockHttpServer.MockHttpRequest for this MockHttpResponse.

failure - Throwable.

Method Details

getVersion

public HttpVersion getVersion()

Description copied from interface: MockHttpResponse

Obtains the HttpVersion.

Specified by:

getVersion in interface MockHttpResponse

Returns:

HttpVersion.

getStatus

public HttpStatus getStatus()

Description copied from interface: MockHttpResponse

Obtains the HttpStatus.

Specified by:

getStatus in interface MockHttpResponse

Returns:

HttpStatus.

getHeader

public WritableHttpHeader getHeader(String name)

Description copied from interface: MockHttpResponse

Obtains the first WritableHttpHeader by the name.

Specified by:

getHeader in interface MockHttpResponse

Parameters:

name - Name of the WritableHttpHeader.

Returns:

First WritableHttpHeader by the name, or null if no WritableHttpHeader by the name.

assertHeader

public void assertHeader(String name,
 String value)

Description copied from interface: MockHttpResponse

Asserts contains the HttpHeader.

Specified by:

assertHeader in interface MockHttpResponse

Parameters:

name - Expected name.

value - Expected value.

getHeaders

public List<WritableHttpHeader> getHeaders()

Description copied from interface: MockHttpResponse

Obtains the response WritableHttpHeader instances.

Specified by:

getHeaders in interface MockHttpResponse

Returns:

WritableHttpHeader instances.

getCookie

public WritableHttpCookie getCookie(String name)

Description copied from interface: MockHttpResponse

Obtains the WritableHttpCookie by the name.

Specified by:

getCookie in interface MockHttpResponse

Parameters:

name - Name of the WritableHttpCookie.

Returns:

WritableHttpCookie by the name, or null if no WritableHttpCookie by the name.

getCookies

public List<WritableHttpCookie> getCookies()

Description copied from interface: MockHttpResponse

Obtains the response WritableHttpCookie instances.

Specified by:

getCookies in interface MockHttpResponse

Returns:

WritableHttpCookie instances.

assertCookie

public void assertCookie(HttpResponseCookie cookie)

Description copied from interface: MockHttpResponse

Asserts contains the WritableHttpCookie.

Specified by:

assertCookie in interface MockHttpResponse

Parameters:

cookie - Expected WritableHttpCookie.

See Also:

• MockHttpServer.mockResponseCookie(String, String)

getEntity

public InputStream getEntity()

Description copied from interface: MockHttpResponse

Obtains InputStream to the response HTTP entity.

Specified by:

getEntity in interface MockHttpResponse

Returns:

InputStream to the response HTTP entity.

getEntity

public String getEntity(Charset charset)

Description copied from interface: MockHttpResponse

Obtains the HTTP entity as text.

Specified by:

getEntity in interface MockHttpResponse

Parameters:

charset - Charset for HTTP entity. May be null to use default Charset.

Returns:

Text of the HTTP entity.

assertStatus

public void assertStatus(int statusCode)

Description copied from interface: MockHttpResponse

Assets the status of the HttpResponse.

Specified by:

assertStatus in interface MockHttpResponse

Parameters:

statusCode - Status code.

assertStatus

public void assertStatus(HttpStatus status)

Description copied from interface: MockHttpResponse

Assets the HttpStatus of the HttpResponse.

Specified by:

assertStatus in interface MockHttpResponse

Parameters:

status - HttpStatus.

assertResponse

public void assertResponse(int statusCode,
 String entity,
 String... headerNameValuePairs)

Description copied from interface: MockHttpResponse

Asserts the contents of the HttpResponse.

Specified by:

assertResponse in interface MockHttpResponse

Parameters:

statusCode - Expected status code.

entity - Expected entity.

headerNameValuePairs - Expected HttpHeader name/value pairs. This only confirms they exist on the HttpResponse. It is not inclusive to check if these are the only HttpHeader instances.

getJson

public <T> T getJson(int statusCode,
 Class<T> clazz)

Description copied from interface: MockHttpResponse

Obtains the JSON object from HTTP payload.

Specified by:

getJson in interface MockHttpResponse

Type Parameters:

T - Type of object.

Parameters:

statusCode - HttpStatus.

clazz - Class for the JSON object.

Returns:

JSON object.

getJson

public <T> T getJson(int statusCode,
 Class<T> clazz,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Description copied from interface: MockHttpResponse

Obtains the JSON object from HTTP payload using custom ObjectMapper.

Specified by:

getJson in interface MockHttpResponse

Type Parameters:

T - Type of object.

Parameters:

statusCode - HttpStatus.

clazz - Class for the JSON object.

mapper - Custom ObjectMapper.

Returns:

JSON object.

assertJson

public void assertJson(int statusCode,
 Object entity,
 String... headerNameValuePairs)

Description copied from interface: MockHttpResponse

Asserts the JSON response.

Specified by:

assertJson in interface MockHttpResponse

Parameters:

statusCode - HttpStatus.

entity - Object to be written as JSON.

headerNameValuePairs - Expected HttpHeader name/value pairs.

assertJson

public void assertJson(int statusCode,
 Object entity,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 String... headerNameValuePairs)

Description copied from interface: MockHttpResponse

Asserts the JSON response providing custom ObjectMapper.

Specified by:

assertJson in interface MockHttpResponse

Parameters:

statusCode - HttpStatus.

entity - Object to be written as JSON.

mapper - Custom ObjectMapper.

headerNameValuePairs - Expected HttpHeader name/value pairs.