public class BufferedHttpEntity extends HttpEntityWrapper
| Constructor and Description |
|---|
BufferedHttpEntity(HttpEntity entity)
Creates a new buffered entity wrapper.
|
| Modifier and Type | Method and Description |
|---|---|
InputStream |
getContent()
Returns a content stream of the entity.
|
long |
getContentLength()
Returns length of the entity, 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.
|
close, getContentEncoding, getContentType, getTrailerNames, getTrailers, toStringpublic BufferedHttpEntity(HttpEntity entity) throws IOException
entity - the entity to wrap, not nullIllegalArgumentException - if wrapped is nullIOExceptionpublic long getContentLength()
EntityDetailsgetContentLength in interface EntityDetailsgetContentLength in class HttpEntityWrapperpublic 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.
If this entity belongs to an incoming HTTP message, calling
InputStream.close() on the returned InputStream will
try to consume the complete entity content to keep the connection
alive. In cases where this is undesired, e.g. when only a small part
of the content is relevant and consuming the complete entity content
would be too inefficient, only the HTTP message from which
this entity was obtained should be closed (if supported).
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 EntityDetailsisChunked in class HttpEntityWrapperfalsepublic boolean isRepeatable()
isRepeatable in interface HttpEntityisRepeatable in class HttpEntityWrappertruepublic void writeTo(OutputStream outStream) throws IOException
HttpEntityIMPORTANT: 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 toIOException - 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 otherwiseCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.