org.apache.http.nio.protocol
Class BufferingHttpClientHandler

java.lang.Object
  org.apache.http.nio.protocol.BufferingHttpClientHandler

All Implemented Interfaces:

NHttpClientHandler

public class BufferingHttpClientHandler

extends java.lang.Object

implements NHttpClientHandler

HTTP client handler implementation that buffers the content of HTTP messages entirely in memory and executes HTTP requests on the main I/O thread.

This service handler should be used only when dealing with HTTP messages that are known to be limited in length

Author:

Oleg Kalnichevski

Constructor Summary

BufferingHttpClientHandler(org.apache.http.protocol.HttpProcessor httpProcessor, HttpRequestExecutionHandler execHandler, org.apache.http.ConnectionReuseStrategy connStrategy, org.apache.http.params.HttpParams params)

Method Summary

void	closed(NHttpClientConnection conn) Triggered when the connection is closed.
void	connected(NHttpClientConnection conn, java.lang.Object attachment) Triggered when a new outgoing connection is created.
void	exception(NHttpClientConnection conn, org.apache.http.HttpException ex) Triggered when an HTTP protocol violation occurs while receiving an HTTP response.
void	exception(NHttpClientConnection conn, java.io.IOException ex) Triggered when an I/O error occurrs 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 send an 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferingHttpClientHandler

public BufferingHttpClientHandler(org.apache.http.protocol.HttpProcessor httpProcessor,
                                  HttpRequestExecutionHandler execHandler,
                                  org.apache.http.ConnectionReuseStrategy connStrategy,
                                  org.apache.http.params.HttpParams params)

Method Detail

setEventListener

public void setEventListener(EventListener eventListener)

connected

public void connected(NHttpClientConnection conn,
                      java.lang.Object attachment)

Description copied from interface: NHttpClientHandler

Triggered when a new outgoing connection is created.

Specified by:

connected in interface NHttpClientHandler

Parameters:

conn - closed HTTP connection.

attachment - an arbitrary object that was attached to the session request

closed

public void closed(NHttpClientConnection conn)

Description copied from interface: NHttpClientHandler

Triggered when the connection is closed.

Specified by:

closed in interface NHttpClientHandler

Parameters:

conn - closed HTTP connection.

exception

public void exception(NHttpClientConnection conn,
                      org.apache.http.HttpException ex)

Description copied from interface: NHttpClientHandler

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

Specified by:

exception in interface NHttpClientHandler

Parameters:

conn - HTTP connection that caused an HTTP protocol violation

ex - HTTP protocol violation exception

exception

public void exception(NHttpClientConnection conn,
                      java.io.IOException ex)

Description copied from interface: NHttpClientHandler

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

Specified by:

exception in interface NHttpClientHandler

Parameters:

conn - HTTP connection that caused an I/O error

ex - I/O exception

requestReady

public void requestReady(NHttpClientConnection conn)

Description copied from interface: NHttpClientHandler

Triggered when the connection is ready to send an HTTP request.

Specified by:

requestReady in interface NHttpClientHandler

Parameters:

conn - HTTP connection that is ready to send an HTTP request

See Also:

NHttpClientConnection

inputReady

public void inputReady(NHttpClientConnection conn,
                       ContentDecoder decoder)

Description copied from interface: NHttpClientHandler

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 temorarily suspended using IOControl.suspendInput().

Specified by:

inputReady in interface NHttpClientHandler

Parameters:

conn - HTTP connection that can produce a new portion of the incoming response content.

decoder - The content decoder to use to read content.

See Also:

NHttpConnection, ContentDecoder

outputReady

public void outputReady(NHttpClientConnection conn,
                        ContentEncoder encoder)

Description copied from interface: NHttpClientHandler

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 temorarily suspended using IOControl.suspendOutput().

Specified by:

outputReady in interface NHttpClientHandler

Parameters:

conn - HTTP connection that can accommodate a new portion of the outgoing request content.

encoder - The content encoder to use to write content.

See Also:

NHttpConnection, ContentEncoder

responseReceived

public void responseReceived(NHttpClientConnection conn)

Description copied from interface: NHttpClientHandler

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 a series of NHttpClientHandler.inputReady(NHttpClientConnection, ContentDecoder) calls to transfer the response content.

Specified by:

responseReceived in interface NHttpClientHandler

Parameters:

conn - HTTP connection that contains an HTTP response

See Also:

NHttpClientConnection

timeout

public void timeout(NHttpClientConnection conn)

Description copied from interface: NHttpClientHandler

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

Specified by:

timeout in interface NHttpClientHandler

Parameters:

conn - HTTP connection that caused timeout condition.