org.apache.http.nio.protocol
Class AsyncNHttpServiceHandler

java.lang.Object
  extended by org.apache.http.nio.protocol.NHttpHandlerBase
      extended by org.apache.http.nio.protocol.AsyncNHttpServiceHandler
All Implemented Interfaces:
NHttpServiceHandler

public class AsyncNHttpServiceHandler
extends NHttpHandlerBase
implements NHttpServiceHandler

HTTP service handler implementation that works with ConsumingNHttpEntity and ProducingNHttpEntity. The contents of HTTP headers are stored in memory, HTTP entities are streamed directly from the entities to the underlying channel (and vice versa).

When using this, 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 are entity requests, NHttpRequestHandlers are expected to return a ConsumingNHttpEntity for reading the content. After the entity is finished reading the data, NHttpRequestHandler.handle(HttpRequest, HttpResponse, NHttpResponseTrigger, HttpContext) is called to generate a response.

Author:
Oleg Kalnichevski, Sam Berlin, Steffen Pingel

Nested Class Summary
protected static class AsyncNHttpServiceHandler.ServerConnState
           
 
Field Summary
protected  org.apache.http.protocol.HttpExpectationVerifier expectationVerifier
           
protected  NHttpRequestHandlerResolver handlerResolver
           
protected  org.apache.http.HttpResponseFactory responseFactory
           
 
Fields inherited from class org.apache.http.nio.protocol.NHttpHandlerBase
allocator, CONN_STATE, connStrategy, eventListener, httpProcessor, params
 
Constructor Summary
AsyncNHttpServiceHandler(org.apache.http.protocol.HttpProcessor httpProcessor, org.apache.http.HttpResponseFactory responseFactory, org.apache.http.ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, org.apache.http.params.HttpParams params)
           
AsyncNHttpServiceHandler(org.apache.http.protocol.HttpProcessor httpProcessor, org.apache.http.HttpResponseFactory responseFactory, org.apache.http.ConnectionReuseStrategy connStrategy, org.apache.http.params.HttpParams params)
           
 
Method Summary
 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, org.apache.http.HttpException httpex)
          Triggered when an HTTP protocol violation occurs while receiving an HTTP request.
 void exception(NHttpServerConnection conn, java.io.IOException ex)
          Triggered when an I/O error occurrs 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.
protected  void responseComplete(org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
          Signals that this response has been fully sent.
 void responseReady(NHttpServerConnection conn)
          Triggered when the connection is ready to send an HTTP response.
 void setExpectationVerifier(org.apache.http.protocol.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.
 
Methods inherited from class org.apache.http.nio.protocol.NHttpHandlerBase
canResponseHaveBody, closeConnection, getParams, handleTimeout, setEventListener, shutdownConnection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

responseFactory

protected final org.apache.http.HttpResponseFactory responseFactory

handlerResolver

protected NHttpRequestHandlerResolver handlerResolver

expectationVerifier

protected org.apache.http.protocol.HttpExpectationVerifier expectationVerifier
Constructor Detail

AsyncNHttpServiceHandler

public AsyncNHttpServiceHandler(org.apache.http.protocol.HttpProcessor httpProcessor,
                                org.apache.http.HttpResponseFactory responseFactory,
                                org.apache.http.ConnectionReuseStrategy connStrategy,
                                ByteBufferAllocator allocator,
                                org.apache.http.params.HttpParams params)

AsyncNHttpServiceHandler

public AsyncNHttpServiceHandler(org.apache.http.protocol.HttpProcessor httpProcessor,
                                org.apache.http.HttpResponseFactory responseFactory,
                                org.apache.http.ConnectionReuseStrategy connStrategy,
                                org.apache.http.params.HttpParams params)
Method Detail

setExpectationVerifier

public void setExpectationVerifier(org.apache.http.protocol.HttpExpectationVerifier expectationVerifier)

setHandlerResolver

public void setHandlerResolver(NHttpRequestHandlerResolver handlerResolver)

connected

public void connected(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
Triggered when a new incoming connection is created.

Specified by:
connected in interface NHttpServiceHandler
Parameters:
conn - closed HTTP connection.

requestReceived

public void requestReceived(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
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 NHttpServiceHandler.inputReady(NHttpServerConnection, ContentDecoder) calls to transfer the request content.

Specified by:
requestReceived in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that contains a new HTTP request
See Also:
NHttpServerConnection

closed

public void closed(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
Triggered when the connection is closed.

Specified by:
closed in interface NHttpServiceHandler
Parameters:
conn - closed HTTP connection.

exception

public void exception(NHttpServerConnection conn,
                      org.apache.http.HttpException httpex)
Description copied from interface: NHttpServiceHandler
Triggered when an HTTP protocol violation occurs while receiving an HTTP request.

Specified by:
exception in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that caused an HTTP protocol violation
httpex - HTTP protocol violation exception

exception

public void exception(NHttpServerConnection conn,
                      java.io.IOException ex)
Description copied from interface: NHttpServiceHandler
Triggered when an I/O error occurrs while reading from or writing to the underlying channel.

Specified by:
exception in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that caused an I/O error
ex - I/O exception

timeout

public void timeout(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
Triggered when no input is detected on this connection over the maximum period of inactivity.

Specified by:
timeout in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that caused timeout condition.

inputReady

public void inputReady(NHttpServerConnection conn,
                       ContentDecoder decoder)
Description copied from interface: NHttpServiceHandler
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 temorarily suspended using IOControl.suspendInput().

Specified by:
inputReady in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that can produce a new portion of the incoming request content.
decoder - The content decoder to use to read content.
See Also:
NHttpConnection, ContentDecoder

responseReady

public void responseReady(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
Triggered when the connection is ready to send an HTTP response.

Specified by:
responseReady in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that contains an HTTP response
See Also:
NHttpServerConnection

outputReady

public void outputReady(NHttpServerConnection conn,
                        ContentEncoder encoder)
Description copied from interface: NHttpServiceHandler
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 temorarily suspended using IOControl.suspendOutput().

Specified by:
outputReady in interface NHttpServiceHandler
Parameters:
conn - HTTP connection that can accommodate a new portion of the outgoing response content.
encoder - The content encoder to use to write content.
See Also:
NHttpConnection, ContentEncoder

responseComplete

protected void responseComplete(org.apache.http.HttpResponse response,
                                org.apache.http.protocol.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.



Copyright © 2005-2008 Apache Software Foundation. All Rights Reserved.