public Class HttpEntityWrapper

Creates a new entity wrapper.

Parameters

wrappedEntity:HttpEntity

the entity to wrap.

Implements org.apache.http.HttpEntity.consumeContent.

Doc from org.apache.http.HttpEntity.consumeContent.

This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling InputStream#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.

Annotations

@Override

@Deprecated

Exceptions

IOException:

if an I/O error occurs.

Implements org.apache.http.HttpEntity.getContent.

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

Returns:InputStream

content stream of the entity.

Annotations

@Override

Exceptions

IOException:

if the stream could not be created

Implements org.apache.http.HttpEntity.getContentEncoding.

Doc from org.apache.http.HttpEntity.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:Header

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

Annotations

@Override

Implements org.apache.http.HttpEntity.getContentLength.

Doc from org.apache.http.HttpEntity.getContentLength.

Tells the length of the content, if known.

Returns:long

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.

Annotations

@Override

Implements org.apache.http.HttpEntity.getContentType.

Doc from org.apache.http.HttpEntity.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:Header

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

Annotations

@Override

Implements org.apache.http.HttpEntity.isChunked.

Doc from org.apache.http.HttpEntity.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:boolean

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

Annotations

@Override

Implements org.apache.http.HttpEntity.isRepeatable.

Doc from org.apache.http.HttpEntity.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:boolean

true if the entity is repeatable, false otherwise.

Annotations

@Override

Implements org.apache.http.HttpEntity.isStreaming.

Doc from org.apache.http.HttpEntity.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:boolean

true if the entity content is streamed, false otherwise

Annotations

@Override

Implements org.apache.http.HttpEntity.writeTo.

Doc from org.apache.http.HttpEntity.writeTo.

Writes the entity content out to the output stream.

Parameters

outStream:OutputStream

the output stream to write entity content to

Annotations

@Override

Exceptions

IOException:

if an I/O error occurs