public interface HttpEntity extends EntityDetails, Closeable
There are three distinct types of entities in HttpCore,
depending on where their
Streamedentities are generally not
This distinction is important for connection management with incoming entities. For entities that are created by an application and only sent using the HTTP components framework, the difference between streamed and self-contained is of little importance. In that case, it is suggested to consider non-repeatable entities as streamed, and those that are repeatable (without a huge effort) as self-contained.
|Modifier and Type||Method and Description|
Returns a content stream of the entity.
Returns supplier of message trailers - headers sent after message body.
Tells if the entity is capable of producing its data more than once.
Tells whether this entity depends on an underlying stream.
Writes the entity content out to the output stream.
getContentEncoding, getContentLength, getContentType, getTrailerNames, isChunked
InputStream getContent() throws IOException, UnsupportedOperationException
Repeatableentities are expected to create a new instance of
InputStreamfor each invocation of this method and therefore can be consumed multiple times. Entities that are not
repeatableare expected to return the same
InputStreaminstance 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
InputStream.close() method is invoked.
void writeTo(OutputStream outStream) throws IOException
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
outStream- the output stream to write entity content to
IOException- if an I/O error occurs
true. Self-contained entities should return
false. Wrapping entities should delegate this call to the wrapped entity.
trueif the entity content is streamed,
Copyright © 2005–2018 The Apache Software Foundation. All rights reserved.