Package org.apache.http.entity

Class BufferedHttpEntity

java.lang.Object
org.apache.http.entity.HttpEntityWrapper
org.apache.http.entity.BufferedHttpEntity
All Implemented Interfaces:
HttpEntity
public class BufferedHttpEntity
extends HttpEntityWrapper
A wrapping entity that buffers it content if necessary. The buffered entity is always repeatable. If the wrapped entity is repeatable itself, calls are passed through. If the wrapped entity is not repeatable, the content is read into a buffer once and provided from there as often as required.
Since:
4.0
Version:
$Revision: 496070 $
Author:
Oleg Kalnichevski

  • Constructor Details

  • Method Details

    • getContentLength

      public long getContentLength()
      Description copied from interface: HttpEntity
      Tells the length of the content, if known.
      Specified by:
      getContentLength in interface HttpEntity
      Overrides:
      getContentLength in class HttpEntityWrapper
      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.

    • getContent

      public InputStream getContent() throws IOException
      Description copied from interface: HttpEntity
      Creates a new InputStream object of the entity. It is a programming error to return the same InputStream object more than once. Entities that are not repeatable will throw an exception if this method is called multiple times.
      Specified by:
      getContent in interface HttpEntity
      Overrides:
      getContent in class HttpEntityWrapper
      Returns:
      a new input stream that returns the entity data.
      Throws:
      IOException - if the stream could not be created

    • isChunked

      public boolean isChunked()
      Tells that this entity does not have to be chunked.
      Specified by:
      isChunked in interface HttpEntity
      Overrides:
      isChunked in class HttpEntityWrapper
      Returns:
      false

    • isRepeatable

      public boolean isRepeatable()
      Tells that this entity is repeatable.
      Specified by:
      isRepeatable in interface HttpEntity
      Overrides:
      isRepeatable in class HttpEntityWrapper
      Returns:
      true

    • writeTo

      public void writeTo​(OutputStream outstream) throws IOException
      Description copied from interface: HttpEntity
      Writes the entity content to the output stream.
      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

    • isStreaming

      public boolean isStreaming()
      Description copied from interface: HttpEntity
      Tells whether this entity depends on an underlying stream. Streamed entities should return true until the content has been consumed, false afterwards. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
      The content of a streamed entity is consumed when the stream returned by getContent has been read to EOF, or after consumeContent has been called. If a streamed entity can not detect whether the stream has been read to EOF, it should return true until consumeContent is called.
      Specified by:
      isStreaming in interface HttpEntity
      Overrides:
      isStreaming in class HttpEntityWrapper
      Returns:
      true if the entity content is streamed and not yet consumed, false otherwise