com.bytelightning.opensource.pokerface

Class ResponseProducer

java.lang.Object

com.bytelightning.opensource.pokerface.ResponseProducer

All Implemented Interfaces:

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

Direct Known Subclasses:

ScriptResponseProducer

public class ResponseProducer
extends Object
implements org.apache.http.nio.protocol.HttpAsyncResponseProducer

Produce a response (back to the client) in response to the HttpRequest from the client. It is possible that we can begin producing a response to the client *before* RequestHandler.handle is invoked by the framework. To accommodate that, this class has two methods setResponse and setTrigger. Please see those methods for details.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.nio.entity.HttpAsyncContentProducer	contentProducer
protected org.apache.http.protocol.HttpContext	context
protected static org.slf4j.Logger	Logger
protected org.apache.http.HttpResponse	response
protected String	role
protected org.apache.http.nio.protocol.HttpAsyncExchange	trigger

Constructor Summary

Constructors

Constructor and Description
ResponseProducer(String role, org.apache.http.protocol.HttpContext context) Alternate constructor (content producer to be extracted later from the HttpResponse entity).
ResponseProducer(String role, org.apache.http.protocol.HttpContext context, BufferIOController buffer) Alternate constructor (content to be produced from the supplied IOControlled buffer.
ResponseProducer(String role, org.apache.http.protocol.HttpContext context, org.apache.http.nio.entity.HttpAsyncContentProducer contentProducer) Primary constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close the content buffer.
void	failed(Exception ex)
org.apache.http.HttpResponse	generateResponse() Someone else always generates the response and invokes one of our setResponse or setException methods.
void	produceContent(org.apache.http.nio.ContentEncoder encoder, org.apache.http.nio.IOControl ioctrl) This method is only called if the response has content (which is typically the case).
void	responseCompleted(org.apache.http.protocol.HttpContext context)
void	setException(Exception ex) Send back an appropriate response to the client.
boolean	setResponse(org.apache.http.HttpResponse response) Determines the HttpResponse that will be sent back to the requesting client.
void	setResponse(int statusCode, String message) Send back the specified response to the client
boolean	setTrigger(org.apache.http.nio.protocol.HttpAsyncExchange trigger) Called from the RequestHandler.handle method this method keeps track of the supplied trigger.

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

context

protected final org.apache.http.protocol.HttpContext context

role

protected final String role

contentProducer

protected volatile org.apache.http.nio.entity.HttpAsyncContentProducer contentProducer

response

protected volatile org.apache.http.HttpResponse response

trigger

protected volatile org.apache.http.nio.protocol.HttpAsyncExchange trigger

Constructor Detail

ResponseProducer

public ResponseProducer(String role,
                        org.apache.http.protocol.HttpContext context,
                        org.apache.http.nio.entity.HttpAsyncContentProducer contentProducer)

Primary constructor.

Parameters:

context - The context of this transaction

role - The role played by this producer (e.g. server, proxy, endpoint).

contentProducer - The object that will asynchronously produce the content for this response.

ResponseProducer

public ResponseProducer(String role,
                        org.apache.http.protocol.HttpContext context,
                        BufferIOController buffer)

Alternate constructor (content to be produced from the supplied IOControlled buffer.

Parameters:

context - The context of this transaction

role - The role played by this producer (e.g. server, proxy, endpoint).

buffer - A buffer from which response content may be asynchronously read and sent back to the client.

ResponseProducer

public ResponseProducer(String role,
                        org.apache.http.protocol.HttpContext context)

Alternate constructor (content producer to be extracted later from the HttpResponse entity).

Parameters:

context - The context of this transaction

role - The role played by this producer (e.g. server, proxy, endpoint).

Method Detail

close

public void close()
           throws IOException

Close the content buffer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

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.

Specified by:

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

produceContent

public void produceContent(org.apache.http.nio.ContentEncoder encoder,
                           org.apache.http.nio.IOControl ioctrl)
                    throws IOException

This method is only called if the response has content (which is typically the case). It flips it's buffer (which some other object has asynchronously written into), reads the response data and encodes it out to the client who requested it.

Specified by:

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

Throws:

IOException

responseCompleted

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

Specified by:

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

failed

public void failed(Exception ex)

Specified by:

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

setException

public void setException(Exception ex)

Send back an appropriate response to the client.

setResponse

public void setResponse(int statusCode,
                        String message)

Send back the specified response to the client

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

setTrigger

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

Called from the RequestHandler.handle method this method keeps track of the supplied trigger. If our setResponse method has already been called to specify our response, then we invoke the trigger's submitResponse method to send our response back to the client Otherwise keep track of the trigger until our setResponse method is invoked (at which time it will invoke the trigger's submitResponse method to send our response back to the client).