Class AbstractClassicEntityProducer

    • Field Detail

      • executor

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

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

      • AbstractClassicEntityProducer

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

      • produceData

        protected abstract void produceData​(ContentType contentType,
                                            java.io.OutputStream outputStream)
                                     throws java.io.IOException
        Writes out entity data into the given stream.
        Parameters:
        contentType - the entity content type
        outputStream - the output stream
        Throws:
        java.io.IOException
      • available

        public final int available()
        Description copied from interface: AsyncDataProducer
        Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.
        Specified by:
        available in interface AsyncDataProducer
        Returns:
        the number of bytes immediately available for output
      • produce

        public final void produce​(DataStreamChannel channel)
                           throws java.io.IOException
        Description copied from interface: AsyncDataProducer
        Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.
        Specified by:
        produce in interface AsyncDataProducer
        Parameters:
        channel - the data channel capable to accepting more data.
        Throws:
        java.io.IOException
      • getContentType

        public final java.lang.String getContentType()
        Description copied from interface: EntityDetails
        Returns content type of the entity, if known.
        Specified by:
        getContentType in interface EntityDetails
      • getContentEncoding

        public java.lang.String getContentEncoding()
        Description copied from interface: EntityDetails
        Returns content encoding of the entity, if known.
        Specified by:
        getContentEncoding in interface EntityDetails
      • isChunked

        public final boolean isChunked()
        Description copied from interface: EntityDetails
        Returns chunked transfer hint for this entity.

        The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

        Specified by:
        isChunked in interface EntityDetails
      • getTrailerNames

        public final java.util.Set<java.lang.String> getTrailerNames()
        Description copied from interface: EntityDetails
        Preliminary declaration of trailing headers.
        Specified by:
        getTrailerNames in interface EntityDetails
      • failed

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

        public final java.lang.Exception getException()