Package net.officefloor.woof.mock

Class MockWoofServer

java.lang.Object

net.officefloor.server.http.mock.MockHttpServer

net.officefloor.woof.mock.MockWoofServer

All Implemented Interfaces:

java.lang.AutoCloseable, HttpServerImplementation, HttpServerLocation

Direct Known Subclasses:

MockWoofServerExtension, MockWoofServerRule

public class MockWoofServer
extends MockHttpServer
implements java.lang.AutoCloseable

MockHttpServer loading the WoOF application.

This provides convenient means to test WoOF applications.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MockWoofServer.MockWoofInput	Annotates service methods for the ClassSectionSource.
protected class	MockWoofServer.MockWoofResponseImpl	MockWoofResponse implementation.
static interface	MockWoofServer.MockWoofServerConfigurer	Enables configuring the MockWoofServer.

Nested classes/interfaces inherited from class net.officefloor.server.http.mock.MockHttpServer

MockHttpServer.MockHttpRequest, MockHttpServer.MockHttpResponseImpl, MockHttpServer.MockServerHttpConnectionImpl

Field Summary

Fields inherited from interface net.officefloor.server.http.HttpServerLocation

PROPERTY_CLUSTER_HOST_NAME, PROPERTY_CLUSTER_HTTP_PORT, PROPERTY_CLUSTER_HTTPS_PORT, PROPERTY_DOMAIN, PROPERTY_HTTP_PORT, PROPERTY_HTTPS_PORT

Constructor Summary

Constructors

Constructor	Description
MockWoofServer()

Method Summary

Modifier and Type	Method	Description
void	close()
protected MockHttpResponse	createMockHttpResponse(MockHttpServer.MockHttpRequest request, java.lang.Throwable failure)	Creates the MockHttpResponse.
protected MockHttpResponse	createMockHttpResponse(MockHttpServer.MockHttpRequest request, HttpVersion version, HttpStatus status, java.util.List<WritableHttpHeader> headers, java.util.List<WritableHttpCookie> cookies, java.io.InputStream entityInputStream)	Creates the MockHttpResponse.
static MockWoofServer.MockWoofServerConfigurer	createSectionServicer(java.lang.Class<?> sectionClass)	Creates a MockWoofServer.MockWoofServerConfigurer for servicing via ClassSectionSource Class.
OfficeFloor	getOfficeFloor()	Obtains the OfficeFloor.
static MockHttpRequestBuilder	mockJsonRequest(HttpMethod method, java.lang.Object jsonObject)	Create MockHttpRequestBuilder for JSON payload.
static MockHttpRequestBuilder	mockJsonRequest(HttpMethod method, java.lang.String requestUri, java.lang.Object jsonObject)	Create MockHttpRequestBuilder for JSON payload.
static OfficeFloor	open(int httpPort, int httpsPort, java.lang.Class<?> sectionClass)	Opens the WoOF on a particular port with the ClassSectionSource to service ServerHttpConnection.
static OfficeFloor	open(int httpPort, int httpsPort, MockWoofServer.MockWoofServerConfigurer... configurers)	Opens the WoOF on particular ports.
static OfficeFloor	open(int httpPort, java.lang.Class<?> sectionClass)	Opens the WoOF on a particular port with the ClassSectionSource to service ServerHttpConnection.
static MockWoofServer	open(MockWoofServer.MockWoofServerConfigurer... configurers)	Opens the MockWoofServer.
protected static MockWoofServer	open(MockWoofServer server, MockWoofServer.MockWoofServerConfigurer... configurers)	Opens the MockWoofServer.
MockWoofResponse	send(MockHttpRequestBuilder request)	Sends the MockHttpRequestBuilder and blocks waiting for the MockHttpResponse.
MockWoofResponse	sendFollowRedirect(MockHttpRequestBuilder request)	Sends the MockHttpRequestBuilder and blocks following the redirect.

Methods inherited from class net.officefloor.server.http.mock.MockHttpServer

configureHttpServer, configureMockHttpServer, configureMockHttpServer, createClientUrl, getClusterHostName, getClusterHttpPort, getClusterHttpsPort, getDomain, getHttpPort, getHttpsPort, mockConnection, mockConnection, mockRequest, mockRequest, mockResponse, mockResponseCookie, send, timeout

Methods inherited from class java.lang.Object

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

Constructor Detail

MockWoofServer

public MockWoofServer()

Method Detail

open

public static MockWoofServer open(MockWoofServer.MockWoofServerConfigurer... configurers)
                           throws java.lang.Exception

Opens the MockWoofServer.

Parameters:

configurers - MockWoofServer.MockWoofServerConfigurer instances.

Returns:

MockWoofServer.

Throws:

java.lang.Exception - If fails to start the MockWoofServer.

open

public static OfficeFloor open(int httpPort,
                               java.lang.Class<?> sectionClass)
                        throws java.lang.Exception

Opens the WoOF on a particular port with the ClassSectionSource to service ServerHttpConnection.

This is a convenience method to typically setup a mock server to respond to application requests.

Parameters:

httpPort - HTTP port.

sectionClass - Class for ClassSectionSource.

Returns:

MockWoofServer.

Throws:

java.lang.Exception - If fails to start the MockWoofServer.

open

public static OfficeFloor open(int httpPort,
                               int httpsPort,
                               java.lang.Class<?> sectionClass)
                        throws java.lang.Exception

Opens the WoOF on a particular port with the ClassSectionSource to service ServerHttpConnection.

This is a convenience method to typically setup a mock server to respond to application requests.

Parameters:

httpPort - HTTP port.

httpsPort - HTTPS port.

sectionClass - Class for ClassSectionSource.

Returns:

MockWoofServer.

Throws:

java.lang.Exception - If fails to start the MockWoofServer.

createSectionServicer

public static MockWoofServer.MockWoofServerConfigurer createSectionServicer(java.lang.Class<?> sectionClass)

Creates a MockWoofServer.MockWoofServerConfigurer for servicing via ClassSectionSource Class.

Parameters:

sectionClass - ClassSectionSource Class.

Returns:

MockWoofServer.MockWoofServerConfigurer.

open

public static OfficeFloor open(int httpPort,
                               int httpsPort,
                               MockWoofServer.MockWoofServerConfigurer... configurers)
                        throws java.lang.Exception

Opens the WoOF on particular ports.

Parameters:

httpPort - HTTP port.

httpsPort - HTTPS port.

configurers - MockWoofServer.MockWoofServerConfigurer instances.

Returns:

MockWoofServer.

Throws:

java.lang.Exception - If fails to start the MockWoofServer.

open

protected static MockWoofServer open(MockWoofServer server,
                                     MockWoofServer.MockWoofServerConfigurer... configurers)
                              throws java.lang.Exception

Opens the MockWoofServer.

Parameters:

server - MockWoofServer.

configurers - MockWoofServer.MockWoofServerConfigurer instances.

Returns:

Input MockWoofServer.

Throws:

java.lang.Exception - If fails to open the MockWoofServer.

mockJsonRequest

public static MockHttpRequestBuilder mockJsonRequest(HttpMethod method,
                                                     java.lang.Object jsonObject)

Create MockHttpRequestBuilder for JSON payload.

Parameters:

method - HttpMethod.

jsonObject - JSON object.

Returns:

MockHttpRequestBuilder.

mockJsonRequest

public static MockHttpRequestBuilder mockJsonRequest(HttpMethod method,
                                                     java.lang.String requestUri,
                                                     java.lang.Object jsonObject)

Create MockHttpRequestBuilder for JSON payload.

Parameters:

method - HttpMethod.

requestUri - Request URI.

jsonObject - JSON object.

Returns:

MockHttpRequestBuilder.

getOfficeFloor

public OfficeFloor getOfficeFloor()

Obtains the OfficeFloor.

Returns:

OfficeFloor.

createMockHttpResponse

protected MockHttpResponse createMockHttpResponse(MockHttpServer.MockHttpRequest request,
                                                  HttpVersion version,
                                                  HttpStatus status,
                                                  java.util.List<WritableHttpHeader> headers,
                                                  java.util.List<WritableHttpCookie> cookies,
                                                  java.io.InputStream entityInputStream)

Description copied from class: MockHttpServer

Creates the MockHttpResponse.

Overrides:

createMockHttpResponse in class MockHttpServer

Parameters:

request - MockHttpServer.MockHttpRequest.

version - HttpVersion.

status - HttpStatus.

headers - WritableHttpHeader instances.

cookies - WritableHttpCookie instances.

entityInputStream - Entity.

Returns:

MockHttpResponse.

createMockHttpResponse

protected MockHttpResponse createMockHttpResponse(MockHttpServer.MockHttpRequest request,
                                                  java.lang.Throwable failure)

Description copied from class: MockHttpServer

Creates the MockHttpResponse.

Overrides:

createMockHttpResponse in class MockHttpServer

Parameters:

request - MockHttpServer.MockHttpRequest.

failure - Failure in servicing.

Returns:

MockHttpResponse.

send

public MockWoofResponse send(MockHttpRequestBuilder request)

Description copied from class: MockHttpServer

Sends the MockHttpRequestBuilder and blocks waiting for the MockHttpResponse.

Overrides:

send in class MockHttpServer

Parameters:

request - MockHttpRequestBuilder.

Returns:

MockHttpResponse.

sendFollowRedirect

public MockWoofResponse sendFollowRedirect(MockHttpRequestBuilder request)

Description copied from class: MockHttpServer

Sends the MockHttpRequestBuilder and blocks following the redirect.

Overrides:

sendFollowRedirect in class MockHttpServer

Parameters:

request - MockHttpRequestBuilder.

Returns:

Redirect MockHttpResponse.

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception