|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.entity.HttpEntityWrapper
org.apache.http.entity.BufferedHttpEntity
@NotThreadSafe public class BufferedHttpEntity
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.
| Field Summary |
|---|
| Fields inherited from class org.apache.http.entity.HttpEntityWrapper |
|---|
wrappedEntity |
| Constructor Summary | |
|---|---|
BufferedHttpEntity(HttpEntity entity)
Creates a new buffered entity wrapper. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.apache.http.entity.HttpEntityWrapper |
|---|
consumeContent, getContentEncoding, getContentType |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BufferedHttpEntity(HttpEntity entity)
throws IOException
entity - the entity to wrap, not null
IllegalArgumentException - if wrapped is null
IOException| Method Detail |
|---|
public long getContentLength()
HttpEntity
getContentLength in interface HttpEntitygetContentLength in class HttpEntityWrapperLong.MAX_VALUE,
a negative number is returned.
public InputStream getContent()
throws IOException
HttpEntityRepeatable 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 InputStream.close() method is invoked.
getContent in interface HttpEntitygetContent in class HttpEntityWrapperIOException - if the stream could not be createdHttpEntity.isRepeatable()public boolean isChunked()
isChunked in interface HttpEntityisChunked in class HttpEntityWrapperfalsepublic boolean isRepeatable()
isRepeatable in interface HttpEntityisRepeatable in class HttpEntityWrappertrue
public void writeTo(OutputStream outstream)
throws IOException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo in interface HttpEntitywriteTo in class HttpEntityWrapperoutstream - the output stream to write entity content to
IOException - if an I/O error occurspublic boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.
isStreaming in interface HttpEntityisStreaming in class HttpEntityWrappertrue if the entity content is streamed,
false otherwise
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||