|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.InputStreamEntity
public class InputStreamEntity
A streamed, non-repeatable entity that obtains its content from
an InputStream
.
Field Summary |
---|
Fields inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
chunked, contentEncoding, contentType |
Constructor Summary | |
---|---|
InputStreamEntity(java.io.InputStream instream,
long length)
|
Method Summary | |
---|---|
void |
consumeContent()
Deprecated. Either use getContent() and call InputStream.close() on that;
otherwise call writeTo(OutputStream) which is required to free the resources. |
java.io.InputStream |
getContent()
Returns a content stream of the entity. |
long |
getContentLength()
Tells the length of the content, if known. |
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 class org.apache.http.entity.AbstractHttpEntity |
---|
getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InputStreamEntity(java.io.InputStream instream, long length)
Method Detail |
---|
public boolean isRepeatable()
HttpEntity
public long getContentLength()
HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public java.io.InputStream getContent() throws java.io.IOException
HttpEntity
Repeatable
entities are expected
to create a new instance of InputStream
for each invocation
of this method and therefore can be consumed multiple times.
Entities that are not repeatable
are expected
to return the same InputStream
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.
java.io.IOException
- if the stream could not be createdHttpEntity.isRepeatable()
public void writeTo(java.io.OutputStream outstream) throws java.io.IOException
HttpEntity
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
java.io.IOException
- if an I/O error occurspublic boolean isStreaming()
HttpEntity
true
. Self-contained entities should return
false
. Wrapping entities should delegate this call
to the wrapped entity.
true
if the entity content is streamed,
false
otherwisepublic void consumeContent() throws java.io.IOException
getContent()
and call InputStream.close()
on that;
otherwise call writeTo(OutputStream)
which is required to free the resources.
AbstractHttpEntity
consumeContent
in interface HttpEntity
consumeContent
in class AbstractHttpEntity
java.io.IOException
- if an I/O error occurs.and #writeTo(OutputStream)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |