Class HttpAsyncRequestExecutor

  • All Implemented Interfaces:
    NHttpClientEventHandler

    @Contract(threading=IMMUTABLE_CONDITIONAL)
    public class HttpAsyncRequestExecutor
    extends java.lang.Object
    implements NHttpClientEventHandler
    HttpAsyncRequestExecutor is a fully asynchronous HTTP client side protocol handler based on the NIO (non-blocking) I/O model. HttpAsyncRequestExecutor translates individual events fired through the NHttpClientEventHandler interface into logically related HTTP message exchanges.

    The caller is expected to pass an instance of HttpAsyncClientExchangeHandler to be used for the next series of HTTP message exchanges through the connection context using HTTP_HANDLER attribute. HTTP exchange sequence is considered complete when the HttpAsyncClientExchangeHandler.isDone() method returns true. The HttpAsyncRequester utility class can be used to facilitate initiation of asynchronous HTTP request execution.

    Individual HttpAsyncClientExchangeHandler are expected to make use of a HttpProcessor to generate mandatory protocol headers for all outgoing messages and apply common, cross-cutting message transformations to all incoming and outgoing messages. HttpAsyncClientExchangeHandlers can delegate implementation of application specific content generation and processing to a HttpAsyncRequestProducer and a HttpAsyncResponseConsumer.

    Since:
    4.2
    See Also:
    HttpAsyncClientExchangeHandler
    • Constructor Detail

      • HttpAsyncRequestExecutor

        public HttpAsyncRequestExecutor​(int waitForContinue,
                                        org.apache.http.ExceptionLogger exceptionLogger)
        Creates new instance of HttpAsyncRequestExecutor.
        Parameters:
        waitForContinue - wait for continue time period.
        exceptionLogger - Exception logger. If null ExceptionLogger.NO_OP will be used. Please note that the exception logger will be only used to log I/O exception thrown while closing Closeable objects (such as HttpConnection).
        Since:
        4.4
      • HttpAsyncRequestExecutor

        public HttpAsyncRequestExecutor​(int waitForContinue)
        Creates new instance of HttpAsyncRequestExecutor.
        Since:
        4.3
      • HttpAsyncRequestExecutor

        public HttpAsyncRequestExecutor()
    • Method Detail

      • connected

        public void connected​(NHttpClientConnection conn,
                              java.lang.Object attachment)
                       throws java.io.IOException,
                              org.apache.http.HttpException
        Description copied from interface: NHttpClientEventHandler
        Triggered when a new outgoing connection is created.
        Specified by:
        connected in interface NHttpClientEventHandler
        Parameters:
        conn - new outgoing HTTP connection.
        attachment - an object that was attached to the session request
        Throws:
        java.io.IOException
        org.apache.http.HttpException
      • requestReady

        public void requestReady​(NHttpClientConnection conn)
                          throws java.io.IOException,
                                 org.apache.http.HttpException
        Description copied from interface: NHttpClientEventHandler
        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.
        Specified by:
        requestReady in interface NHttpClientEventHandler
        Parameters:
        conn - HTTP connection that is ready to accept a new HTTP request.
        Throws:
        java.io.IOException
        org.apache.http.HttpException
        See Also:
        NHttpClientConnection
      • outputReady

        public void outputReady​(NHttpClientConnection conn,
                                ContentEncoder encoder)
                         throws java.io.IOException,
                                org.apache.http.HttpException
        Description copied from interface: NHttpClientEventHandler
        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 outgoing content, output event notifications can be temporarily suspended using IOControl interface (super interface of NHttpClientConnection).

        Please note that the NHttpClientConnection and ContentEncoder objects are not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on other thread to resume output event notifications when more content is made available.

        Specified by:
        outputReady in interface NHttpClientEventHandler
        Parameters:
        conn - HTTP connection that can accommodate a new portion of the outgoing request content.
        encoder - The content encoder to use to write content.
        Throws:
        java.io.IOException
        org.apache.http.HttpException
        See Also:
        NHttpClientConnection, ContentEncoder, IOControl
      • inputReady

        public void inputReady​(NHttpClientConnection conn,
                               ContentDecoder decoder)
                        throws java.io.IOException,
                               org.apache.http.HttpException
        Description copied from interface: NHttpClientEventHandler
        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 incoming content, input event notifications can be temporarily suspended using IOControl interface (super interface of NHttpClientConnection).

        Please note that the NHttpClientConnection and ContentDecoder objects are not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on other thread to resume input event notifications when the handler is capable of processing more content.

        Specified by:
        inputReady in interface NHttpClientEventHandler
        Parameters:
        conn - HTTP connection that can produce a new portion of the incoming response content.
        decoder - The content decoder to use to read content.
        Throws:
        java.io.IOException
        org.apache.http.HttpException
        See Also:
        NHttpClientConnection, ContentDecoder, IOControl
      • timeout

        public void timeout​(NHttpClientConnection conn)
                     throws java.io.IOException
        Description copied from interface: NHttpClientEventHandler
        Triggered when no input is detected on this connection over the maximum period of inactivity.
        Specified by:
        timeout in interface NHttpClientEventHandler
        Parameters:
        conn - HTTP connection that caused timeout condition.
        Throws:
        java.io.IOException
      • log

        protected void log​(java.lang.Exception ex)
        This method can be used to log I/O exception thrown while closing Closeable objects (such as HttpConnection}).
        Parameters:
        ex - I/O exception thrown by Closeable.close()