net.officefloor.plugin.socket.server.http

Interface ServerHttpConnection

All Known Implementing Classes:

HttpManagedObjectImpl, ServletServerHttpConnection

public interface ServerHttpConnection

HTTP connection to be handled by the OfficeFloor.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
Serializable	exportState() Exports the state of the current HttpRequest and HttpResponse.
String	getHttpMethod() Obtains the client sent HTTP method of the ServerHttpConnection.
HttpRequest	getHttpRequest() Obtains the HttpRequest for this ServerHttpConnection.
HttpResponse	getHttpResponse() Obtains the HttpResponse for this ServerHttpConnection.
InetSocketAddress	getLocalAddress() Obtains the local address for this ServerHttpConnection.
InetSocketAddress	getRemoteAddress() Obtains the remote address for this ServerHttpConnection.
void	importState(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.

Method Detail

getHttpRequest

HttpRequest getHttpRequest()

Obtains the HttpRequest for this ServerHttpConnection.

Returns:

HttpRequest for this ServerHttpConnection.

getHttpResponse

HttpResponse getHttpResponse()

Obtains the HttpResponse for this ServerHttpConnection.

Returns:

HttpResponse for this ServerHttpConnection.

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.

getLocalAddress

InetSocketAddress getLocalAddress()

Obtains the local address for this ServerHttpConnection.

Returns:

InetSocketAddress describing the local Socket for this ServerHttpConnection.

getRemoteAddress

InetSocketAddress getRemoteAddress()

Obtains the remote address for this ServerHttpConnection.

Returns:

InetSocketAddress describing the remote Socket for this ServerHttpConnection.

exportState

Serializable exportState()
                  throws 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:

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

See Also:

importState(Serializable)

importState

void importState(Serializable momento)
          throws IllegalArgumentException,
                 IOException

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

Parameters:

momento - Momento exported from a ServerHttpConnection.

Throws:

IllegalArgumentException - Should the momento be invalid.

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

See Also:

exportState()

getHttpMethod

String getHttpMethod()

Obtains the client sent HTTP method of the ServerHttpConnection.

As the HttpRequest method is overridden, this method may be used by logic requiring to know the actual client HTTP method. An example of this logic is the POST/redirect/GET pattern that needs to know whether the client sent HttpRequest method is a POST or GET (regardless of imported state).

Returns:

Client sent HTTP method.

See Also:

exportState(), importState(Serializable)