|
||||||||||
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()
This method is equivalent to the finish() method. |
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. |
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(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 InputStream getContent() throws IOException, UnsupportedOperationException
HttpEntity
repeatable
will throw an exception if this method is called multiple times.
getContent
in interface HttpEntity
getContent
in class HttpEntityWrapper
IOException
- if the stream could not be created
UnsupportedOperationException
public 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(OutputStream out) throws IOException, UnsupportedOperationException
HttpEntity
writeTo
in interface HttpEntity
writeTo
in class HttpEntityWrapper
out
- the output stream to write entity content to
IOException
- if an I/O error occurs
UnsupportedOperationException
public void consumeContent() throws IOException
finish()
method.
consumeContent
in interface HttpEntity
consumeContent
in class HttpEntityWrapper
IOException
- if an I/O error occurs.
This indicates that connection keep-alive is not possible.public void consumeContent(ContentDecoder decoder, IOControl ioctrl) throws IOException
ConsumingNHttpEntity
IOControl
instance passed as a parameter to the method can be
used to suspend input events if the entity is temporarily unable to
allocate more storage to accommodate all incoming content.
consumeContent
in interface ConsumingNHttpEntity
decoder
- content decoder.ioctrl
- I/O control of the underlying connection.
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 |