org.apache.http.nio.protocol

Class BufferingHttpClientHandler.ExecutionHandlerAdaptor

java.lang.Object

org.apache.http.nio.protocol.BufferingHttpClientHandler.ExecutionHandlerAdaptor

All Implemented Interfaces:

NHttpRequestExecutionHandler

Enclosing class:

BufferingHttpClientHandler

static class BufferingHttpClientHandler.ExecutionHandlerAdaptor
extends java.lang.Object
implements NHttpRequestExecutionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private HttpRequestExecutionHandler	execHandler

Constructor Summary

Constructors

Constructor and Description
ExecutionHandlerAdaptor(HttpRequestExecutionHandler execHandler)

Method Summary

Modifier and Type	Method and Description
void	finalizeContext(HttpContext context) Triggered when the connection is terminated.
void	handleResponse(HttpResponse response, HttpContext context) Triggered when an HTTP response is ready to be processed.
void	initalizeContext(HttpContext context, java.lang.Object attachment) Triggered when a new connection has been established and the HTTP context needs to be initialized.
ConsumingNHttpEntity	responseEntity(HttpResponse response, HttpContext context) Triggered when a response is received with an entity.
HttpRequest	submitRequest(HttpContext context) Triggered when the underlying connection is ready to send a new HTTP request to the target host.

Methods inherited from class java.lang.Object

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

Field Detail

execHandler

private final HttpRequestExecutionHandler execHandler

Constructor Detail

ExecutionHandlerAdaptor

public ExecutionHandlerAdaptor(HttpRequestExecutionHandler execHandler)

Method Detail

initalizeContext

public void initalizeContext(HttpContext context,
                             java.lang.Object attachment)

Description copied from interface: NHttpRequestExecutionHandler

Triggered when a new connection has been established and the HTTP context needs to be initialized.

The attachment object is the same object which was passed to the connecting I/O reactor when the connection request was made. The attachment may optionally contain some state information required in order to correctly initalize the HTTP context.

Specified by:

initalizeContext in interface NHttpRequestExecutionHandler

Parameters:

context - the actual HTTP context

attachment - the object passed to the connecting I/O reactor upon the request for a new connection.

See Also:

ConnectingIOReactor.connect(java.net.SocketAddress, java.net.SocketAddress, java.lang.Object, org.apache.http.nio.reactor.SessionRequestCallback)

finalizeContext

public void finalizeContext(HttpContext context)

Description copied from interface: NHttpRequestExecutionHandler

Triggered when the connection is terminated. This event can be used to release objects stored in the context or perform some other kind of cleanup.

Specified by:

finalizeContext in interface NHttpRequestExecutionHandler

Parameters:

context - the actual HTTP context

submitRequest

public HttpRequest submitRequest(HttpContext context)

Description copied from interface: NHttpRequestExecutionHandler

Triggered when the underlying connection is ready to send a new HTTP request to the target host. This method may return null if the client is not yet ready to send a request. In this case the connection will remain open and can be activated at a later point.

If the request has an entity, the entity must be an instance of ProducingNHttpEntity.

Specified by:

submitRequest in interface NHttpRequestExecutionHandler

Parameters:

context - the actual HTTP context

Returns:

an HTTP request to be sent or null if no request needs to be sent

responseEntity

public ConsumingNHttpEntity responseEntity(HttpResponse response,
                                           HttpContext context)
                                    throws java.io.IOException

Description copied from interface: NHttpRequestExecutionHandler

Triggered when a response is received with an entity. This method should return a ConsumingNHttpEntity that will be used to consume the entity. null is a valid response value, and will indicate that the entity should be silently ignored.

After the entity is fully consumed, NHttpRequestExecutionHandler.handleResponse(HttpResponse, HttpContext) is called to notify a full response & entity are ready to be processed.

Specified by:

responseEntity in interface NHttpRequestExecutionHandler

Parameters:

response - The response containing the existing entity.

context - the actual HTTP context

Returns:

An entity that will asynchronously consume the response's content body.

Throws:

java.io.IOException

handleResponse

public void handleResponse(HttpResponse response,
                           HttpContext context)
                    throws java.io.IOException

Description copied from interface: NHttpRequestExecutionHandler

Triggered when an HTTP response is ready to be processed.

Specified by:

handleResponse in interface NHttpRequestExecutionHandler

Parameters:

response - the HTTP response to be processed

context - the actual HTTP context

Throws:

java.io.IOException