@Contract(threading=IMMUTABLE_CONDITIONAL) public class HttpEntityWrapper extends Object implements HttpEntity
| Constructor and Description |
|---|
HttpEntityWrapper(HttpEntity wrappedEntity)
Creates a new entity wrapper.
|
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
InputStream |
getContent()
Returns a content stream of the entity.
|
String |
getContentEncoding()
Returns content encoding of the entity, if known.
|
long |
getContentLength()
Returns length of the entity, if known.
|
String |
getContentType()
Returns content type of the entity, if known.
|
Set<String> |
getTrailerNames()
Preliminary declaration of trailing headers.
|
Supplier<List<? extends Header>> |
getTrailers()
Returns supplier of message trailers - headers sent after message body.
|
boolean |
isChunked()
Returns chunked transfer hint 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.
|
String |
toString() |
void |
writeTo(OutputStream outStream)
Writes the entity content out to the output stream.
|
public HttpEntityWrapper(HttpEntity wrappedEntity)
wrappedEntity - the entity to wrap.public boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntitypublic boolean isChunked()
EntityDetailsThe behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked in interface EntityDetailspublic long getContentLength()
EntityDetailsgetContentLength in interface EntityDetailspublic String getContentType()
EntityDetailsgetContentType in interface EntityDetailspublic String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailspublic 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 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 otherwisepublic Supplier<List<? extends Header>> getTrailers()
HttpEntitynull if trailers are not available.getTrailers in interface HttpEntitypublic Set<String> getTrailerNames()
EntityDetailsgetTrailerNames in interface EntityDetailspublic void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableIOExceptionCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.