| java.lang.Object | |
| ↳ | org.apache.http.impl.conn.SingleClientConnManager |
A connection "manager" for a single connection.
This manager is good only for single-threaded use.
Allocation always returns the connection immediately,
even if it has not been released after the previous allocation.
In that case, a warning is logged
and the previously issued connection is revoked.
This class is derived from SimpleHttpConnectionManager
in HttpClient 3. See there for original authors.
| 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 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
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.
| |||||||||||
Invoked when the garbage collector has detected that this instance is no longer reachable.
| |||||||||||
Revokes the currently issued connection.
| |||||||||||
|
[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.
Creates a new simple connection manager.
| params | the parameters for this 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. This method does not block.
| 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 |
|---|
Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.
Note that objects that override finalize are significantly more expensive than
objects that don't. Finalizers may be run a long time after the object is no longer
reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup.
Note also that finalizers are run on a single VM-wide finalizer thread,
so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary
for a class that has a native peer and needs to call a native method to destroy that peer.
Even then, it's better to provide an explicit close method (and implement
Closeable), and insist that callers manually dispose of instances. This
works well for something like files, but less well for something like a BigInteger
where typical calling code would have to deal with lots of temporaries. Unfortunately,
code that creates lots of temporaries is the worst kind of code from the point of view of
the single finalizer thread.
If you must use finalizers, consider at least providing your own
ReferenceQueue and having your own thread process that queue.
Unlike constructors, finalizers are not automatically chained. You are responsible for
calling super.finalize() yourself.
Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.
| Throwable |
|---|
Revokes the currently issued connection. The adapter gets disconnected, the connection will be shut down.