Package net.officefloor.server.http.impl

Class ProcessAwareServerHttpConnectionManagedObject<B>

java.lang.Object

net.officefloor.server.http.impl.ProcessAwareServerHttpConnectionManagedObject<B>

Type Parameters:

B - Type of underlying buffer being used.

All Implemented Interfaces:

FlowCallback, ContextAwareManagedObject, InputManagedObject, ManagedObject, ServerHttpConnection

Direct Known Subclasses:

SpringServerHttpConnection

public class ProcessAwareServerHttpConnectionManagedObject<B>
extends Object
implements ServerHttpConnection, ContextAwareManagedObject, InputManagedObject, FlowCallback

ServerHttpConnection implementation available for ExternalServiceInput.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.frame.api.function.FlowCallback

ESCALATE

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

DEFAULT_HTTP_ENTITY_CHARSET, HTTP_CHARSET, URI_CHARSET

Constructor Summary

Constructors

Constructor

Description

ProcessAwareServerHttpConnectionManagedObject(HttpServerLocation serverLocation, boolean isSecure, Supplier<HttpMethod> methodSupplier, Supplier<String> requestUriSupplier, HttpVersion version, NonMaterialisedHttpHeaders requestHeaders, ByteSequence requestEntity, HttpHeaderValue serverName, DateHttpHeaderClock dateHttpHeaderClock, boolean isIncludeStackTraceOnEscalation, HttpResponseWriter<B> writer, StreamBufferPool<B> bufferPool)

Instantiate.

Method Summary

Modifier and Type	Method	Description
void	clean(CleanupEscalation[] cleanupEscalations)	Invoked to clean the ManagedObject at end of servicing.
Serializable	exportState()	Exports the state of the current HttpRequest and HttpResponse.
HttpRequest	getClientRequest()	Obtains the actual client sent HttpRequest for the ServerHttpConnection.
Object	getObject()	Obtains the object being managed.
HttpRequest	getRequest()	Obtains the HttpRequest to be serviced.
HttpResponse	getResponse()	Obtains the HttpResponse.
HttpServerLocation	getServerLocation()	Obtains the HttpServerLocation.
FlowCallback	getServiceFlowCallback()	Obtains the service FlowCallback.
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.
void	run(Throwable escalation)	Invoked on completion of the Flow.
void	setManagedObjectContext(ManagedObjectContext context)	Provides the ManagedObjectContext to the ManagedObject.

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessAwareServerHttpConnectionManagedObject

public ProcessAwareServerHttpConnectionManagedObject(HttpServerLocation serverLocation,
 boolean isSecure,
 Supplier<HttpMethod> methodSupplier,
 Supplier<String> requestUriSupplier,
 HttpVersion version,
 NonMaterialisedHttpHeaders requestHeaders,
 ByteSequence requestEntity,
 HttpHeaderValue serverName,
 DateHttpHeaderClock dateHttpHeaderClock,
 boolean isIncludeStackTraceOnEscalation,
 HttpResponseWriter<B> writer,
 StreamBufferPool<B> bufferPool)

Instantiate.

Parameters:

serverLocation - HttpServerLocation.

isSecure - Indicates if secure.

methodSupplier - Supplier for the HttpRequest HttpMethod.

requestUriSupplier - Supplier for the HttpRequest URI.

version - HttpVersion for the HttpRequest.

requestHeaders - NonMaterialisedHttpHeaders for the HttpRequest.

requestEntity - ByteSequence for the HttpRequest entity.

serverName - Name of the server. May be null if not sending Server HttpHeader.

dateHttpHeaderClock - DateHttpHeaderClock. May be null to not send Date HttpHeader.

isIncludeStackTraceOnEscalation - true to include the Escalation stack trace in the HttpResponse.

writer - HttpResponseWriter.

bufferPool - StreamBufferPool.

Method Details

getServiceFlowCallback

public FlowCallback getServiceFlowCallback()

Obtains the service FlowCallback.

Returns:

FlowCallback to use for servicing this.

setManagedObjectContext

public void setManagedObjectContext(ManagedObjectContext context)

Description copied from interface: ContextAwareManagedObject

Provides the ManagedObjectContext to the ManagedObject.

Specified by:

setManagedObjectContext in interface ContextAwareManagedObject

Parameters:

context - ManagedObjectContext.

getObject

public Object getObject()

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

clean

public void clean(CleanupEscalation[] cleanupEscalations)
           throws Throwable

Description copied from interface: InputManagedObject

Invoked to clean the ManagedObject at end of servicing.

Specified by:

clean in interface InputManagedObject

Parameters:

cleanupEscalations - CleanupEscalation instances on failure of servicing.

Throws:

Throwable - If fails to handle the CleanupEscalation instances.

getServerLocation

public HttpServerLocation getServerLocation()

Description copied from interface: ServerHttpConnection

Obtains the HttpServerLocation.

Specified by:

getServerLocation in interface ServerHttpConnection

Returns:

HttpServerLocation.

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.

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.

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)
                 throws IllegalArgumentException,
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:

IllegalArgumentException - Should the momento be invalid.

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)

run

public void run(Throwable escalation)
         throws Throwable

Description copied from interface: FlowCallback

Invoked on completion of the Flow.

Specified by:

run in interface FlowCallback

Parameters:

escalation - Possible Throwable from the Flow. null indicates all Escalation instances handled within Flow.

Throws:

Throwable - Escalation within the callback logic.