public class

BufferingHttpServiceHandler

extends Object
implements NHttpServiceHandler
java.lang.Object
   ↳ org.apache.http.nio.protocol.BufferingHttpServiceHandler

Class Overview

Service protocol handler implementations that provide compatibility with the blocking I/O by storing the full content of HTTP messages in memory. The handle(HttpRequest, HttpResponse, HttpContext) method will fire only when the entire message content has been read into an in-memory buffer. Please note that request processing take place the main I/O thread and therefore individual HTTP request handlers 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
BufferingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
BufferingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, HttpParams params)
Public Methods
void closed(NHttpServerConnection conn)
Triggered when the connection is closed.
void connected(NHttpServerConnection conn)
Triggered when a new incoming connection is created.
void exception(NHttpServerConnection conn, HttpException httpex)
Triggered when an HTTP protocol violation occurs while receiving an HTTP request.
void exception(NHttpServerConnection conn, IOException ioex)
Triggered when an I/O error occurs while reading from or writing to the underlying channel.
void inputReady(NHttpServerConnection conn, ContentDecoder decoder)
Triggered when the underlying channel is ready for reading a new portion of the request entity through the corresponding content decoder.
void outputReady(NHttpServerConnection conn, ContentEncoder encoder)
Triggered when the underlying channel is ready for writing a next portion of the response entity through the corresponding content encoder.
void requestReceived(NHttpServerConnection conn)
Triggered when a new HTTP request is received.
void responseReady(NHttpServerConnection conn)
Triggered when the connection is ready to accept a new HTTP response.
void setEventListener(EventListener eventListener)
void setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
void setHandlerResolver(HttpRequestHandlerResolver handlerResolver)
void timeout(NHttpServerConnection 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.NHttpServiceHandler

Public Constructors

public BufferingHttpServiceHandler (HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)

public BufferingHttpServiceHandler (HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, HttpParams params)

Public Methods

public void closed (NHttpServerConnection conn)

Triggered when the connection is closed.

Parameters
conn closed HTTP connection.

public void connected (NHttpServerConnection conn)

Triggered when a new incoming connection is created.

Parameters
conn new incoming connection HTTP connection.

public void exception (NHttpServerConnection conn, HttpException httpex)

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

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

public void exception (NHttpServerConnection 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 (NHttpServerConnection conn, ContentDecoder decoder)

Triggered when the underlying channel is ready for reading a new portion of the request 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 request content.
decoder The content decoder to use to read content.

public void outputReady (NHttpServerConnection conn, ContentEncoder encoder)

Triggered when the underlying channel is ready for writing a next portion of the response 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 response content.
encoder The content encoder to use to write content.

public void requestReceived (NHttpServerConnection conn)

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

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

Parameters
conn HTTP connection that contains a new HTTP request

public void responseReady (NHttpServerConnection conn)

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

Parameters
conn HTTP connection that contains an HTTP response

public void setEventListener (EventListener eventListener)

public void setExpectationVerifier (HttpExpectationVerifier expectationVerifier)

public void setHandlerResolver (HttpRequestHandlerResolver handlerResolver)

public void timeout (NHttpServerConnection conn)

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

Parameters
conn HTTP connection that caused timeout condition.