Package net.officefloor.server.http.mock

Interface MockHttpResponse

All Known Subinterfaces:

MockWoofResponse

All Known Implementing Classes:

MockHttpServer.MockHttpResponseImpl, MockWoofServer.MockWoofResponseImpl

public interface MockHttpResponse

Mock HttpResponse.

Author:

Daniel Sagenschneider

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, String... headerNameValuePairs)	Asserts the JSON response.
void	assertJson(int statusCode, Object entity, tools.jackson.databind.ObjectMapper mapper, String... headerNameValuePairs)	Asserts the JSON response providing custom ObjectMapper.
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, tools.jackson.databind.ObjectMapper mapper)	Obtains the JSON object from HTTP payload using custom ObjectMapper.
HttpStatus	getStatus()	Obtains the HttpStatus.
HttpVersion	getVersion()	Obtains the HttpVersion.

Method Details

getVersion

HttpVersion getVersion()

Obtains the HttpVersion.

Returns:

HttpVersion.

getStatus

HttpStatus getStatus()

Obtains the HttpStatus.

Returns:

HttpStatus.

getHeader

WritableHttpHeader getHeader(String name)

Obtains the first WritableHttpHeader by the name.

Parameters:

name - Name of the WritableHttpHeader.

Returns:

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

assertStatus

void assertStatus(int statusCode)

Assets the status of the HttpResponse.

Parameters:

statusCode - Status code.

assertStatus

void assertStatus(HttpStatus status)

Assets the HttpStatus of the HttpResponse.

Parameters:

status - HttpStatus.

getHeaders

List<WritableHttpHeader> getHeaders()

Obtains the response WritableHttpHeader instances.

Returns:

WritableHttpHeader instances.

assertResponse

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

Asserts the contents of the HttpResponse.

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.

assertHeader

void assertHeader(String name,
 String value)

Asserts contains the HttpHeader.

Parameters:

name - Expected name.

value - Expected value.

getCookie

WritableHttpCookie getCookie(String name)

Obtains the WritableHttpCookie by the name.

Parameters:

name - Name of the WritableHttpCookie.

Returns:

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

getCookies

List<WritableHttpCookie> getCookies()

Obtains the response WritableHttpCookie instances.

Returns:

WritableHttpCookie instances.

assertCookie

void assertCookie(HttpResponseCookie cookie)

Asserts contains the WritableHttpCookie.

Parameters:

cookie - Expected WritableHttpCookie.

See Also:

• MockHttpServer.mockResponseCookie(String, String)

getEntity

InputStream getEntity()

Obtains InputStream to the response HTTP entity.

Returns:

InputStream to the response HTTP entity.

getEntity

String getEntity(Charset charset)

Obtains the HTTP entity as text.

Parameters:

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

Returns:

Text of the HTTP entity.

getJson

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

Obtains the JSON object from HTTP payload.

Type Parameters:

T - Type of object.

Parameters:

statusCode - HttpStatus.

clazz - Class for the JSON object.

Returns:

JSON object.

getJson

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

Obtains the JSON object from HTTP payload using custom ObjectMapper.

Type Parameters:

T - Type of object.

Parameters:

statusCode - HttpStatus.

clazz - Class for the JSON object.

mapper - Custom ObjectMapper.

Returns:

JSON object.

assertJson

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

Asserts the JSON response.

Parameters:

statusCode - HttpStatus.

entity - Object to be written as JSON.

headerNameValuePairs - Expected HttpHeader name/value pairs.

assertJson

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

Asserts the JSON response providing custom ObjectMapper.

Parameters:

statusCode - HttpStatus.

entity - Object to be written as JSON.

mapper - Custom ObjectMapper.

headerNameValuePairs - Expected HttpHeader name/value pairs.