public class

SingleClientConnManager

extends Object
implements ClientConnectionManager
java.lang.Object
   ↳ org.apache.http.impl.conn.SingleClientConnManager

Class Overview

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.

Summary

Nested Classes
class SingleClientConnManager.ConnAdapter The connection adapter used by this manager. 
class SingleClientConnManager.PoolEntry The pool entry for this connection manager. 
Constants
String MISUSE_MESSAGE The message to be logged on multiple allocation.
Fields
protected final boolean alwaysShutDown Whether the connection should be shut down on release.
protected final ClientConnectionOperator connOperator The operator for opening and updating connections.
protected long connectionExpiresTime The time the last released connection expires and shouldn't be reused.
protected boolean isShutDown Indicates whether this connection manager is shut down.
protected long lastReleaseTime The time of the last connection release, or -1.
protected SingleClientConnManager.ConnAdapter managedConn The currently issued managed connection, if any.
protected final SchemeRegistry schemeRegistry The schemes supported by this connection manager.
protected SingleClientConnManager.PoolEntry uniquePoolEntry The one and only entry in this pool.
Public Constructors
SingleClientConnManager(HttpParams params, SchemeRegistry schreg)
This constructor is deprecated. use SingleClientConnManager(SchemeRegistry)
SingleClientConnManager(SchemeRegistry schreg)
Creates a new simple connection manager.
SingleClientConnManager()
Public Methods
synchronized void closeExpiredConnections()
Closes all expired connections in the pool.
synchronized void closeIdleConnections(long idletime, TimeUnit tunit)
Closes idle connections in the pool.
synchronized ManagedClientConnection getConnection(HttpRoute route, Object state)
Obtains a connection.
SchemeRegistry getSchemeRegistry()
Obtains the scheme registry used by this manager.
synchronized void releaseConnection(ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)
Releases a connection for use by others.
final ClientConnectionRequest requestConnection(HttpRoute route, Object state)
Returns a new ClientConnectionRequest, from which a ManagedClientConnection can be obtained or the request can be aborted.
synchronized void shutdown()
Shuts down this connection manager and releases allocated resources.
Protected Methods
final void assertStillUp()
Asserts that this manager is not shut down.
ClientConnectionOperator createConnectionOperator(SchemeRegistry schreg)
Hook for creating the connection operator.
void finalize()
synchronized void revokeConnection()
This method is deprecated. no longer used
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.conn.ClientConnectionManager

Constants

public static final String MISUSE_MESSAGE

Also: HttpClient

The message to be logged on multiple allocation.

Constant Value: "Invalid use of SingleClientConnManager: connection still allocated. Make sure to release the connection before allocating another one."

Fields

protected final boolean alwaysShutDown

Also: HttpClient

Whether the connection should be shut down on release.

protected final ClientConnectionOperator connOperator

Also: HttpClient

The operator for opening and updating connections.

protected long connectionExpiresTime

Also: HttpClient

The time the last released connection expires and shouldn't be reused.

protected boolean isShutDown

Also: HttpClient

Indicates whether this connection manager is shut down.

protected long lastReleaseTime

Also: HttpClient

The time of the last connection release, or -1.

protected SingleClientConnManager.ConnAdapter managedConn

Also: HttpClient

The currently issued managed connection, if any.

protected final SchemeRegistry schemeRegistry

Also: HttpClient

The schemes supported by this connection manager.

protected SingleClientConnManager.PoolEntry uniquePoolEntry

Also: HttpClient

The one and only entry in this pool.

Public Constructors

public SingleClientConnManager (HttpParams params, SchemeRegistry schreg)

Also: HttpClient

This constructor is deprecated.
use SingleClientConnManager(SchemeRegistry)

Creates a new simple connection manager.

Parameters
params the parameters for this manager
schreg the scheme registry

public SingleClientConnManager (SchemeRegistry schreg)

Also: HttpClient

Creates a new simple connection manager.

Parameters
schreg the scheme registry

public SingleClientConnManager ()

Also: HttpClient

Public Methods

public synchronized void closeExpiredConnections ()

Also: HttpClient

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.

public synchronized void closeIdleConnections (long idletime, TimeUnit tunit)

Also: HttpClient

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.

Parameters
idletime the idle time of connections to be closed
tunit the unit for the idletime

public synchronized ManagedClientConnection getConnection (HttpRoute route, Object state)

Also: HttpClient

Obtains a connection.

Parameters
route where the connection should point to
Returns
  • a connection that can be used to communicate along the given route

public SchemeRegistry getSchemeRegistry ()

Also: HttpClient

Obtains the scheme registry used by this manager.

Returns
  • the scheme registry, never null

public synchronized void releaseConnection (ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)

Also: HttpClient

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.

Parameters
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

public final ClientConnectionRequest requestConnection (HttpRoute route, Object state)

Also: HttpClient

Returns a new ClientConnectionRequest, from which a ManagedClientConnection can be obtained or the request can be aborted.

public synchronized void shutdown ()

Also: HttpClient

Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.

Protected Methods

protected final void assertStillUp ()

Also: HttpClient

Asserts that this manager is not shut down.

Throws
IllegalStateException if this manager is shut down

protected ClientConnectionOperator createConnectionOperator (SchemeRegistry schreg)

Also: HttpClient

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.

Parameters
schreg the scheme registry to use, or null
Returns
  • the connection operator to use

protected void finalize ()

Throws
Throwable

protected synchronized void revokeConnection ()

Also: HttpClient

This method is deprecated.
no longer used