public class HttpEntityWrapper extends Object implements HttpEntity
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.| Modifier and Type | Field and Description |
|---|---|
protected HttpEntity |
wrappedEntity
The wrapped entity.
|
| Constructor and Description |
|---|
HttpEntityWrapper(HttpEntity wrappedEntity)
Creates a new entity wrapper.
|
| Modifier and Type | Method and Description |
|---|---|
void |
consumeContent()
Deprecated.
(4.1) Either use
getContent() and call InputStream.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.
|
protected HttpEntity wrappedEntity
public HttpEntityWrapper(HttpEntity wrappedEntity)
wrappedEntity - the entity to wrap.public boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntitypublic boolean isChunked()
HttpEntityThe behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked in interface HttpEntitytrue if chunked encoding is preferred for this
entity, or false if it is notpublic long getContentLength()
HttpEntitygetContentLength in interface HttpEntityLong.MAX_VALUE,
a negative number is returned.public Header getContentType()
HttpEntitygetContentType in interface HttpEntitynull if the content type is unknownpublic Header getContentEncoding()
HttpEntitygetContentEncoding in interface HttpEntitynull if the content encoding is unknownpublic 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 HttpEntityIOException - if the stream could not be createdHttpEntity.isRepeatable()public 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 HttpEntityoutStream - 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 HttpEntitytrue if the entity content is streamed,
false otherwise@Deprecated public void consumeContent() throws IOException
getContent() and call InputStream.close() on that;
otherwise call writeTo(OutputStream) which is required to free the resources.HttpEntityInputStream.close() on the input stream returned by
HttpEntity.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.
consumeContent in interface HttpEntityIOException - if an I/O error occurs.and #writeTo(OutputStream)Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.