com.bytelightning.opensource.pokerface

Class TargetResponseConsumer

java.lang.Object

com.bytelightning.opensource.pokerface.TargetBase

com.bytelightning.opensource.pokerface.TargetResponseConsumer

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.concurrent.Cancellable, org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

public class TargetResponseConsumer
extends TargetBase
implements org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

This class reads in the response we receive back from the remote Target, and then signals the ResponseProducer that it can begin responding back to the requesting client. Note that the ResponseProducer may actually start responding back to the client even before we have fully read the response content from the remote Target.

Field Summary

Fields

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

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

Via

Constructor Summary

Constructors

Constructor and Description
TargetResponseConsumer(ResponseProducer producer, BufferIOController producersBuffer, org.apache.http.protocol.HttpContext context, ScriptObjectMirror endpoint) Primary constructor

Method Summary

Modifier and Type	Method and Description
boolean	cancel() This method also notifies the ResponseProducer about the cancellation by invoking our failed method with an InterruptedIOException.
void	close()
void	consumeContent(org.apache.http.nio.ContentDecoder decoder, org.apache.http.nio.IOControl ioctrl) This method is only called if the response had content (which it typically does).
void	failed(Exception ex) This method also notifies the ResponseProducer about this exception.
Exception	getException() This method returns null as any failure will have already been propagated to the ResponseProducer
org.apache.http.HttpResponse	getResult()
boolean	isDone()
void	responseCompleted(org.apache.http.protocol.HttpContext context) This method also lets the ResponseProducer know that we have received all the content from the remote Target.
void	responseReceived(org.apache.http.HttpResponse response)

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

BuildHeaderRemovalList, CreateHttpViaHeader

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

TargetResponseConsumer

public TargetResponseConsumer(ResponseProducer producer,
                              BufferIOController producersBuffer,
                              org.apache.http.protocol.HttpContext context,
                              ScriptObjectMirror endpoint)

Primary constructor

Parameters:

producer - The object that will produce the final response back to the client.

producersBuffer - The buffer which this object will write to, and which the producer will read from.

context - The context of this transaction.

endpoint - If non-null, this is a script endpoint that may wish to alter the response from the target before we send it back to the client.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

responseReceived

public void responseReceived(org.apache.http.HttpResponse response)

Specified by:

responseReceived in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

consumeContent

public void consumeContent(org.apache.http.nio.ContentDecoder decoder,
                           org.apache.http.nio.IOControl ioctrl)
                    throws IOException

This method is only called if the response had content (which it typically does). It reads the incoming response data and stores it in it's buffer to be read asynchronously by the ResponseProducer that is part of this clientRequest to serverRequest to serverResponse to clientResponse transaction.

Specified by:

consumeContent in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

Throws:

IOException

responseCompleted

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

This method also lets the ResponseProducer know that we have received all the content from the remote Target.

Specified by:

responseCompleted in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

failed

public void failed(Exception ex)

This method also notifies the ResponseProducer about this exception.

Specified by:

failed in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

cancel

public boolean cancel()

This method also notifies the ResponseProducer about the cancellation by invoking our failed method with an InterruptedIOException.

Specified by:

cancel in interface org.apache.http.concurrent.Cancellable

getResult

public org.apache.http.HttpResponse getResult()

Specified by:

getResult in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

getException

public Exception getException()

This method returns null as any failure will have already been propagated to the ResponseProducer

Specified by:

getException in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>

isDone

public boolean isDone()

Specified by:

isDone in interface org.apache.http.nio.protocol.HttpAsyncResponseConsumer<org.apache.http.HttpResponse>