net.officefloor.plugin.socket.server.http.conversation.impl

Class HttpManagedObjectImpl

java.lang.Object

net.officefloor.plugin.socket.server.http.conversation.impl.HttpManagedObjectImpl

All Implemented Interfaces:

EscalationHandler, ManagedObject, HttpManagedObject, ServerHttpConnection

public class HttpManagedObjectImpl
extends Object
implements HttpManagedObject, ServerHttpConnection, EscalationHandler

ManagedObject for the ServerHttpConnection.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpManagedObjectImpl(Connection connection, HttpConversationImpl conversation, HttpRequestImpl request) Initiate to process the HttpRequest by populating the HttpResponse.
HttpManagedObjectImpl(HttpResponseImpl completedResponse) Initiate with HttpResponse ready to be sent.

Method Summary

Modifier and Type	Method and Description
void	cleanup(CleanupEscalation[] cleanupEscalations) Cleans up this HttpManagedObject.
Serializable	exportState() Exports the state of the current HttpRequest and HttpResponse.
EscalationHandler	getEscalationHandler() Obtains the EscalationHandler.
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.
Object	getObject() Obtains the object being managed.
InetSocketAddress	getRemoteAddress() Obtains the remote address for this ServerHttpConnection.
ServerHttpConnection	getServerHttpConnection() Obtains the ServerHttpConnection.
void	handleEscalation(Throwable escalation) Handles the Throwable.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpManagedObjectImpl

public HttpManagedObjectImpl(Connection connection,
                             HttpConversationImpl conversation,
                             HttpRequestImpl request)

Initiate to process the HttpRequest by populating the HttpResponse.

Parameters:

connection - Connection.

conversation - HttpConversationImpl.

request - HttpRequestImpl.

HttpManagedObjectImpl

public HttpManagedObjectImpl(HttpResponseImpl completedResponse)

Initiate with HttpResponse ready to be sent.

Parameters:

completedResponse - HttpResponse ready to be sent.

Method Detail

getObject

public Object getObject()
                 throws Exception

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

Exception

getEscalationHandler

public EscalationHandler getEscalationHandler()

Description copied from interface: HttpManagedObject

Obtains the EscalationHandler.

Specified by:

getEscalationHandler in interface HttpManagedObject

Returns:

EscalationHandler.

getServerHttpConnection

public ServerHttpConnection getServerHttpConnection()

Description copied from interface: HttpManagedObject

Obtains the ServerHttpConnection.

Specified by:

getServerHttpConnection in interface HttpManagedObject

Returns:

ServerHttpConnection.

cleanup

public void cleanup(CleanupEscalation[] cleanupEscalations)
             throws IOException

Description copied from interface: HttpManagedObject

Cleans up this HttpManagedObject.

Specified by:

cleanup in interface HttpManagedObject

Parameters:

cleanupEscalations - CleanupEscalation instances of previous cleanup of ManagedObject instances.

Throws:

IOException - If fails to clean up HttpManagedObject.

getHttpRequest

public HttpRequest getHttpRequest()

Description copied from interface: ServerHttpConnection

Obtains the HttpRequest for this ServerHttpConnection.

Specified by:

getHttpRequest in interface ServerHttpConnection

Returns:

HttpRequest for this ServerHttpConnection.

getHttpResponse

public HttpResponse getHttpResponse()

Description copied from interface: ServerHttpConnection

Obtains the HttpResponse for this ServerHttpConnection.

Specified by:

getHttpResponse in interface ServerHttpConnection

Returns:

HttpResponse for this ServerHttpConnection.

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.

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: ServerHttpConnection

Obtains the local address for this ServerHttpConnection.

Specified by:

getLocalAddress in interface ServerHttpConnection

Returns:

InetSocketAddress describing the local Socket for this ServerHttpConnection.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: ServerHttpConnection

Obtains the remote address for this ServerHttpConnection.

Specified by:

getRemoteAddress in interface ServerHttpConnection

Returns:

InetSocketAddress describing the remote Socket for this ServerHttpConnection.

exportState

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

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

See Also:

ServerHttpConnection.importState(Serializable)

importState

public void importState(Serializable momento)

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.

See Also:

ServerHttpConnection.exportState()

getHttpMethod

public String getHttpMethod()

Description copied from interface: ServerHttpConnection

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

Specified by:

getHttpMethod in interface ServerHttpConnection

Returns:

Client sent HTTP method.

See Also:

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

handleEscalation

public void handleEscalation(Throwable escalation)
                      throws Throwable

Description copied from interface: EscalationHandler

Handles the Throwable.

Specified by:

handleEscalation in interface EscalationHandler

Parameters:

escalation - Escalation.

Throws:

Throwable - If fails to handle EscalationFlow.