org.tentackle.persist

Interface ConnectionManager

All Superinterfaces:

SessionManager

All Known Implementing Classes:

DefaultConnectionManager, MpxConnectionManager

public interface ConnectionManager
extends SessionManager

Connection Manager for local connections.
JDBC connections are never used directly. Instead Db-instances refer to a ConnectionManager in order to use a connection. The usage of a connection is initiated by an attach operation. After completion of the task (transaction, one-shot, etc...) the Db will be detached. The connection manager as a broker in between the Db and a connection gives the opportunity to multiplex connections. This is especially useful in application servers. Note that connection managers are not used in remote Db instances.

Author:

harald

Method Summary

Modifier and Type	Method and Description
void	attach(Session session) Attaches a Db to a connection. A Db must be attached before it can use any statements.
void	detach(Session session) Detaches a connection from a Db. A Db must be detached to release the connection for use of other Db instances.
void	forceDetach(Session session) Detaches but also scans for pending statements to cleanup.
Collection<ManagedConnection>	getConnections() Gets the connections.
int	getMaxConnections() Gets the maximum number of connections.
int	getNumConnections() Gets the number of open connections.

Methods inherited from interface org.tentackle.pdo.SessionManager

getMaxSessions, getName, getNumSessions, login, logout, shutdown

Method Detail

attach

void attach(Session session)

Attaches a Db to a connection.
A Db must be attached before it can use any statements. The framework will attach at the begining of a transaction or when getting a prepared statement or when getting a one-shot non-prepared statement. Note that attachments can be nested to any depth, i.e. only the first attach really binds the connection to the Db.

Upon return the the session will reference the connection.

Parameters:

session - the session

Throws:

PersistenceException - if attach failed.

detach

void detach(Session session)

Detaches a connection from a Db.
A Db must be detached to release the connection for use of other Db instances. The framework will detach the db on every commit or rollback, after executeUpdate or after a resultset is closed for an executeQuery. Note that attachments can be nested to any depth, i.e. only the last detach really unbinds the connection from the Db.

Parameters:

session - the session

Throws:

PersistenceException - if detach failed.

forceDetach

void forceDetach(Session session)

Detaches but also scans for pending statements to cleanup.

This will detach at any nesting level!

Parameters:

session - the session

getMaxConnections

int getMaxConnections()

Gets the maximum number of connections.

Returns:

max. number of concurrent connections, 0 = unlimited

getNumConnections

int getNumConnections()

Gets the number of open connections.

Returns:

the number of connections

getConnections

Collection<ManagedConnection> getConnections()

Gets the connections.

Returns:

the connection