Package org.apache.http.nio.entity

Class NByteArrayEntity

java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.nio.entity.NByteArrayEntity
All Implemented Interfaces:
Closeable, AutoCloseable, HttpEntity, HttpAsyncContentProducer, ProducingNHttpEntity
public class NByteArrayEntity extends AbstractHttpEntity implements HttpAsyncContentProducer, ProducingNHttpEntity
A simple self contained, repeatable non-blocking entity that retrieves its content from a byte array.
Since:
4.0

  • Field Details

    • b

      private final byte[] b

    • off

      private final int off

    • len

      private final int len

    • buf

      private final ByteBuffer buf

    • content

      @Deprecated protected final byte[] content
      Deprecated.
      (4.2)

    • buffer

      @Deprecated protected final ByteBuffer buffer
      Deprecated.
      (4.2)

  • Constructor Details

    • NByteArrayEntity

      public NByteArrayEntity(byte[] b, ContentType contentType)
      Since:
      4.2

    • NByteArrayEntity

      public NByteArrayEntity(byte[] b, int off, int len, ContentType contentType)
      Since:
      4.2

    • NByteArrayEntity

      public NByteArrayEntity(byte[] b)

    • NByteArrayEntity

      public NByteArrayEntity(byte[] b, int off, int len)

  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Since:
      4.2

    • finish

      @Deprecated public void finish()
      Deprecated.
      (4.2) use close()
      Notification that any resources allocated for writing can be released.
      Specified by:
      finish in interface ProducingNHttpEntity

    • produceContent

      public void produceContent(ContentEncoder encoder, IOControl ioControl) throws IOException
      Description copied from interface: HttpAsyncContentProducer
      Invoked to write out a chunk of content to the ContentEncoder. The IOControl interface can be used to suspend output event notifications if the entity is temporarily unable to produce more content.

      When all content is finished, the producer MUST call ContentEncoder.complete(). Failure to do so may cause the entity to be incorrectly delimited.

      Please note that the ContentEncoder object is 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:
      produceContent in interface HttpAsyncContentProducer
      Specified by:
      produceContent in interface ProducingNHttpEntity
      Parameters:
      encoder - content encoder.
      ioControl - I/O control of the underlying connection.
      Throws:
      IOException

    • getContentLength

      public long getContentLength()
      Description copied from interface: HttpEntity
      Tells the length of the content, if known.
      Specified by:
      getContentLength in interface HttpEntity
      Returns:
      the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

    • isRepeatable

      public boolean isRepeatable()
      Description copied from interface: HttpAsyncContentProducer
      Determines whether or not this producer is capable of producing its content more than once. Repeatable content producers are expected to be able to recreate their content even after having been closed.
      Specified by:
      isRepeatable in interface HttpAsyncContentProducer
      Specified by:
      isRepeatable in interface HttpEntity
      Returns:
      true if the entity is repeatable, false otherwise.

    • isStreaming

      public boolean isStreaming()
      Description copied from interface: HttpEntity
      Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
      Specified by:
      isStreaming in interface HttpEntity
      Returns:
      true if the entity content is streamed, false otherwise

    • getContent

      public InputStream getContent()
      Description copied from interface: HttpEntity
      Returns a content stream of the entity. Repeatable entities are expected to create a new instance of InputStream for each invocation of this method and therefore can be consumed multiple times. Entities that are not repeatable are expected to return the same InputStream instance and therefore may not be consumed more than once.

      IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the InputStream.close() method is invoked.

      Specified by:
      getContent in interface HttpEntity
      Returns:
      content stream of the entity.
      See Also:

    • writeTo

      public void writeTo(OutputStream outStream) throws IOException
      Description copied from interface: HttpEntity
      Writes the entity content out to the output stream.

      IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

      Specified by:
      writeTo in interface HttpEntity
      Parameters:
      outStream - the output stream to write entity content to
      Throws:
      IOException - if an I/O error occurs