public class

HttpEntityWrapper

extends Object
implements HttpEntity
java.lang.Object
   ↳ org.apache.http.entity.HttpEntityWrapper
Known Direct Subclasses

Class Overview

Base class for wrapping entities. Keeps a wrappedEntity and delegates all calls to it. Implementations of wrapping entities can derive from this class and need to override only those methods that should not be delegated to the wrapped entity.

Summary

Fields
protected HttpEntity wrappedEntity The wrapped entity.
Public Constructors
HttpEntityWrapper(HttpEntity wrapped)
Creates a new entity wrapper.
Public Methods
void consumeContent()
This method is deprecated. Either use getContent() and call close() on that; otherwise call writeTo(OutputStream) which is required to free the resources.
InputStream getContent()
Returns a content stream of the entity.
Header getContentEncoding()
Obtains the Content-Encoding header, if known.
long getContentLength()
Tells the length of the content, if known.
Header getContentType()
Obtains the Content-Type header, if known.
boolean isChunked()
Tells about chunked encoding for this entity.
boolean isRepeatable()
Tells if the entity is capable of producing its data more than once.
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 java.lang.Object
From interface org.apache.http.HttpEntity

Fields

protected HttpEntity wrappedEntity

The wrapped entity.

Public Constructors

public HttpEntityWrapper (HttpEntity wrapped)

Creates a new entity wrapper.

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

Public Methods

public void consumeContent ()

This method is deprecated.
Either use getContent() and call close() on that; otherwise call writeTo(OutputStream) which is required to free the resources.

This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling close() on the input stream returned by getContent()

This method is called to indicate that the content of this entity is no longer required. All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity.

This method is of particular importance for entities being received from a connection. The entity needs to be consumed completely in order to re-use the connection with keep-alive.

Throws
IOException

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 Header getContentEncoding ()

Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.

Returns
  • the Content-Encoding header for this entity, or null if the content encoding is unknown

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 Header getContentType ()

Obtains the Content-Type header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute.

Returns
  • the Content-Type header for this entity, or null if the content type is unknown

public boolean isChunked ()

Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

Returns
  • true if chunked encoding is preferred for this entity, or false if it is not

public boolean isRepeatable ()

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.

Returns
  • true if the entity is repeatable, false otherwise.

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