Package net.officefloor.server.http.mock

Class MockHttpServer

java.lang.Object

net.officefloor.server.http.mock.MockHttpServer

All Implemented Interfaces:

HttpServerImplementation, HttpServerLocation

Direct Known Subclasses:

MockWoofServer

public class MockHttpServer
extends Object
implements HttpServerLocation, HttpServerImplementation

Mock HttpServer.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	MockHttpServer.MockHttpRequest	HTTP request details for the MockHttpResponse.
protected static class	MockHttpServer.MockHttpResponseImpl	MockHttpResponse implementation.
static class	MockHttpServer.MockServerHttpConnectionImpl	MockServerHttpConnection implementation.

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

Modifier	Constructor	Description
protected	MockHttpServer()	Instantiated via static methods or extending.

Method Summary

Modifier and Type	Method	Description
void	configureHttpServer(HttpServerImplementationContext context)	Configures the HttpServer.
static MockHttpServer	configureMockHttpServer(DeployedOfficeInput input)	Configures the MockHttpServer to be serviced by the DeployedOfficeInput.
static MockHttpServer	configureMockHttpServer(DeployedOfficeInput input, String typeQualifier)	Configures the MockHttpServer to be serviced by the DeployedOfficeInput.
protected static void	configureMockHttpServer(MockHttpServer httpServer, String typeQualifier, DeployedOfficeInput input)	Enables extending implementations to configure themselves as the MockHttpServer.
String	createClientUrl(boolean isSecure, String path)	Creates the client URL to call the HttpServer.
protected MockHttpResponse	createMockHttpResponse(MockHttpServer.MockHttpRequest request, Throwable failure)	Creates the MockHttpResponse.
protected MockHttpResponse	createMockHttpResponse(MockHttpServer.MockHttpRequest request, HttpVersion version, HttpStatus status, List<WritableHttpHeader> headers, List<WritableHttpCookie> cookies, InputStream entityInputStream)	Creates the MockHttpResponse.
MockHttpResponse	direct(MockHttpRequestBuilder request, ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>> externalServiceInput)	Undertakes direct invocation of servicing the MockHttpRequestBuilder.
void	direct(MockHttpRequestBuilder request, ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>> externalServiceInput, MockHttpRequestCallback callback)	Triggers direct handling of MockHttpRequestBuilder.
String	getClusterHostName()	Obtains the name of the host for the server within the cluster.
int	getClusterHttpPort()	The cluster may be behind a load balancer and the server may be running on a different port than expected by the client.
int	getClusterHttpsPort()	The cluster may be behind a load balancer and the server may be running on a different port than expected by the client.
String	getDomain()	Obtains the domain for the server.
static ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>>	getExternalServiceInput(OfficeSectionInput input)	Convenience method to extract ExternalServiceInput from OfficeSectionInput.
static ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>>	getExternalServiceInput(DeployedOfficeInput input)	Convenience method to extract ExternalServiceInput from DeployedOfficeInput.
int	getHttpPort()	Obtains the HTTP port.
int	getHttpsPort()	Obtains the HTTPS port.
static MockServerHttpConnection	mockConnection()	Convenience method to create the MockServerHttpConnection for GET / with no headers nor entity.
static MockServerHttpConnection	mockConnection(MockHttpRequestBuilder request)	Creates the MockServerHttpConnection.
static MockHttpRequestBuilder	mockJsonRequest(Object jsonObject)	Create MockHttpRequestBuilder for JSON payload.
static MockHttpRequestBuilder	mockJsonRequest(HttpMethod method, String requestUri, Object jsonObject)	Create MockHttpRequestBuilder for JSON payload.
static MockHttpRequestBuilder	mockRequest()	Creates the MockHttpRequestBuilder.
static MockHttpRequestBuilder	mockRequest(String requestUri)	Convenience method to create a MockHttpRequestBuilder.
static MockHttpResponseBuilder	mockResponse()	Creates the MockHttpRequestBuilder.
static WritableHttpCookie	mockResponseCookie(String name, String value)	Creates a mock HttpResponseCookie.
MockHttpResponse	send(MockHttpRequestBuilder request)	Sends the MockHttpRequestBuilder and blocks waiting for the MockHttpResponse.
void	send(MockHttpRequestBuilder request, MockHttpRequestCallback callback)	Sends the MockHttpRequestBuilder.
MockHttpResponse	sendFollowRedirect(MockHttpRequestBuilder request)	Sends the MockHttpRequestBuilder and blocks following the redirect.
MockHttpServer	timeout(int timeout)	Specifies the timeout for synchronous send.

Methods inherited from class java.lang.Object

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

Constructor Details

MockHttpServer

protected MockHttpServer()

Instantiated via static methods or extending.

Method Details

configureMockHttpServer

public static MockHttpServer configureMockHttpServer(DeployedOfficeInput input)
                                              throws Exception

Configures the MockHttpServer to be serviced by the DeployedOfficeInput.

Parameters:

input - DeployedOfficeInput.

Returns:

MockHttpServer to send HttpRequest instances.

Throws:

Exception - If fails to configure MockHttpServer.

configureMockHttpServer

public static MockHttpServer configureMockHttpServer(DeployedOfficeInput input,
 String typeQualifier)
                                              throws Exception

Configures the MockHttpServer to be serviced by the DeployedOfficeInput.

Parameters:

input - DeployedOfficeInput.

typeQualifier - Type qualifier for the MockHttpServer.

Returns:

MockHttpServer to send HttpRequest instances.

Throws:

Exception - If fails to configure MockHttpServer.

configureMockHttpServer

protected static void configureMockHttpServer(MockHttpServer httpServer,
 String typeQualifier,
 DeployedOfficeInput input)
                                       throws Exception

Enables extending implementations to configure themselves as the MockHttpServer.

Parameters:

httpServer - MockHttpServer.

typeQualifier - Type qualifier for the MockHttpServer.

input - DeployedOfficeInput.

Throws:

Exception - If fails to configure MockHttpServer.

mockRequest

public static MockHttpRequestBuilder mockRequest()

Creates the MockHttpRequestBuilder.

Returns:

MockHttpRequestBuilder.

mockRequest

public static MockHttpRequestBuilder mockRequest(String requestUri)

Convenience method to create a MockHttpRequestBuilder.

Parameters:

requestUri - Request URI.

Returns:

MockHttpRequestBuilder.

mockResponse

public static MockHttpResponseBuilder mockResponse()

Creates the MockHttpRequestBuilder.

Returns:

MockHttpRequestBuilder.

mockResponseCookie

public static WritableHttpCookie mockResponseCookie(String name,
 String value)

Creates a mock HttpResponseCookie.

Parameters:

name - Name.

value - value.

Returns:

HttpResponseCookie.

mockConnection

public static MockServerHttpConnection mockConnection()

Convenience method to create the MockServerHttpConnection for GET / with no headers nor entity.

Returns:

MockServerHttpConnection.

mockConnection

public static MockServerHttpConnection mockConnection(MockHttpRequestBuilder request)

Creates the MockServerHttpConnection.

Parameters:

request - MockHttpRequestBuilder for the HttpRequest of the MockServerHttpConnection.

Returns:

MockServerHttpConnection.

getExternalServiceInput

public static ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>> getExternalServiceInput(OfficeSectionInput input)

Convenience method to extract ExternalServiceInput from OfficeSectionInput.

Parameters:

input - OfficeSectionInput.

Returns:

ExternalServiceInput.

getExternalServiceInput

public static ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>> getExternalServiceInput(DeployedOfficeInput input)

Convenience method to extract ExternalServiceInput from DeployedOfficeInput.

Parameters:

input - DeployedOfficeInput.

Returns:

ExternalServiceInput.

timeout

public MockHttpServer timeout(int timeout)

Specifies the timeout for synchronous send.

Parameters:

timeout - Timeout in milliseconds.

Returns:

this.

send

public void send(MockHttpRequestBuilder request,
 MockHttpRequestCallback callback)

Sends the MockHttpRequestBuilder.

Parameters:

request - MockHttpRequestBuilder.

callback - MockHttpRequestCallback to receive the MockHttpResponse.

direct

public void direct(MockHttpRequestBuilder request,
 ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>> externalServiceInput,
 MockHttpRequestCallback callback)

Triggers direct handling of MockHttpRequestBuilder.

Parameters:

request - MockHttpRequestBuilder.

externalServiceInput - ExternalServiceInput for direct invocation.

callback - MockHttpRequestCallback to receive the MockHttpResponse.

mockJsonRequest

public static MockHttpRequestBuilder mockJsonRequest(Object jsonObject)

Create MockHttpRequestBuilder for JSON payload.

Parameters:

jsonObject - JSON object.

Returns:

MockHttpRequestBuilder.

mockJsonRequest

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

Create MockHttpRequestBuilder for JSON payload.

Parameters:

method - HttpMethod.

requestUri - Request URI.

jsonObject - JSON object.

Returns:

MockHttpRequestBuilder.

send

public MockHttpResponse send(MockHttpRequestBuilder request)

Sends the MockHttpRequestBuilder and blocks waiting for the MockHttpResponse.

Parameters:

request - MockHttpRequestBuilder.

Returns:

MockHttpResponse.

direct

public MockHttpResponse direct(MockHttpRequestBuilder request,
 ExternalServiceInput<ServerHttpConnection,ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>> externalServiceInput)

Undertakes direct invocation of servicing the MockHttpRequestBuilder.

Parameters:

request - MockHttpRequestBuilder.

externalServiceInput - ExternalServiceInput for direct invocation.

Returns:

MockHttpResponse.

sendFollowRedirect

public MockHttpResponse sendFollowRedirect(MockHttpRequestBuilder request)

Sends the MockHttpRequestBuilder and blocks following the redirect.

Parameters:

request - MockHttpRequestBuilder.

Returns:

Redirect MockHttpResponse.

createMockHttpResponse

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

Creates the MockHttpResponse.

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,
 Throwable failure)

Creates the MockHttpResponse.

Parameters:

request - MockHttpServer.MockHttpRequest.

failure - Failure in servicing.

Returns:

MockHttpResponse.

getDomain

public String getDomain()

Description copied from interface: HttpServerLocation

Obtains the domain for the server.

This is as the client will see the server.

Specified by:

getDomain in interface HttpServerLocation

Returns:

Domain for the server.

getHttpPort

public int getHttpPort()

Description copied from interface: HttpServerLocation

Obtains the HTTP port.

This is as the client will see the server.

Specified by:

getHttpPort in interface HttpServerLocation

Returns:

HTTP port.

getHttpsPort

public int getHttpsPort()

Description copied from interface: HttpServerLocation

Obtains the HTTPS port.

This is as the client will see the server.

Specified by:

getHttpsPort in interface HttpServerLocation

Returns:

HTTPS port.

getClusterHostName

public String getClusterHostName()

Description copied from interface: HttpServerLocation

Obtains the name of the host for the server within the cluster. This name should be understood by all nodes within the cluster.

Specified by:

getClusterHostName in interface HttpServerLocation

Returns:

Name of the host within the cluster.

getClusterHttpPort

public int getClusterHttpPort()

Description copied from interface: HttpServerLocation

The cluster may be behind a load balancer and the server may be running on a different port than expected by the client.

Specified by:

getClusterHttpPort in interface HttpServerLocation

Returns:

Actual port on the cluster host the server is running on.

getClusterHttpsPort

public int getClusterHttpsPort()

Description copied from interface: HttpServerLocation

The cluster may be behind a load balancer and the server may be running on a different port than expected by the client.

Specified by:

getClusterHttpsPort in interface HttpServerLocation

Returns:

Actual secure port on the cluster host the server is running on.

createClientUrl

public String createClientUrl(boolean isSecure,
 String path)

Description copied from interface: HttpServerLocation

Creates the client URL to call the HttpServer.

Specified by:

createClientUrl in interface HttpServerLocation

Parameters:

isSecure - If secure URL.

path - Path including query string and fragment.

Returns:

URL for the client to call on the HttpServer.

configureHttpServer

public void configureHttpServer(HttpServerImplementationContext context)

Description copied from interface: HttpServerImplementation

Configures the HttpServer.

Specified by:

configureHttpServer in interface HttpServerImplementation

Parameters:

context - HttpServerImplementationContext.