|
||||||||||
| 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
BasicAsyncRequestConsumer or BasicAsyncResponseConsumer
@Deprecated 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)
Deprecated. |
|
| Method Summary | |
|---|---|
void |
consumeContent()
Deprecated. This method is equivalent to the finish() method. |
void |
consumeContent(ContentDecoder decoder,
IOControl ioctrl)
Deprecated. Notification that content is available to be read from the decoder. |
void |
finish()
Deprecated. Notification that any resources allocated for reading can be released. |
InputStream |
getContent()
Deprecated. Returns a content stream of the entity. |
ContentListener |
getContentListener()
Deprecated. |
boolean |
isStreaming()
Deprecated. Tells whether this entity depends on an underlying stream. |
void |
writeTo(OutputStream out)
Deprecated. Writes the entity content out 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
HttpEntityRepeatable 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.
getContent in interface HttpEntitygetContent in class HttpEntityWrapperIOException - if the stream could not be created
UnsupportedOperationExceptionHttpEntity.isRepeatable()public boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.
isStreaming in interface HttpEntityisStreaming in class HttpEntityWrappertrue if the entity content is streamed,
false otherwise
public void writeTo(OutputStream out)
throws IOException,
UnsupportedOperationException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo in interface HttpEntitywriteTo in class HttpEntityWrapperout - 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 HttpEntityconsumeContent in class HttpEntityWrapperIOException - if an I/O error occurs.and #writeTo(OutputStream)
public void consumeContent(ContentDecoder decoder,
IOControl ioctrl)
throws IOException
ConsumingNHttpEntityIOControl 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 ConsumingNHttpEntitydecoder - content decoder.ioctrl - I/O control of the underlying connection.
IOExceptionpublic void finish()
ConsumingNHttpEntity
finish in interface ConsumingNHttpEntity
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||