DefaultConnectionManager (Tentackle Persistence 2.0.7 API)

java.lang.Object
- java.lang.Thread
- - org.tentackle.persist.DefaultConnectionManager

All Implemented Interfaces:

Runnable, SessionManager, ConnectionManager

Direct Known Subclasses:

MpxConnectionManager
```
public class DefaultConnectionManager
extends Thread
implements ConnectionManager
```
The default implementation of a connection manager.
Each Db will get its own physical connection. This kind of manager is useful for 2-tier applications directly connecting to a database backend.
Although this manager implements a strict 1:1 mapping between dbs and connections it can be easily extended to implememt a M:N mapping, see the MpxConnectionManager.

Author:

harald

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`protected ManagedConnection[]`	`conList` managed connections.
`protected int`	`dbSize` current allocation size for `Db`s logged in.
`protected int`	`freeConCount` number of entries in freeConList.
`protected int[]`	`freeConList` free list for conList (unused entries in conList).
`protected int`	`freeDbCount` number of entries in freeDbList.
`protected int[]`	`freeDbList` free list for dbList (unused entries in dbList).
`protected int`	`idOffset` offset for connection IDs.
`protected int`	`iniSize` initial size.
`protected int`	`maxConSize` maximum number of connections, 0 = unlimited.
`protected int`	`maxDbSize` maximum number of `Db`s, 0 = unlimited.
`protected String`	`name` name of the connection manager.

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description
`DefaultConnectionManager()` Creates a connection manager.
`DefaultConnectionManager(String name, int iniSize, int maxSize, int idOffset)` Creates a new connection manager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`addConnection(ManagedConnection con)` Adds a connection to the list.
`protected int`	`addDb(Db db)` Adds a Db to the list.
`protected void`	`assertSessionBelongsToMe(Session session)` Asserts that the session belongs to this manager.
`void`	`attach(Session session)` Attaches a `Db` to a connection. A Db must be attached before it can use any statements.
`protected int`	`convertConnectionIdToIndex(int id)` Converts the connection id to the internal Db-array index.
`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.
`long`	`getAttachTimeout()` Gets the attach timeout.
`int`	`getConnectionCount()` Gets the number of established connections
`Collection<ManagedConnection>`	`getConnections()` Gets the connections.
`int`	`getMaxConnections()` Gets the maximum number of connections.
`int`	`getMaxCountForClearWarnings()` Gets the current setting for clearWarnings() trigger
`int`	`getMaxSessions()`
`int`	`getNumConnections()` Gets the number of open connections.
`int`	`getNumSessions()`
`int`	`login(Session session)`
`void`	`logout(Session session)`
`protected ManagedConnection`	`removeConnection(int index)` Removes a connection from the list.
`protected void`	`removeDb(int index)` Removes a Db from the list.
`void`	`run()`
`void`	`setAttachTimeout(long attachTimeout)` Sets the attach timeout.
`void`	`setMaxCountForClearWarnings(int maxCountForClearWarnings)` Sets the countForClearWarnings trigger, 0 = app must eat the warnings!
`void`	`shutdown()`
`String`	`toString()` Gets the name of the manager.

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tentackle.pdo.SessionManager
getName

- Field Detail
  - name
```
protected final String name
```
    name of the connection manager.
  - iniSize
```
protected final int iniSize
```
    initial size.
  - idOffset
```
protected final int idOffset
```
    offset for connection IDs.
  - dbSize
```
protected int dbSize
```
    current allocation size for Dbs logged in.
  - maxDbSize
```
protected int maxDbSize
```
    maximum number of Dbs, 0 = unlimited.
  - freeDbList
```
protected int[] freeDbList
```
    free list for dbList (unused entries in dbList).
  - freeDbCount
```
protected int freeDbCount
```
    number of entries in freeDbList.
  - conList
```
protected ManagedConnection[] conList
```
    managed connections.
  - maxConSize
```
protected final int maxConSize
```
    maximum number of connections, 0 = unlimited.
  - freeConList
```
protected int[] freeConList
```
    free list for conList (unused entries in conList).
  - freeConCount
```
protected int freeConCount
```
    number of entries in freeConList.
- Constructor Detail
  - DefaultConnectionManager
```
public DefaultConnectionManager(String name,
                                int iniSize,
                                int maxSize,
                                int idOffset)
```
    Creates a new connection manager.
    
    Parameters:
    
    name - the name of the connection manager
    
    iniSize - the initial iniSize of the db table
    
    maxSize - the maximum number of connections, 0 = unlimited (dangerous!)
    
    idOffset - the offset for connection ids (> 0)
  - DefaultConnectionManager
```
public DefaultConnectionManager()
```
    Creates a connection manager.
    With an initial size of 2, a maximum of 8 concurrent connections and an id offset of 1. This is the default connection manager for 2-tier client applications. The max connections will prevent ill behaving applications from tearing down the dbserver by opening connections excessively. The usual application holds 2 connections and temporarily 1 or 2 more. If you need more, change the connection manager in Db.
- Method Detail
  - toString
```
public String toString()
```
    Gets the name of the manager.
    
    Overrides:
    
    toString in class Thread
  - setMaxCountForClearWarnings
```
public void setMaxCountForClearWarnings(int maxCountForClearWarnings)
```
    Sets the countForClearWarnings trigger, 0 = app must eat the warnings!
    
    Parameters:
    
    maxCountForClearWarnings - the maxcount
  - getMaxCountForClearWarnings
```
public int getMaxCountForClearWarnings()
```
    Gets the current setting for clearWarnings() trigger
    
    Returns:
    
    the countForClearWarnings trigger, 0 = app must eat the warnings!
  - getAttachTimeout
```
public long getAttachTimeout()
```
    Gets the attach timeout.
    
    Returns:
    
    the max. attach time, 0 if check is disabled
  - setAttachTimeout
```
public void setAttachTimeout(long attachTimeout)
```
    Sets the attach timeout.
    
    Parameters:
    
    attachTimeout - the max. attach time, 0 if check is disabled (default)
  - addDb
```
protected int addDb(Db db)
```
    Adds a Db to the list.
    
    Parameters:
    
    db - the db to add
    
    Returns:
    
    the index of db in the dblist
  - removeDb
```
protected void removeDb(int index)
```
    Removes a Db from the list.
    
    Parameters:
    
    index - the index of db in the dblist
  - addConnection
```
protected int addConnection(ManagedConnection con)
```
    Adds a connection to the list.
    
    Parameters:
    
    con - the connection to add
    
    Returns:
    
    the index of connection in the conlist
  - removeConnection
```
protected ManagedConnection removeConnection(int index)
```
    Removes a connection from the list.
    
    Parameters:
    
    index - the index of connection in the conlist
    
    Returns:
    
    the removed connection
  - getConnectionCount
```
public int getConnectionCount()
```
    Gets the number of established connections
    
    Returns:
    
    the number of connections
  - getMaxSessions
```
public int getMaxSessions()
```
    Specified by:
    
    getMaxSessions in interface SessionManager
  - getNumSessions
```
public int getNumSessions()
```
    Specified by:
    
    getNumSessions in interface SessionManager
  - getMaxConnections
```
public int getMaxConnections()
```
    Description copied from interface: ConnectionManager
    
    Gets the maximum number of connections.
    
    Specified by:
    
    getMaxConnections in interface ConnectionManager
    
    Returns:
    
    max. number of concurrent connections, 0 = unlimited
  - getNumConnections
```
public int getNumConnections()
```
    Description copied from interface: ConnectionManager
    
    Gets the number of open connections.
    
    Specified by:
    
    getNumConnections in interface ConnectionManager
    
    Returns:
    
    the number of connections
  - getConnections
```
public Collection<ManagedConnection> getConnections()
```
    Description copied from interface: ConnectionManager
    
    Gets the connections.
    
    Specified by:
    
    getConnections in interface ConnectionManager
    
    Returns:
    
    the connection
  - login
```
public int login(Session session)
```
    Specified by:
    
    login in interface SessionManager
  - logout
```
public void logout(Session session)
```
    Specified by:
    
    logout in interface SessionManager
  - attach
```
public void attach(Session session)
```
    Description copied from interface: ConnectionManager
    
    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.
    
    Specified by:
    
    attach in interface ConnectionManager
    
    Parameters:
    
    session - the session
  - detach
```
public void detach(Session session)
```
    Description copied from interface: ConnectionManager
    
    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.
    
    Specified by:
    
    detach in interface ConnectionManager
    
    Parameters:
    
    session - the session
  - forceDetach
```
public void forceDetach(Session session)
```
    Description copied from interface: ConnectionManager
    
    Detaches but also scans for pending statements to cleanup.
    This will detach at any nesting level!
    
    Specified by:
    
    forceDetach in interface ConnectionManager
    
    Parameters:
    
    session - the session
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in interface SessionManager
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread
  - convertConnectionIdToIndex
```
protected int convertConnectionIdToIndex(int id)
```
    Converts the connection id to the internal Db-array index.
    
    Parameters:
    
    id - the connection id (> 0)
    
    Returns:
    
    the array index
  - assertSessionBelongsToMe
```
protected void assertSessionBelongsToMe(Session session)
```
    Asserts that the session belongs to this manager.
    
    Parameters:
    
    session - the session

Class DefaultConnectionManager

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Methods inherited from interface org.tentackle.pdo.SessionManager

Field Detail

name

iniSize

idOffset

dbSize

maxDbSize

freeDbList

freeDbCount

conList

maxConSize

freeConList

freeConCount

Constructor Detail

DefaultConnectionManager

DefaultConnectionManager

Method Detail

toString

setMaxCountForClearWarnings

getMaxCountForClearWarnings

getAttachTimeout

setAttachTimeout

addDb

removeDb

addConnection

removeConnection

getConnectionCount

getMaxSessions

getNumSessions

getMaxConnections

getNumConnections

getConnections

login

logout

attach

detach

forceDetach

shutdown

run

convertConnectionIdToIndex

assertSessionBelongsToMe