public class

AsyncNHttpServiceHandler

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

Class Overview

Fully asynchronous HTTP server side protocol handler implementation that implements the essential requirements of the HTTP protocol for the server side message processing as described by RFC 2616. It is capable of processing HTTP requests with nearly constant memory footprint. Only HTTP message heads are stored in memory, while content of message bodies is streamed directly from the entity to the underlying channel (and vice versa) ConsumingNHttpEntity and ProducingNHttpEntity interfaces.

When using this class, it is important to ensure that entities supplied for writing implement ProducingNHttpEntity. Doing so will allow the entity to be written out asynchronously. If entities supplied for writing do not implement ProducingNHttpEntity, a delegate is added that buffers the entire contents in memory. Additionally, the buffering might take place in the I/O thread, which could cause I/O to block temporarily. For best results, ensure that all entities set on HttpResponses from NHttpRequestHandlers implement ProducingNHttpEntity.

If incoming requests enclose a content entity, NHttpRequestHandlers are expected to return a ConsumingNHttpEntity for reading the content. After the entity is finished reading the data, handle(HttpRequest, HttpResponse, NHttpResponseTrigger, HttpContext) is called to generate a response.

Individual NHttpRequestHandlers do not have to submit a response immediately. They can defer transmission of the HTTP response back to the client without blocking the I/O thread and to delegate the processing the HTTP request to a worker thread. The worker thread in its turn can use an instance of NHttpResponseTrigger passed as a parameter to submit a response as at a later point of time once the response becomes available.

See Also

Summary

Nested Classes
class AsyncNHttpServiceHandler.ServerConnState  
[Expand]
Inherited Constants
From class org.apache.http.nio.protocol.NHttpHandlerBase
Fields
protected HttpExpectationVerifier expectationVerifier
protected NHttpRequestHandlerResolver handlerResolver
protected final HttpResponseFactory responseFactory
[Expand]
Inherited Fields
From class org.apache.http.nio.protocol.NHttpHandlerBase
Public Constructors
AsyncNHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
AsyncNHttpServiceHandler(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 ex)
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 setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
void setHandlerResolver(NHttpRequestHandlerResolver handlerResolver)
void timeout(NHttpServerConnection conn)
Triggered when no input is detected on this connection over the maximum period of inactivity.
Protected Methods
void responseComplete(HttpResponse response, HttpContext context)
Signals that this response has been fully sent.
[Expand]
Inherited Methods
From class org.apache.http.nio.protocol.NHttpHandlerBase
From class java.lang.Object
From interface org.apache.http.nio.NHttpServiceHandler

Fields

protected HttpExpectationVerifier expectationVerifier

protected NHttpRequestHandlerResolver handlerResolver

protected final HttpResponseFactory responseFactory

Public Constructors

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

public AsyncNHttpServiceHandler (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 ex)

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
ex 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 setExpectationVerifier (HttpExpectationVerifier expectationVerifier)

public void setHandlerResolver (NHttpRequestHandlerResolver 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.

Protected Methods

protected void responseComplete (HttpResponse response, HttpContext context)

Signals that this response has been fully sent. This will be called after submitting the response to a connection, if there is no entity in the response. If there is an entity, it will be called after the entity has completed.