Package net.officefloor.server.http.mock

Interface MockHttpRequestBuilder

public interface MockHttpRequestBuilder

Builder for a mock HttpRequest.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
HttpRequest	build()	Builds a mock HttpRequest from this MockHttpRequestBuilder configuration.
MockHttpRequestBuilder	cookie(String name, String value)	Adds a HttpRequestCookie.
MockHttpRequestBuilder	cookies(MockHttpResponse response)	Adds all the appropriate WritableHttpCookie instances from the MockHttpResponse.
MockHttpRequestBuilder	entity(String entity)	Sets the HTTP entity.
OutputStream	getHttpEntity()	Obtains the OutputStream to write the HTTP entity.
MockHttpRequestBuilder	header(String name, String value)	Adds a HttpHeader.
MockHttpRequestBuilder	method(HttpMethod method)	Specifies the HttpMethod.
MockHttpRequestBuilder	secure(boolean isSecure)	Flags with the HttpRequest is secure.
MockHttpRequestBuilder	setEfficientForStressTests(boolean isStress)	Flags to turn off checks for HttpRequest and provide efficient processing.
MockHttpRequestBuilder	uri(String requestUri)	Specifies the request URI.
MockHttpRequestBuilder	version(HttpVersion version)	Specifies the HttpVersion.

Method Details

secure

MockHttpRequestBuilder secure(boolean isSecure)

Flags with the HttpRequest is secure.

Parameters:

isSecure - true if secure HttpRequest.

Returns:

this.

method

MockHttpRequestBuilder method(HttpMethod method)

Specifies the HttpMethod.

Parameters:

method - HttpMethod.

Returns:

this.

uri

MockHttpRequestBuilder uri(String requestUri)

Specifies the request URI.

Parameters:

requestUri - Request URI.

Returns:

this.

version

MockHttpRequestBuilder version(HttpVersion version)

Specifies the HttpVersion.

Parameters:

version - HttpVersion.

Returns:

this.

header

MockHttpRequestBuilder header(String name,
 String value)

Adds a HttpHeader.

Parameters:

name - HttpHeader name.

value - HttpHeader value.

Returns:

this.

cookie

MockHttpRequestBuilder cookie(String name,
 String value)

Adds a HttpRequestCookie.

Parameters:

name - HttpRequestCookie name.

value - HttpRequestCookie value.

Returns:

this.

cookies

MockHttpRequestBuilder cookies(MockHttpResponse response)

Adds all the appropriate WritableHttpCookie instances from the MockHttpResponse.

This is a convenience method to enable sending back HttpRequestCookie instances received on a previous MockHttpResponse.

Parameters:

response - MockHttpResponse.

Returns:

this.

entity

MockHttpRequestBuilder entity(String entity)

Sets the HTTP entity.

Parameters:

entity - Entity content.

Returns:

this.

getHttpEntity

OutputStream getHttpEntity()

Obtains the OutputStream to write the HTTP entity.

Returns:

OutputStream to write the HTTP entity.

setEfficientForStressTests

MockHttpRequestBuilder setEfficientForStressTests(boolean isStress)

Flags to turn off checks for HttpRequest and provide efficient processing.

Parameters:

isStress - true to turn off checks and process more efficiently.

Returns:

this.

build

HttpRequest build()

Builds a mock HttpRequest from this MockHttpRequestBuilder configuration.

This is useful for testing to create a mock HttpRequest.

Returns:

Mock HttpRequest.