Class BufferingNHttpEntity

java.lang.Object
org.apache.http.entity.HttpEntityWrapper
org.apache.http.nio.entity.BufferingNHttpEntity
All Implemented Interfaces:
HttpEntity, ConsumingNHttpEntity

@Deprecated public class BufferingNHttpEntity extends HttpEntityWrapper implements ConsumingNHttpEntity
A ConsumingNHttpEntity that consumes content into a buffer. The content can be retrieved as an InputStream via HttpEntity.getContent(), or written to an output stream via HttpEntity.writeTo(OutputStream).
Since:
4.0
  • Field Details

    • BUFFER_SIZE

      private static final int BUFFER_SIZE
      Deprecated.
      See Also:
    • buffer

      private final SimpleInputBuffer buffer
      Deprecated.
    • finished

      private boolean finished
      Deprecated.
    • consumed

      private boolean consumed
      Deprecated.
  • Constructor Details

  • Method Details

    • consumeContent

      public void consumeContent(ContentDecoder decoder, IOControl ioControl) throws IOException
      Deprecated.
      Description copied from interface: ConsumingNHttpEntity
      Notification that content is available to be read from the decoder. IOControl instance passed as a parameter to the method can be used to suspend input events if the entity is temporarily unable to allocate more storage to accommodate all incoming content.
      Specified by:
      consumeContent in interface ConsumingNHttpEntity
      Parameters:
      decoder - content decoder.
      ioControl - I/O control of the underlying connection.
      Throws:
      IOException
    • finish

      public void finish()
      Deprecated.
      Description copied from interface: ConsumingNHttpEntity
      Notification that any resources allocated for reading can be released.
      Specified by:
      finish in interface ConsumingNHttpEntity
    • getContent

      public InputStream getContent() throws IOException
      Deprecated.
      Obtains entity's content as InputStream.
      Specified by:
      getContent in interface HttpEntity
      Overrides:
      getContent in class HttpEntityWrapper
      Returns:
      content stream of the entity.
      Throws:
      IllegalStateException - if content of the entity has not been fully received or has already been consumed.
      IOException - if the stream could not be created
      See Also:
    • isRepeatable

      public boolean isRepeatable()
      Deprecated.
      Description copied from interface: HttpEntity
      Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.
      Specified by:
      isRepeatable in interface HttpEntity
      Overrides:
      isRepeatable in class HttpEntityWrapper
      Returns:
      true if the entity is repeatable, false otherwise.
    • isStreaming

      public boolean isStreaming()
      Deprecated.
      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
      Overrides:
      isStreaming in class HttpEntityWrapper
      Returns:
      true if the entity content is streamed, false otherwise
    • writeTo

      public void writeTo(OutputStream outStream) throws IOException
      Deprecated.
      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
      Overrides:
      writeTo in class HttpEntityWrapper
      Parameters:
      outStream - the output stream to write entity content to
      Throws:
      IOException - if an I/O error occurs