class ResponseEntityProxy extends HttpEntityWrapper implements EofSensorWatcher
HttpEntity
enclosed in a response message.Modifier and Type | Field and Description |
---|---|
private ConnectionHolder |
connHolder |
wrappedEntity
Constructor and Description |
---|
ResponseEntityProxy(HttpEntity entity,
ConnectionHolder connHolder) |
Modifier and Type | Method and Description |
---|---|
private void |
abortConnection() |
private void |
cleanup() |
void |
consumeContent()
Deprecated.
|
static void |
enchance(HttpResponse response,
ConnectionHolder connHolder) |
boolean |
eofDetected(InputStream wrapped)
Indicates that EOF is detected.
|
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(InputStream wrapped)
Indicates that the
stream is aborted. |
boolean |
streamClosed(InputStream wrapped)
Indicates that the
stream is closed. |
String |
toString() |
void |
writeTo(OutputStream outstream)
Writes the entity content out to the output stream.
|
getContentEncoding, getContentLength, getContentType, isChunked, isStreaming
private final ConnectionHolder connHolder
ResponseEntityProxy(HttpEntity entity, ConnectionHolder connHolder)
public static void enchance(HttpResponse response, ConnectionHolder connHolder)
private void cleanup() throws IOException
IOException
private void abortConnection() throws IOException
IOException
public void releaseConnection() throws IOException
IOException
public boolean isRepeatable()
HttpEntity
isRepeatable
in interface HttpEntity
isRepeatable
in class HttpEntityWrapper
public InputStream getContent() throws IOException
HttpEntity
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.
getContent
in interface HttpEntity
getContent
in class HttpEntityWrapper
IOException
- if the stream could not be createdHttpEntity.isRepeatable()
@Deprecated public void consumeContent() throws IOException
HttpEntity
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.
consumeContent
in interface HttpEntity
consumeContent
in class HttpEntityWrapper
IOException
- if an I/O error occurs.and #writeTo(OutputStream)
public void writeTo(OutputStream outstream) throws IOException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo
in interface HttpEntity
writeTo
in class HttpEntityWrapper
outstream
- the output stream to write entity content toIOException
- if an I/O error occurspublic boolean eofDetected(InputStream wrapped) throws IOException
EofSensorWatcher
eofDetected
in interface EofSensorWatcher
wrapped
- the underlying stream which has reached EOFtrue
if wrapped
should be closed,
false
if it should be left aloneIOException
- 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.public boolean streamClosed(InputStream wrapped) throws IOException
EofSensorWatcher
stream
is closed.
This method will be called only if EOF was not detected
before closing. Otherwise, eofDetected
is called.streamClosed
in interface EofSensorWatcher
wrapped
- the underlying stream which has not reached EOFtrue
if wrapped
should be closed,
false
if it should be left aloneIOException
- 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.public boolean streamAbort(InputStream wrapped) throws IOException
EofSensorWatcher
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.
streamAbort
in interface EofSensorWatcher
wrapped
- the underlying stream which has not reached EOFtrue
if wrapped
should be closed,
false
if it should be left aloneIOException
- 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.WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses