- All Known Implementing Classes:
public interface HttpEntityAn entity that can be sent or received with an HTTP message. Entities can be found in some
responses, where they are optional.
There are three distinct types of entities in HttpCore, depending on where their
- streamed: The content is received from a stream, or
generated on the fly. In particular, this category includes
entities being received from a
Streamedentities are generally not
- 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
- wrapping: The content is obtained from another entity.
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description
getContent()Returns a content stream of the entity.
getContentEncoding()Obtains the Content-Encoding header, if known.
getContentLength()Tells the length of the content, if known.
getContentType()Obtains the Content-Type header, if known.
isChunked()Tells about chunked encoding for this entity.
isRepeatable()Tells if the entity is capable of producing its data more than once.
isStreaming()Tells whether this entity depends on an underlying stream.
writeTo(OutputStream outstream)Writes the entity content out to the output stream.
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.
- true if the entity is repeatable, false otherwise.
boolean isChunked()Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
trueif chunked encoding is preferred for this entity, or
falseif it is not
long getContentLength()Tells the length of the content, if known.
- the number of bytes of the content, or
a negative number if unknown. If the content length is known
Long.MAX_VALUE, a negative number is returned.
Header getContentType()Obtains the Content-Type header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute.
- the Content-Type header for this entity, or
nullif the content type is unknown
Header getContentEncoding()Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.
- the Content-Encoding header for this entity, or
nullif the content encoding is unknown
InputStream getContent() throws IOException, UnsupportedOperationExceptionReturns a content stream of the entity.
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 the
InputStream.close()method is invoked.
void writeTo(OutputStream outstream) throws IOExceptionWrites 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.
outstream- the output stream to write entity content to
IOException- if an I/O error occurs
boolean isStreaming()Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return
true. Self-contained entities should return
false. Wrapping entities should delegate this call to the wrapped entity.
trueif the entity content is streamed,
@Deprecated void consumeContent() throws IOExceptionDeprecated.(4.1) Use
EntityUtils.consume(HttpEntity)This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling
InputStream.close()on the input stream returned by
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.