Package org.apache.http.entity
Class EntityTemplate
java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.EntityTemplate
- All Implemented Interfaces:
HttpEntity
Entity that delegates the process of content generation
to a
ContentProducer
.- Since:
- 4.0
-
Field Summary
FieldsFields inherited from class org.apache.http.entity.AbstractHttpEntity
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a content stream of the entity.long
Tells the length of the content, if known.boolean
Tells if the entity is capable of producing its data more than once.boolean
Tells whether this entity depends on an underlying stream.void
writeTo
(OutputStream outStream) Writes the entity content out to the output stream.Methods inherited from class org.apache.http.entity.AbstractHttpEntity
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString
-
Field Details
-
contentproducer
-
-
Constructor Details
-
EntityTemplate
-
-
Method Details
-
getContentLength
public long getContentLength()Description copied from interface:HttpEntity
Tells the length of the content, if known.- Returns:
- the number of bytes of the content, or
a negative number if unknown. If the content length is known
but exceeds
Long.MAX_VALUE
, a negative number is returned.
-
getContent
Description copied from interface:HttpEntity
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.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:
IOException
- if the stream could not be created- See Also:
-
isRepeatable
public boolean isRepeatable()Description copied from interface:HttpEntity
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.
-
writeTo
Description copied from interface:HttpEntity
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:
IOException
- if an I/O error occurs
-
isStreaming
public boolean isStreaming()Description copied from interface:HttpEntity
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
-