Package net.officefloor.server.http

Interface ServerHttpConnection

All Known Subinterfaces:

MockServerHttpConnection

All Known Implementing Classes:

MockHttpServer.MockServerHttpConnectionImpl, ProcessAwareServerHttpConnectionManagedObject

public interface ServerHttpConnection

HTTP connection to be handled by the OfficeFloor.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static java.nio.charset.Charset	DEFAULT_HTTP_ENTITY_CHARSET	HTTP entity default Charset.
static java.nio.charset.Charset	HTTP_CHARSET	HTTP Charset.
static java.nio.charset.Charset	URI_CHARSET	URI Charset.

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.

Field Detail

HTTP_CHARSET

static final java.nio.charset.Charset HTTP_CHARSET

HTTP Charset.

URI_CHARSET

static final java.nio.charset.Charset URI_CHARSET

URI Charset.

DEFAULT_HTTP_ENTITY_CHARSET

static final java.nio.charset.Charset DEFAULT_HTTP_ENTITY_CHARSET

HTTP entity default Charset.

Method Detail

getRequest

HttpRequest getRequest()

Obtains the HttpRequest to be serviced.

Returns:

HttpRequest to be serviced.

getResponse

HttpResponse getResponse()

Obtains the HttpResponse.

Returns:

HttpResponse.

isSecure

boolean isSecure()

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

Returns:

true if connection is over a secure channel.

getServerLocation

HttpServerLocation getServerLocation()

Obtains the HttpServerLocation.

Returns:

HttpServerLocation.

exportState

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

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).

Returns:

Momento containing the current HttpRequest and HttpResponse state.

Throws:

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

See Also:

importState(Serializable)

importState

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

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

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:

exportState()

getClientRequest

HttpRequest getClientRequest()

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 getRequest() should be used, as the intention is for this to contain the appropriate information for servicing the HttpRequest.

Returns:

Actual client HttpRequest.

See Also:

exportState(), importState(Serializable)