java.lang.Object | |
↳ | org.apache.http.impl.conn.SingleClientConnManager |
A connection manager for a single connection. This connection manager maintains only one active connection at a time. Even though this class is thread-safe it ought to be used by one execution thread only.
SingleClientConnManager will make an effort to reuse the connection
for subsequent requests with the same route
.
It will, however, close the existing connection and open it
for the given route, if the route of the persistent connection does
not match that of the connection request. If the connection has been
already been allocated IllegalStateException
is thrown.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
SingleClientConnManager.ConnAdapter | The connection adapter used by this manager. | ||||||||||
SingleClientConnManager.PoolEntry | The pool entry for this connection manager. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | MISUSE_MESSAGE | The message to be logged on multiple allocation. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
alwaysShutDown | Whether the connection should be shut down on release. | ||||||||||
connOperator | The operator for opening and updating connections. | ||||||||||
connectionExpiresTime | The time the last released connection expires and shouldn't be reused. | ||||||||||
isShutDown | Indicates whether this connection manager is shut down. | ||||||||||
lastReleaseTime | The time of the last connection release, or -1. | ||||||||||
managedConn | The currently issued managed connection, if any. | ||||||||||
schemeRegistry | The schemes supported by this connection manager. | ||||||||||
uniquePoolEntry | The one and only entry in this pool. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This constructor is deprecated.
use
SingleClientConnManager(SchemeRegistry)
| |||||||||||
Creates a new simple connection manager.
| |||||||||||
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Closes all expired connections in the pool.
| |||||||||||
Closes idle connections in the pool.
| |||||||||||
Obtains a connection.
| |||||||||||
Obtains the scheme registry used by this manager.
| |||||||||||
Releases a connection for use by others.
| |||||||||||
Returns a new
ClientConnectionRequest , from which a
ManagedClientConnection can be obtained or the request can be
aborted. | |||||||||||
Shuts down this connection manager and releases allocated resources.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Asserts that this manager is not shut down.
| |||||||||||
Hook for creating the connection operator.
| |||||||||||
This method is deprecated.
no longer used
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.http.conn.ClientConnectionManager
|
The message to be logged on multiple allocation.
Whether the connection should be shut down on release.
The operator for opening and updating connections.
The time the last released connection expires and shouldn't be reused.
Indicates whether this connection manager is shut down.
The currently issued managed connection, if any.
The schemes supported by this connection manager.
The one and only entry in this pool.
This constructor is deprecated.
use SingleClientConnManager(SchemeRegistry)
Creates a new simple connection manager.
params | the parameters for this manager |
---|---|
schreg | the scheme registry |
Creates a new simple connection manager.
schreg | the scheme registry |
---|
Closes all expired connections in the pool. Open connections in the pool that have not been used for the timespan defined when the connection was released will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision.
Closes idle connections in the pool. Open connections in the pool that have not been used for the timespan given by the argument will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision All expired connections will also be closed.
idletime | the idle time of connections to be closed |
---|---|
tunit | the unit for the idletime |
Obtains a connection.
route | where the connection should point to |
---|
Obtains the scheme registry used by this manager.
null
Releases a connection for use by others. You may optionally specify how long the connection is valid to be reused. Values <= 0 are considered to be valid forever. If the connection is not marked as reusable, the connection will not be reused regardless of the valid duration. If the connection has been released before, the call will be ignored.
conn | the connection to release |
---|---|
validDuration | the duration of time this connection is valid for reuse |
timeUnit | the unit of time validDuration is measured in |
Returns a new ClientConnectionRequest
, from which a
ManagedClientConnection
can be obtained or the request can be
aborted.
Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.
Asserts that this manager is not shut down.
IllegalStateException | if this manager is shut down |
---|
Hook for creating the connection operator.
It is called by the constructor.
Derived classes can override this method to change the
instantiation of the operator.
The default implementation here instantiates
DefaultClientConnectionOperator
.
schreg | the scheme registry to use, or null |
---|
This method is deprecated.
no longer used