public class

BufferingHttpClientHandler

extends Object
implements NHttpClientHandler
java.lang.Object
   ↳ org.apache.http.nio.protocol.BufferingHttpClientHandler

Class Overview

Client protocol handler implementation that provides compatibility with the blocking I/O by storing the full content of HTTP messages in memory. The handleResponse(HttpResponse, HttpContext) method will fire only when the entire message content has been read into a in-memory buffer. Please note that request execution / response processing take place the main I/O thread and therefore HttpRequestExecutionHandler methods should not block indefinitely.

When using this protocol handler HttpEntity's content can be generated / consumed using standard InputStream/OutputStream classes.

IMPORTANT: This protocol handler should be used only when dealing with HTTP messages that are known to be limited in length.

Summary

Public Constructors
BufferingHttpClientHandler(HttpProcessor httpProcessor, HttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
BufferingHttpClientHandler(HttpProcessor httpProcessor, HttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, HttpParams params)
Public Methods
void closed(NHttpClientConnection conn)
Triggered when the connection is closed.
void connected(NHttpClientConnection conn, Object attachment)
Triggered when a new outgoing connection is created.
void exception(NHttpClientConnection conn, HttpException httpex)
Triggered when an HTTP protocol violation occurs while receiving an HTTP response.
void exception(NHttpClientConnection conn, IOException ioex)
Triggered when an I/O error occurs while reading from or writing to the underlying channel.
void inputReady(NHttpClientConnection conn, ContentDecoder decoder)
Triggered when the underlying channel is ready for reading a new portion of the response entity through the corresponding content decoder.
void outputReady(NHttpClientConnection conn, ContentEncoder encoder)
Triggered when the underlying channel is ready for writing a next portion of the request entity through the corresponding content encoder.
void requestReady(NHttpClientConnection conn)
Triggered when the connection is ready to accept a new HTTP request.
void responseReceived(NHttpClientConnection conn)
Triggered when an HTTP response is received.
void setEventListener(EventListener eventListener)
void timeout(NHttpClientConnection conn)
Triggered when no input is detected on this connection over the maximum period of inactivity.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.nio.NHttpClientHandler

Public Constructors

public BufferingHttpClientHandler (HttpProcessor httpProcessor, HttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)

public BufferingHttpClientHandler (HttpProcessor httpProcessor, HttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, HttpParams params)

Public Methods

public void closed (NHttpClientConnection conn)

Triggered when the connection is closed.

Parameters
conn closed HTTP connection.

public void connected (NHttpClientConnection conn, Object attachment)

Triggered when a new outgoing connection is created.

Parameters
conn new outgoing HTTP connection.
attachment an object that was attached to the session request

public void exception (NHttpClientConnection conn, HttpException httpex)

Triggered when an HTTP protocol violation occurs while receiving an HTTP response.

Parameters
conn HTTP connection that caused an HTTP protocol violation
httpex HTTP protocol violation exception

public void exception (NHttpClientConnection conn, IOException ioex)

Triggered when an I/O error occurs while reading from or writing to the underlying channel.

Parameters
conn HTTP connection that caused an I/O error
ioex I/O exception

public void inputReady (NHttpClientConnection conn, ContentDecoder decoder)

Triggered when the underlying channel is ready for reading a new portion of the response entity through the corresponding content decoder.

If the content consumer is unable to process the incoming content, input event notifications can be temporarily suspended using IOControl interface.

Parameters
conn HTTP connection that can produce a new portion of the incoming response content.
decoder The content decoder to use to read content.

public void outputReady (NHttpClientConnection conn, ContentEncoder encoder)

Triggered when the underlying channel is ready for writing a next portion of the request entity through the corresponding content encoder.

If the content producer is unable to generate the outgoing content, output event notifications can be temporarily suspended using IOControl interface.

Parameters
conn HTTP connection that can accommodate a new portion of the outgoing request content.
encoder The content encoder to use to write content.

public void requestReady (NHttpClientConnection conn)

Triggered when the connection is ready to accept a new HTTP request. The protocol handler does not have to submit a request if it is not ready.

Parameters
conn HTTP connection that is ready to accept a new HTTP request.

public void responseReceived (NHttpClientConnection conn)

Triggered when an HTTP response is received. The connection passed as a parameter to this method is guaranteed to return a valid HTTP response object.

If the response received encloses a response entity this method will be followed by a series of inputReady(NHttpClientConnection, ContentDecoder) calls to transfer the response content.

Parameters
conn HTTP connection that contains an HTTP response

public void setEventListener (EventListener eventListener)

public void timeout (NHttpClientConnection conn)

Triggered when no input is detected on this connection over the maximum period of inactivity.

Parameters
conn HTTP connection that caused timeout condition.