public class

BufferedHttpEntity

extends HttpEntityWrapper
java.lang.Object
   ↳ org.apache.http.entity.HttpEntityWrapper
     ↳ org.apache.http.entity.BufferedHttpEntity

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class org.apache.http.entity.HttpEntityWrapper
Public Constructors
BufferedHttpEntity(HttpEntity entity)
Creates a new buffered entity wrapper.
Public Methods
InputStream getContent()
Returns a content stream of the entity.
long getContentLength()
Tells the length of the content, if known.
boolean isChunked()
Tells that this entity does not have to be chunked.
boolean isRepeatable()
Tells that this entity is repeatable.
boolean isStreaming()
Tells whether this entity depends on an underlying stream.
void writeTo(OutputStream outstream)
Writes the entity content out to the output stream.
[Expand]
Inherited Methods
From class org.apache.http.entity.HttpEntityWrapper
From class java.lang.Object
From interface org.apache.http.HttpEntity

Public Constructors

public BufferedHttpEntity (HttpEntity entity)

Creates a new buffered entity wrapper.

Parameters
entity the entity to wrap, not null
Throws
IllegalArgumentException if wrapped is null
IOException

Public Methods

public InputStream getContent ()

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 close() method is invoked.

Returns
  • content stream of the entity.
Throws
IOException

public long getContentLength ()

Tells the length of the content, if known.

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.

public boolean isChunked ()

Tells that this entity does not have to be chunked.

Returns
  • false

public boolean isRepeatable ()

Tells that this entity is repeatable.

Returns
  • true

public boolean isStreaming ()

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.

Returns
  • true if the entity content is streamed, false otherwise

public void writeTo (OutputStream outstream)

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.

Parameters
outstream the output stream to write entity content to
Throws
IOException