org.apache.http.impl.execchain

Class ResponseEntityProxy

java.lang.Object

org.apache.http.entity.HttpEntityWrapper

org.apache.http.impl.execchain.ResponseEntityProxy

All Implemented Interfaces:

EofSensorWatcher, HttpEntity

@NotThreadSafe
 class ResponseEntityProxy
extends HttpEntityWrapper
implements EofSensorWatcher

A wrapper class for HttpEntity enclosed in a response message.

Since:

4.3

Field Summary

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

wrappedEntity

Constructor Summary

Constructors

Constructor and Description
ResponseEntityProxy(HttpEntity entity, ConnectionHolder connHolder)

Method Summary

Methods

Modifier and Type	Method and Description
void	consumeContent() Deprecated.
static void	enchance(HttpResponse response, ConnectionHolder connHolder)
boolean	eofDetected(java.io.InputStream wrapped) Indicates that EOF is detected.
java.io.InputStream	getContent() Returns a content stream of the entity.
boolean	isRepeatable() Tells if the entity is capable of producing its data more than once.
void	releaseConnection()
boolean	streamAbort(java.io.InputStream wrapped) Indicates that the stream is aborted.
boolean	streamClosed(java.io.InputStream wrapped) Indicates that the stream is closed.
java.lang.String	toString()
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, isStreaming

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseEntityProxy

ResponseEntityProxy(HttpEntity entity,
                   ConnectionHolder connHolder)

Method Detail

enchance

public static void enchance(HttpResponse response,
            ConnectionHolder connHolder)

releaseConnection

public void releaseConnection()
                       throws java.io.IOException

Throws:

java.io.IOException

isRepeatable

public boolean isRepeatable()

Description copied from interface: HttpEntity

Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class HttpEntityWrapper

Returns:

true if the entity is repeatable, false otherwise.

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()

consumeContent

@Deprecated
public void consumeContent()
                    throws java.io.IOException

Deprecated.

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)

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

eofDetected

public boolean eofDetected(java.io.InputStream wrapped)
                    throws java.io.IOException

Description copied from interface: EofSensorWatcher

Indicates that EOF is detected.

Specified by:

eofDetected in interface EofSensorWatcher

Parameters:

wrapped - the underlying stream which has reached EOF

Returns:

true if wrapped should be closed, false if it should be left alone

Throws:

java.io.IOException - in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

streamClosed

public boolean streamClosed(java.io.InputStream wrapped)
                     throws java.io.IOException

Description copied from interface: EofSensorWatcher

Indicates that the stream is closed. This method will be called only if EOF was not detected before closing. Otherwise, eofDetected is called.

Specified by:

streamClosed in interface EofSensorWatcher

Parameters:

wrapped - the underlying stream which has not reached EOF

Returns:

true if wrapped should be closed, false if it should be left alone

Throws:

java.io.IOException - in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

streamAbort

public boolean streamAbort(java.io.InputStream wrapped)
                    throws java.io.IOException

Description copied from interface: EofSensorWatcher

Indicates that the stream is aborted. This method will be called only if EOF was not detected before aborting. Otherwise, eofDetected is called.

This method will also be invoked when an input operation causes an IOException to be thrown to make sure the input stream gets shut down.

Specified by:

streamAbort in interface EofSensorWatcher

Parameters:

wrapped - the underlying stream which has not reached EOF

Returns:

true if wrapped should be closed, false if it should be left alone

Throws:

java.io.IOException - in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object