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, org.apache.http.HttpEntity, HttpAsyncContentProducer, ProducingNHttpEntity
public class NByteArrayEntity extends org.apache.http.entity.AbstractHttpEntity implements HttpAsyncContentProducer, ProducingNHttpEntity
A simple self contained, repeatable non-blocking entity that retrieves its content from a byte array.
Since:
4.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final ByteBuffer
    buffer
    Deprecated.
    (4.2)
    protected final byte[]
    content
    Deprecated.
    (4.2)

    Fields inherited from class org.apache.http.entity.AbstractHttpEntity

    chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    NByteArrayEntity(byte[] b)
     
    NByteArrayEntity(byte[] b, int off, int len)
     
    NByteArrayEntity(byte[] b, int off, int len, org.apache.http.entity.ContentType contentType)
     
    NByteArrayEntity(byte[] b, org.apache.http.entity.ContentType contentType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    void
    finish()
    Deprecated.
    (4.2) use close()
    InputStream
    getContent()
     
    long
    getContentLength()
     
    boolean
    isRepeatable()
    Determines whether or not this producer is capable of producing its content more than once.
    boolean
    isStreaming()
     
    void
    produceContent(ContentEncoder encoder, IOControl ioControl)
    Invoked to write out a chunk of content to the ContentEncoder.
    void
    writeTo(OutputStream outStream)
     

    Methods inherited from class org.apache.http.entity.AbstractHttpEntity

    consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.http.HttpEntity

    consumeContent, getContentEncoding, getContentType, isChunked

  • Field Details

  • Constructor Details

    • NByteArrayEntity

      public NByteArrayEntity(byte[] b, org.apache.http.entity.ContentType contentType)
      Since:
      4.2

    • NByteArrayEntity

      public NByteArrayEntity(byte[] b, int off, int len, org.apache.http.entity.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()
      Specified by:
      getContentLength in interface org.apache.http.HttpEntity

    • 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 org.apache.http.HttpEntity

    • isStreaming

      public boolean isStreaming()
      Specified by:
      isStreaming in interface org.apache.http.HttpEntity

    • getContent

      public InputStream getContent()
      Specified by:
      getContent in interface org.apache.http.HttpEntity

    • writeTo

      public void writeTo(OutputStream outStream) throws IOException
      Specified by:
      writeTo in interface org.apache.http.HttpEntity
      Throws:
      IOException