Package net.officefloor.server.http.mock

Class MockHttpServer.MockServerHttpConnectionImpl

java.lang.Object

net.officefloor.server.http.mock.MockHttpServer.MockServerHttpConnectionImpl

All Implemented Interfaces:

MockHttpRequestCallback, MockServerHttpConnection, ServerHttpConnection

Enclosing class:

MockHttpServer

public static class MockHttpServer.MockServerHttpConnectionImpl
extends java.lang.Object
implements MockServerHttpConnection, MockHttpRequestCallback

MockServerHttpConnection implementation.

Field Summary

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

DEFAULT_HTTP_ENTITY_CHARSET, HTTP_CHARSET, URI_CHARSET

Constructor Summary

Constructors

Constructor	Description
MockServerHttpConnectionImpl(MockHttpRequestBuilder request)	Instantiate.

Method Summary

Modifier and Type	Method	Description
java.io.Serializable	exportState()	Exports the state of the current HttpRequest and HttpResponse.
HttpRequest	getClientRequest()	Obtains the actual client sent HttpRequest for the ServerHttpConnection.
HttpRequest	getRequest()	Obtains the HttpRequest to be serviced.
HttpResponse	getResponse()	Obtains the HttpResponse.
HttpServerLocation	getServerLocation()	Obtains the HttpServerLocation.
void	importState(java.io.Serializable momento)	Imports and overrides the current HttpRequest and HttpResponse with the input momento.
boolean	isSecure()	Indicates if the connection is over a secure channel (e.g.
void	response(MockHttpResponse response)	Callback with the MockHttpResponse.
MockHttpResponse	send(java.lang.Throwable escalation)	Sends the HttpResponse.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockServerHttpConnectionImpl

public MockServerHttpConnectionImpl(MockHttpRequestBuilder request)

Instantiate.

Parameters:

request - MockHttpRequestBuilder.

Method Detail

send

public MockHttpResponse send(java.lang.Throwable escalation)

Description copied from interface: MockServerHttpConnection

Sends the HttpResponse.

Specified by:

send in interface MockServerHttpConnection

Parameters:

escalation - Optional Escalation. Should be null for successful processing.

Returns:

MockHttpResponse.

response

public void response(MockHttpResponse response)

Description copied from interface: MockHttpRequestCallback

Callback with the MockHttpResponse.

Specified by:

response in interface MockHttpRequestCallback

Parameters:

response - MockHttpResponse.

getRequest

public HttpRequest getRequest()

Description copied from interface: ServerHttpConnection

Obtains the HttpRequest to be serviced.

Specified by:

getRequest in interface ServerHttpConnection

Returns:

HttpRequest to be serviced.

getResponse

public HttpResponse getResponse()

Description copied from interface: ServerHttpConnection

Obtains the HttpResponse.

Specified by:

getResponse in interface ServerHttpConnection

Returns:

HttpResponse.

isSecure

public boolean isSecure()

Description copied from interface: ServerHttpConnection

Indicates if the connection is over a secure channel (e.g. utilising SSL).

Specified by:

isSecure in interface ServerHttpConnection

Returns:

true if connection is over a secure channel.

getServerLocation

public HttpServerLocation getServerLocation()

Description copied from interface: ServerHttpConnection

Obtains the HttpServerLocation.

Specified by:

getServerLocation in interface ServerHttpConnection

Returns:

HttpServerLocation.

exportState

public java.io.Serializable exportState()
                                 throws java.io.IOException

Description copied from interface: ServerHttpConnection

Exports the state of the current HttpRequest and HttpResponse.

This enables maintaining the state of the HttpRequest / HttpResponse and later reinstating them (typically after a redirect).

Specified by:

exportState in interface ServerHttpConnection

Returns:

Momento containing the current HttpRequest and HttpResponse state.

Throws:

java.io.IOException - Should the state not be able to be exported.

See Also:

ServerHttpConnection.importState(Serializable)

importState

public void importState(java.io.Serializable momento)
                 throws java.lang.IllegalArgumentException,
                        java.io.IOException

Description copied from interface: ServerHttpConnection

Imports and overrides the current HttpRequest and HttpResponse with the input momento.

Specified by:

importState in interface ServerHttpConnection

Parameters:

momento - Momento exported from a ServerHttpConnection.

Throws:

java.lang.IllegalArgumentException - Should the momento be invalid.

java.io.IOException - Should the state not be able to be imported.

See Also:

ServerHttpConnection.exportState()

getClientRequest

public HttpRequest getClientRequest()

Description copied from interface: ServerHttpConnection

Obtains the actual client sent HttpRequest for the ServerHttpConnection.

As the HttpRequest can be overridden, this allows logic requiring to know details of the actual client HttpRequest. Examples of this logic are:

• the POST/redirect/GET pattern that needs to know whether the client sent HttpMethod is a POST or GET (regardless of imported state)
• checking for the Authorization HttpHeader to ensure it was sent by the client for servicing the HttpRequest
• checking for the JWT token HttpRequestCookie to ensure it was sent by the client for servicing the HttpRequest

Note for most application logic the ServerHttpConnection.getRequest() should be used, as the intention is for this to contain the appropriate information for servicing the HttpRequest.

Specified by:

getClientRequest in interface ServerHttpConnection

Returns:

Actual client HttpRequest.

See Also:

ServerHttpConnection.exportState(), ServerHttpConnection.importState(Serializable)