|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.HttpEntityWrapper
org.apache.http.nio.entity.ConsumingNHttpEntityTemplate
public class ConsumingNHttpEntityTemplate
A ConsumingNHttpEntity
that forwards available content to a
ContentListener
.
Field Summary |
---|
Fields inherited from class org.apache.http.entity.HttpEntityWrapper |
---|
wrappedEntity |
Constructor Summary | |
---|---|
ConsumingNHttpEntityTemplate(HttpEntity httpEntity,
ContentListener contentListener)
|
Method Summary | |
---|---|
void |
consumeContent()
TODO: The name of this method is misnomer. |
void |
consumeContent(ContentDecoder decoder,
IOControl ioctrl)
Notification that content is available to be read from the decoder. |
void |
finish()
Notification that any resources allocated for reading can be released. |
java.io.InputStream |
getContent()
Creates a new InputStream object of the entity. |
ContentListener |
getContentListener()
|
boolean |
isStreaming()
Tells whether this entity depends on an underlying stream. |
void |
writeTo(java.io.OutputStream out)
Writes the entity content to the output stream. |
Methods inherited from class org.apache.http.entity.HttpEntityWrapper |
---|
getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.http.HttpEntity |
---|
getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable |
Constructor Detail |
---|
public ConsumingNHttpEntityTemplate(HttpEntity httpEntity, ContentListener contentListener)
Method Detail |
---|
public ContentListener getContentListener()
public java.io.InputStream getContent() throws java.io.IOException, java.lang.IllegalStateException
HttpEntity
repeatable
will throw an exception if this method is called multiple times.
getContent
in interface HttpEntity
getContent
in class HttpEntityWrapper
java.io.IOException
- if the stream could not be created
java.lang.IllegalStateException
- if this entity is not repeatable and the stream
has already been obtained previouslypublic boolean isStreaming()
HttpEntity
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.
getContent
has been read to EOF,
or after consumeContent
has been called.
If a streamed entity can not detect whether the stream has been
read to EOF, it should return true
until
consumeContent
is called.
isStreaming
in interface HttpEntity
isStreaming
in class HttpEntityWrapper
true
if the entity content is streamed and
not yet consumed, false
otherwisepublic void writeTo(java.io.OutputStream out) throws java.io.IOException
HttpEntity
writeTo
in interface HttpEntity
writeTo
in class HttpEntityWrapper
out
- the output stream to write entity content to
java.io.IOException
- if an I/O error occurspublic void consumeContent() throws java.io.IOException, java.lang.UnsupportedOperationException
HttpEntity
connection
. The entity
needs to be consumed completely in order to re-use the connection
with keep-alive.
consumeContent
in interface HttpEntity
consumeContent
in class HttpEntityWrapper
java.io.IOException
- if an I/O error occurs.
This indicates that connection keep-alive is not possible.
java.lang.UnsupportedOperationException
public void consumeContent(ContentDecoder decoder, IOControl ioctrl) throws java.io.IOException
ConsumingNHttpEntity
consumeContent
in interface ConsumingNHttpEntity
java.io.IOException
public void finish()
ConsumingNHttpEntity
finish
in interface ConsumingNHttpEntity
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |