| org.apache.http.HttpEntity
All known Subclasses: org.apache.http.entity.HttpEntityWrapper, org.apache.http.entity.AbstractHttpEntity,
| HttpEntity | | public interface HttpEntity (Code) | | An entity that can be sent or received with an HTTP message.
Entities can be found in some
HttpEntityEnclosingRequest requests and in
HttpResponse responses , where they are optional.
In some places, the JavaDoc distinguishes three kinds of entities,
depending on where their
HttpEntity.getContent 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
HttpConnection connection .
HttpEntity.isStreaming Streamed entities are generally not
HttpEntity.isRepeatable repeatable .
- 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
HttpEntity.isRepeatable 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.
author:
Oleg Kalnichevski
version:
$Revision: 496070 $
since:
4.0 |
| Method Summary | |
| void | consumeContent()
Consumes the remaining content of a streamed entity.
This method is called to indicate that the content of this entity
is no longer required.
Streamed entities should dispose of the remaining content, if any.
Self-contained entities can release allocated resources, but
are not required to do anything.
Wrapping entities should delegate this call to the wrapped entity.
This method is of particular importance for entities being
received from a
HttpConnection connection . | | InputStream | getContent()
Creates a new InputStream object of the entity. | | Header | getContentEncoding()
Obtains the Content-Encoding header, if known. | | long | getContentLength()
Tells the length of the content, if known.
the number of bytes of the content, ora negative number if unknown. | | 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. | | boolean | isChunked()
Tells about chunked encoding for this entity. | | boolean | isRepeatable()
Tells if the entity is capable to produce its data more than once. | | boolean | isStreaming()
Tells whether this entity depends on an underlying stream. | | void | writeTo(OutputStream outstream)
Writes the entity content to the output stream. |
| consumeContent | | void consumeContent() throws IOException(Code) | | Consumes the remaining content of a streamed entity.
This method is called to indicate that the content of this entity
is no longer required.
Streamed entities should dispose of the remaining content, if any.
Self-contained entities can release allocated resources, but
are not required to do anything.
Wrapping entities should delegate this call to the wrapped entity.
This method is of particular importance for entities being
received from a
HttpConnection connection . The entity
needs to be consumed completely in order to re-use the connection
with keep-alive.
throws:
IOException - if an I/O error occurs.This indicates that connection keep-alive is not possible. |
| getContent | | InputStream getContent() throws IOException, IllegalStateException(Code) | | Creates a new InputStream object of the entity.
It is a programming error
to return the same InputStream object more than once.
Entities that are not
HttpEntity.isRepeatable repeatable will throw an exception if this method is called multiple times.
a new input stream that returns the entity data.
throws:
IOException - if the stream could not be created
throws:
IllegalStateException - if this entity is not repeatable and the streamhas already been obtained previously |
| getContentEncoding | | Header getContentEncoding()(Code) | | 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, ornull if the content encoding is unknown |
| getContentLength | | long getContentLength()(Code) | | Tells the length of the content, if known.
the number of bytes of the content, ora negative number if unknown. If the content length is knownbut exceeds java.lang.Long.MAX_VALUE Long.MAX_VALUE,a negative number is returned. |
| getContentType | | Header getContentType()(Code) | | 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, ornull if the content type is unknown |
| isChunked | | boolean isChunked()(Code) | | 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.
true if chunked encoding is preferred for thisentity, or false if it is not |
| isRepeatable | | boolean isRepeatable()(Code) | | Tells if the entity is capable to produce 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. |
| isStreaming | | boolean isStreaming()(Code) | | Tells whether this entity depends on an underlying stream.
Streamed entities should return true until the
content has been consumed, false afterwards.
Self-contained entities should return false.
Wrapping entities should delegate this call to the wrapped entity.
The content of a streamed entity is consumed when the stream
returned by
HttpEntity.getContent getContent has been read to EOF,
or after
HttpEntity.consumeContent consumeContent has been called.
If a streamed entity can not detect whether the stream has been
read to EOF, it should return true until
HttpEntity.consumeContent consumeContent is called.
true if the entity content is streamed andnot yet consumed, false otherwise |
| writeTo | | void writeTo(OutputStream outstream) throws IOException(Code) | | Writes the entity content to the output stream.
Parameters:
outstream - the output stream to write entity content to
throws:
IOException - if an I/O error occurs |
|
|