Class BasicAsyncEntityProducer

java.lang.Object
org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer
All Implemented Interfaces:
EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder

public class BasicAsyncEntityProducer extends Object implements AsyncEntityProducer
Basic AsyncEntityProducer implementation that generates data stream from content of a byte array.
Since:
5.0
  • Field Details

    • bytebuf

      private final ByteBuffer bytebuf
    • length

      private final int length
    • contentType

      private final ContentType contentType
    • chunked

      private final boolean chunked
    • exception

      private final AtomicReference<Exception> exception
  • Constructor Details

    • BasicAsyncEntityProducer

      public BasicAsyncEntityProducer(byte[] content, ContentType contentType, boolean chunked)
    • BasicAsyncEntityProducer

      public BasicAsyncEntityProducer(byte[] content, ContentType contentType)
    • BasicAsyncEntityProducer

      public BasicAsyncEntityProducer(byte[] content)
    • BasicAsyncEntityProducer

      public BasicAsyncEntityProducer(CharSequence content, ContentType contentType, boolean chunked)
    • BasicAsyncEntityProducer

      public BasicAsyncEntityProducer(CharSequence content, ContentType contentType)
    • BasicAsyncEntityProducer

      public BasicAsyncEntityProducer(CharSequence content)
  • Method Details

    • isRepeatable

      public boolean isRepeatable()
      Description copied from interface: AsyncEntityProducer
      Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().
      Specified by:
      isRepeatable in interface AsyncEntityProducer
    • getContentType

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

      public long getContentLength()
      Description copied from interface: EntityDetails
      Returns length of the entity, if known.
      Specified by:
      getContentLength in interface EntityDetails
    • available

      public 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
    • getContentEncoding

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

      public 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 Set<String> getTrailerNames()
      Description copied from interface: EntityDetails
      Preliminary declaration of trailing headers.
      Specified by:
      getTrailerNames in interface EntityDetails
    • produce

      public final void produce(DataStreamChannel channel) throws 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:
      IOException
    • failed

      public final void failed(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 Exception getException()
    • releaseResources

      public void releaseResources()
      Specified by:
      releaseResources in interface ResourceHolder