Build 1.0_r1(from source)

org.apache.http.entity
Class HttpEntityWrapper

java.lang.Object
  extended by org.apache.http.entity.HttpEntityWrapper
All Implemented Interfaces:
HttpEntity
Direct Known Subclasses:
BasicManagedEntity, BufferedHttpEntity

public class HttpEntityWrapper
extends Object
implements HttpEntity

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.

Since:
4.0

Field Summary
protected  HttpEntity wrappedEntity
          The wrapped entity.
 
Constructor Summary
HttpEntityWrapper(HttpEntity wrapped)
          Creates a new entity wrapper.
 
Method Summary
 void consumeContent()
          TODO: The name of this method is misnomer.
 InputStream getContent()
          Creates a new InputStream object 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 to produce its data more than once.
 boolean isStreaming()
          Tells whether this entity depends on an underlying stream.
 void writeTo(OutputStream outstream)
          Writes the entity content to the output stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

wrappedEntity

protected HttpEntity wrappedEntity
The wrapped entity.

Constructor Detail

HttpEntityWrapper

public HttpEntityWrapper(HttpEntity wrapped)
Creates a new entity wrapper.

Parameters:
wrapped - the entity to wrap
Method Detail

isRepeatable

public boolean isRepeatable()
Description copied from interface: HttpEntity
Tells if the entity is capable to produce 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
Returns:
true if the entity is repeatable, false otherwise.

isChunked

public boolean isChunked()
Description copied from interface: HttpEntity
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.

Specified by:
isChunked in interface HttpEntity
Returns:
true if chunked encoding is preferred for this entity, or false if it is not

getContentLength

public long getContentLength()
Description copied from interface: HttpEntity
Tells the length of the content, if known.

Specified by:
getContentLength in interface HttpEntity
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.

getContentType

public Header getContentType()
Description copied from interface: HttpEntity
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.

Specified by:
getContentType in interface HttpEntity
Returns:
the Content-Type header for this entity, or null if the content type is unknown

getContentEncoding

public Header getContentEncoding()
Description copied from interface: HttpEntity
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.

Specified by:
getContentEncoding in interface HttpEntity
Returns:
the Content-Encoding header for this entity, or null if the content encoding is unknown

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
Returns:
a new input stream that returns the entity data.
Throws:
IOException - if the stream could not be created

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
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
Returns:
true if the entity content is streamed and not yet consumed, false otherwise

consumeContent

public void consumeContent()
                    throws IOException
Description copied from interface: HttpEntity
TODO: The name of this method is misnomer. It will be renamed to #finish() in the next major release.
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.

Specified by:
consumeContent in interface HttpEntity
Throws:
IOException - if an I/O error occurs. This indicates that connection keep-alive is not possible.

Build 1.0_r1(from source)

Please submit a feedback, bug or feature