com.bytelightning.opensource.pokerface

Class ScriptResponseProducer

java.lang.Object

com.bytelightning.opensource.pokerface.ResponseProducer

com.bytelightning.opensource.pokerface.ScriptResponseProducer

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.nio.protocol.HttpAsyncResponseProducer

public class ScriptResponseProducer
extends ResponseProducer

This ResponseProducer specialization is responsible for invoking the JavaScript endpoint to produce a response, translate that response (if need be) into an asynchronous form, and then send that data back to the client.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	Logger

Fields inherited from class com.bytelightning.opensource.pokerface.ResponseProducer

contentProducer, context, response, role, trigger

Constructor Summary

Constructors

Constructor and Description
ScriptResponseProducer(ScriptObjectMirror endpoint, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context, BufferIOController buffer) Primary constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpResponse	generateResponse() Someone else always generates the response and invokes one of our setResponse or setException methods.
void	responseCompleted(org.apache.http.protocol.HttpContext context) Invoke the endpoint's responseCompleted function, and close out our ScriptHelper.
boolean	setResponse(org.apache.http.HttpResponse response) Determines the HttpResponse that will be sent back to the requesting client.
boolean	setTrigger(org.apache.http.nio.protocol.HttpAsyncExchange trigger) Triggers the generateResponse method and begins responding to the client.

Methods inherited from class com.bytelightning.opensource.pokerface.ResponseProducer

close, failed, produceContent, setException, setResponse

Methods inherited from class java.lang.Object

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

Field Detail

Logger

protected static final org.slf4j.Logger Logger

Constructor Detail

ScriptResponseProducer

public ScriptResponseProducer(ScriptObjectMirror endpoint,
                              org.apache.http.HttpRequest request,
                              org.apache.http.protocol.HttpContext context,
                              BufferIOController buffer)

Primary constructor.

Parameters:

endpoint - The actual JavaScript endpoint to invoke.

request - The request that was returned earlier by the endpoint's inspectRequest method.

context - The context of this request / response transaction.

buffer - The buffer from which the response's content data will be asynchronously read and sent back to the client.

Method Detail

generateResponse

public org.apache.http.HttpResponse generateResponse()

Someone else always generates the response and invokes one of our setResponse or setException methods. This method returns whatever that response was. This method actually does all the work of this class by invoking the endpoint, and processing it's result.

Specified by:

generateResponse in interface org.apache.http.nio.protocol.HttpAsyncResponseProducer

Overrides:

generateResponse in class ResponseProducer

responseCompleted

public void responseCompleted(org.apache.http.protocol.HttpContext context)

Invoke the endpoint's responseCompleted function, and close out our ScriptHelper.

Specified by:

responseCompleted in interface org.apache.http.nio.protocol.HttpAsyncResponseProducer

Overrides:

responseCompleted in class ResponseProducer

setResponse

public boolean setResponse(org.apache.http.HttpResponse response)

Determines the HttpResponse that will be sent back to the requesting client. If the RequestHandler.handle method has already armed us with an HttpAsyncExchange response trigger, then invoke it's submitResponse method. Otherwise keep track of the response until our setTrigger method is invoked (at which time the trigger's submitResponse method will be called and this response will be sent back to the client). Because the JavaScript endpoint provides it's data synchronously, our setTrigger method will not yet have been called *and* we need to make sure that any response (error or otherwise) has it's HttpEntity (if any) wrapped into an EntityAsyncContentProducer so that we can respond to the client in an asynchronous manner.

Overrides:

setResponse in class ResponseProducer

setTrigger

public boolean setTrigger(org.apache.http.nio.protocol.HttpAsyncExchange trigger)

Triggers the generateResponse method and begins responding to the client.

Overrides:

setTrigger in class ResponseProducer