org.apache.http.impl.client

Class EntityEnclosingRequestWrapper.EntityWrapper

java.lang.Object

org.apache.http.entity.HttpEntityWrapper

org.apache.http.impl.client.EntityEnclosingRequestWrapper.EntityWrapper

All Implemented Interfaces:

HttpEntity

Enclosing class:

EntityEnclosingRequestWrapper

 class EntityEnclosingRequestWrapper.EntityWrapper
extends HttpEntityWrapper

Field Summary

Fields inherited from class org.apache.http.entity.HttpEntityWrapper

wrappedEntity

Constructor Summary

Constructors

Constructor and Description
EntityEnclosingRequestWrapper.EntityWrapper(HttpEntity entity)

Method Summary

Methods

Modifier and Type	Method and Description
void	consumeContent() This method is deprecated since version 4.1.
java.io.InputStream	getContent() Returns a content stream of the entity.
void	writeTo(java.io.OutputStream outstream) Writes the entity content out to the output stream.

Methods inherited from class org.apache.http.entity.HttpEntityWrapper

getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable, isStreaming

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityEnclosingRequestWrapper.EntityWrapper

EntityEnclosingRequestWrapper.EntityWrapper(HttpEntity entity)

Method Detail

consumeContent

public void consumeContent()
                    throws java.io.IOException

Description copied from interface: HttpEntity

This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling InputStream.close() on the input stream returned by HttpEntity.getContent()

This method is called to indicate that the content of this entity is no longer required. All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity.

This method is of particular importance for entities being received from a connection. The entity needs to be consumed completely in order to re-use the connection with keep-alive.

Specified by:

consumeContent in interface HttpEntity

Overrides:

consumeContent in class HttpEntityWrapper

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

and #writeTo(OutputStream)

getContent

public java.io.InputStream getContent()
                               throws java.io.IOException

Description copied from interface: HttpEntity

Returns a content stream of the entity. 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.

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class HttpEntityWrapper

Returns:

content stream of the entity.

Throws:

java.io.IOException - if the stream could not be created

See Also:

HttpEntity.isRepeatable()

writeTo

public void writeTo(java.io.OutputStream outstream)
             throws java.io.IOException

Description copied from interface: HttpEntity

Writes the entity content out to the output stream.

IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class HttpEntityWrapper

Parameters:

outstream - the output stream to write entity content to

Throws:

java.io.IOException - if an I/O error occurs