Class AbstractClassicEntityConsumer<T>

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractClassicEntityConsumer​(int initialBufferSize, java.util.concurrent.Executor executor)  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void consume​(java.nio.ByteBuffer src)
      Triggered to pass incoming data to the data consumer.
      protected abstract T consumeData​(ContentType contentType, java.io.InputStream inputStream)
      Processes entity data from the given stream.
      void failed​(java.lang.Exception cause)
      Triggered to signal a failure in data processing.
      T getContent()
      Returns the result of entity processing when it becomes available or null if the entity is still being received.
      java.lang.Exception getException()  
      void releaseResources()  
      void streamEnd​(java.util.List<? extends Header> trailers)
      Triggered to signal termination of the data stream.
      void streamStart​(EntityDetails entityDetails, FutureCallback<T> resultCallback)
      Signals beginning of an incoming request entity stream.
      void updateCapacity​(CapacityChannel capacityChannel)
      Triggered to signal ability of the underlying data stream to receive data capacity update.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • executor

        private final java.util.concurrent.Executor executor
      • resultRef

        private final java.util.concurrent.atomic.AtomicReference<T> resultRef
      • exceptionRef

        private final java.util.concurrent.atomic.AtomicReference<java.lang.Exception> exceptionRef
    • Constructor Detail

      • AbstractClassicEntityConsumer

        public AbstractClassicEntityConsumer​(int initialBufferSize,
                                             java.util.concurrent.Executor executor)
    • Method Detail

      • consumeData

        protected abstract T consumeData​(ContentType contentType,
                                         java.io.InputStream inputStream)
                                  throws java.io.IOException
        Processes entity data from the given stream.
        Parameters:
        contentType - the entity content type
        inputStream - the input stream
        Returns:
        the result of entity processing.
        Throws:
        java.io.IOException
      • updateCapacity

        public final void updateCapacity​(CapacityChannel capacityChannel)
                                  throws java.io.IOException
        Description copied from interface: AsyncDataConsumer
        Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point.
        Specified by:
        updateCapacity in interface AsyncDataConsumer
        Parameters:
        capacityChannel - the channel for capacity updates.
        Throws:
        java.io.IOException
      • consume

        public final void consume​(java.nio.ByteBuffer src)
                           throws java.io.IOException
        Description copied from interface: AsyncDataConsumer
        Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel.
        Specified by:
        consume in interface AsyncDataConsumer
        Parameters:
        src - data source.
        Throws:
        java.io.IOException
      • streamEnd

        public final void streamEnd​(java.util.List<? extends Header> trailers)
                             throws HttpException,
                                    java.io.IOException
        Description copied from interface: AsyncDataConsumer
        Triggered to signal termination of the data stream.
        Specified by:
        streamEnd in interface AsyncDataConsumer
        Parameters:
        trailers - data stream trailers.
        Throws:
        HttpException
        java.io.IOException
      • failed

        public final void failed​(java.lang.Exception cause)
        Description copied from interface: AsyncEntityConsumer
        Triggered to signal a failure in data processing.
        Specified by:
        failed in interface AsyncEntityConsumer<T>
        Parameters:
        cause - the cause of the failure.
      • getException

        public final java.lang.Exception getException()
      • getContent

        public final T getContent()
        Description copied from interface: AsyncEntityConsumer
        Returns the result of entity processing when it becomes available or null if the entity is still being received.
        Specified by:
        getContent in interface AsyncEntityConsumer<T>
        Returns:
        the response processing result.