depends.org.apache.http.conn

类 BasicManagedEntity

java.lang.Object

depends.org.apache.http.entity.HttpEntityWrapper

depends.org.apache.http.conn.BasicManagedEntity

所有已实现的接口:

ConnectionReleaseTrigger, EofSensorWatcher, HttpEntity

@NotThreadSafe
public class BasicManagedEntity
extends HttpEntityWrapper
implements ConnectionReleaseTrigger, EofSensorWatcher

An entity that releases a connection. A ManagedClientConnection will typically not return a managed entity, but you can replace the unmanaged entity in the response with a managed one.

从以下版本开始:

4.0

字段概要

字段

限定符和类型	字段和说明
protected boolean	attemptReuse Whether to keep the connection alive.
protected ManagedClientConnection	managedConn The connection to release.

从类继承的字段 depends.org.apache.http.entity.HttpEntityWrapper

wrappedEntity

构造器概要

构造器

构造器和说明
BasicManagedEntity(HttpEntity entity, ManagedClientConnection conn, boolean reuse) Creates a new managed entity that can release a connection.

方法概要

方法

限定符和类型	方法和说明
void	abortConnection() Releases the connection without the option of keep-alive.
void	consumeContent() 已过时。 (4.1) Use EntityUtils.consume(HttpEntity)
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() Releases the connection with the option of keep-alive.
protected void	releaseManagedConnection() Releases the connection gracefully.
boolean	streamAbort(java.io.InputStream wrapped) Indicates that the stream is aborted.
boolean	streamClosed(java.io.InputStream wrapped) Indicates that the stream is closed.
void	writeTo(java.io.OutputStream outstream) Writes the entity content out to the output stream.

从类继承的方法 depends.org.apache.http.entity.HttpEntityWrapper

getContentEncoding, getContentLength, getContentType, isChunked, isStreaming

从类继承的方法 java.lang.Object

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

字段详细资料

managedConn

protected ManagedClientConnection managedConn

The connection to release.

attemptReuse

protected final boolean attemptReuse

Whether to keep the connection alive.

构造器详细资料

BasicManagedEntity

public BasicManagedEntity(HttpEntity entity,
                  ManagedClientConnection conn,
                  boolean reuse)

Creates a new managed entity that can release a connection.

参数:

entity - the entity of which to wrap the content. Note that the argument entity can no longer be used afterwards, since the content will be taken by this managed entity.

conn - the connection to release

reuse - whether the connection should be re-used

方法详细资料

isRepeatable

public boolean isRepeatable()

从接口复制的说明: 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.

指定者:

isRepeatable 在接口中 HttpEntity

覆盖:

isRepeatable 在类中 HttpEntityWrapper

返回:

true if the entity is repeatable, false otherwise.

getContent

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

从接口复制的说明: 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 tlb resources are properly deallocated after the InputStream.close() method is invoked.

指定者:

getContent 在接口中 HttpEntity

覆盖:

getContent 在类中 HttpEntityWrapper

返回:

content stream of the entity.

抛出:

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

另请参阅:

HttpEntity.isRepeatable()

consumeContent

public void consumeContent()
                    throws java.io.IOException

已过时。 (4.1) Use EntityUtils.consume(HttpEntity)

从接口复制的说明: 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 tlb 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 在接口中 HttpEntity

覆盖:

consumeContent 在类中 HttpEntityWrapper

抛出:

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

另请参阅:

and #writeTo(OutputStream)

writeTo

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

从接口复制的说明: HttpEntity

Writes the entity content out to the output stream.

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

指定者:

writeTo 在接口中 HttpEntity

覆盖:

writeTo 在类中 HttpEntityWrapper

参数:

outstream - the output stream to write entity content to

抛出:

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

releaseConnection

public void releaseConnection()
                       throws java.io.IOException

从接口复制的说明: ConnectionReleaseTrigger

Releases the connection with the option of keep-alive. This is a "graceful" release and may cause IO operations for consuming the remainder of a response entity. Use abortConnection for a hard release. The connection may be reused as specified by the duration.

指定者:

releaseConnection 在接口中 ConnectionReleaseTrigger

抛出:

java.io.IOException - in case of an IO problem. The connection will be released anyway.

abortConnection

public void abortConnection()
                     throws java.io.IOException

从接口复制的说明: ConnectionReleaseTrigger

Releases the connection without the option of keep-alive. This is a "hard" release that implies a shutdown of the connection. Use ConnectionReleaseTrigger.releaseConnection() for a graceful release.

指定者:

abortConnection 在接口中 ConnectionReleaseTrigger

抛出:

java.io.IOException - in case of an IO problem. The connection will be released anyway.

eofDetected

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

从接口复制的说明: EofSensorWatcher

Indicates that EOF is detected.

指定者:

eofDetected 在接口中 EofSensorWatcher

参数:

wrapped - the underlying stream which has reached EOF

返回:

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

抛出:

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

从接口复制的说明: EofSensorWatcher

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

指定者:

streamClosed 在接口中 EofSensorWatcher

参数:

wrapped - the underlying stream which has not reached EOF

返回:

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

抛出:

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

从接口复制的说明: 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.

指定者:

streamAbort 在接口中 EofSensorWatcher

参数:

wrapped - the underlying stream which has not reached EOF

返回:

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

抛出:

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.

releaseManagedConnection

protected void releaseManagedConnection()
                                 throws java.io.IOException

Releases the connection gracefully. The connection attribute will be nullified. Subsequent invocations are no-ops.

抛出:

java.io.IOException - in case of an IO problem. The connection attribute will be nullified anyway.