Interface HttpEntity
-
- All Superinterfaces:
java.lang.AutoCloseable
,java.io.Closeable
,EntityDetails
- All Known Implementing Classes:
AbstractHttpEntity
,BasicHttpEntity
,BufferedHttpEntity
,ByteArrayEntity
,ByteBufferEntity
,EntityTemplate
,FileEntity
,HttpEntityWrapper
,IncomingHttpEntity
,InputStreamEntity
,NullEntity
,PathEntity
,SerializableEntity
,StringEntity
public interface HttpEntity extends EntityDetails, java.io.Closeable
An entity that can be sent or received with an HTTP message.There are three distinct types of entities in HttpCore, depending on where their
content
originates:- streamed: The content is received from a stream, or
generated on the fly. In particular, this category includes
entities being received from a
connection
.Streamed
entities are generally notrepeatable
. - self-contained: The content is in memory or obtained by
means that are independent from a connection or other entity.
Self-contained entities are generally
repeatable
. - wrapping: The content is obtained from another entity.
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.
- Since:
- 4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.io.InputStream
getContent()
Returns a content stream of the entity.Supplier<java.util.List<? extends Header>>
getTrailers()
Returns supplier of message trailers - headers sent after message body.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(java.io.OutputStream outStream)
Writes the entity content out to the output stream.-
Methods inherited from interface org.apache.hc.core5.http.EntityDetails
getContentEncoding, getContentLength, getContentType, getTrailerNames, isChunked
-
-
-
-
Method Detail
-
isRepeatable
boolean isRepeatable()
Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.- Returns:
- true if the entity is repeatable, false otherwise.
-
getContent
java.io.InputStream getContent() throws java.io.IOException, java.lang.UnsupportedOperationException
Returns a content stream of the entity.Repeatable
entities are expected to create a new instance ofInputStream
for each invocation of this method and therefore can be consumed multiple times. Entities that are notrepeatable
are expected to return the sameInputStream
instance and therefore may not be consumed more than once.If this entity belongs to an incoming HTTP message, calling
InputStream.close()
on the returnedInputStream
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.- Returns:
- content stream of the entity.
- Throws:
java.io.IOException
- if the stream could not be createdjava.lang.UnsupportedOperationException
- if entity content cannot be represented asInputStream
.- See Also:
isRepeatable()
-
writeTo
void writeTo(java.io.OutputStream outStream) throws java.io.IOException
Writes the entity content out to the output stream.IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
- Parameters:
outStream
- the output stream to write entity content to- Throws:
java.io.IOException
- if an I/O error occurs
-
isStreaming
boolean isStreaming()
Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should returntrue
. Self-contained entities should returnfalse
. Wrapping entities should delegate this call to the wrapped entity.- Returns:
true
if the entity content is streamed,false
otherwise
-
-