org.apache.http.nio.entity
Class ConsumingNHttpEntityTemplate

java.lang.Object
  org.apache.http.entity.HttpEntityWrapper
      org.apache.http.nio.entity.ConsumingNHttpEntityTemplate

All Implemented Interfaces:

HttpEntity, ConsumingNHttpEntity

public class ConsumingNHttpEntityTemplate
extends HttpEntityWrapper
implements ConsumingNHttpEntity

A ConsumingNHttpEntity that forwards available content to a ContentListener.

Since:

4.0

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

ConsumingNHttpEntityTemplate

public ConsumingNHttpEntityTemplate(HttpEntity httpEntity,
                                    ContentListener contentListener)

Method Detail

getContentListener

public ContentListener getContentListener()

getContent

public InputStream getContent()
                       throws IOException,
                              UnsupportedOperationException

Description copied from interface: HttpEntity

Creates a new InputStream object of the entity. It is a programming error to return the same InputStream object more than once. Entities that are not repeatable will throw an exception if this method is called multiple times.

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class HttpEntityWrapper

Returns:

a new input stream that returns the entity data.

Throws:

IOException - if the stream could not be created

UnsupportedOperationException

isStreaming

public boolean isStreaming()

Description copied from interface: HttpEntity

Tells whether this entity depends on an underlying stream. Streamed entities should return 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.
The content of a streamed entity is consumed when the stream returned by 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.

Specified by:

isStreaming in interface HttpEntity

Overrides:

isStreaming in class HttpEntityWrapper

Returns:

true if the entity content is streamed and not yet consumed, false otherwise

writeTo

public void writeTo(OutputStream out)
             throws IOException,
                    UnsupportedOperationException

Description copied from interface: HttpEntity

Writes the entity content to the output stream.

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class HttpEntityWrapper

Parameters:

out - the output stream to write entity content to

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException

consumeContent

public void consumeContent()
                    throws IOException

This method is equivalent to the finish() method.
TODO: The name of this method is misnomer. It will be renamed to #finish() in the next major release.

Specified by:

consumeContent in interface HttpEntity

Overrides:

consumeContent in class HttpEntityWrapper

Throws:

IOException - if an I/O error occurs. This indicates that connection keep-alive is not possible.

consumeContent

public void consumeContent(ContentDecoder decoder,
                           IOControl ioctrl)
                    throws IOException

Description copied from interface: ConsumingNHttpEntity

Notification that content is available to be read from the decoder. 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.

Specified by:

consumeContent in interface ConsumingNHttpEntity

Parameters:

decoder - content decoder.

ioctrl - I/O control of the underlying connection.

Throws:

IOException

finish

public void finish()

Description copied from interface: ConsumingNHttpEntity

Notification that any resources allocated for reading can be released.

Specified by:

finish in interface ConsumingNHttpEntity