org.objectweb.jonas.dbm
Class ConnectionManager

java.lang.Object
  org.objectweb.jonas.dbm.ConnectionManager

All Implemented Interfaces:

javax.sql.ConnectionEventListener, javax.sql.DataSource, java.util.EventListener, Pool, javax.naming.Referenceable, java.io.Serializable, javax.sql.XADataSource

public class ConnectionManager

extends java.lang.Object

implements javax.sql.DataSource, javax.sql.XADataSource, javax.naming.Referenceable, Pool, java.io.Serializable, javax.sql.ConnectionEventListener

DataSource implementation. Manage a pool of connections.

Author:

durieuxp

See Also:

Serialized Form

Constructor Summary

ConnectionManager()
Constructor for Factory

ConnectionManager(boolean isClient)
Always called with true

Method Summary

void	adjust() Adjust the pool size, according to poolMax and poolMin values.
java.lang.String	checkConnection(java.lang.String testStatement) Check on a connection the test statement
void	closeAllConnection() Close all connections in the pool, when server is shut down.
void	connectionClosed(javax.sql.ConnectionEvent event)
void	connectionErrorOccurred(javax.sql.ConnectionEvent event)
void	freeConnections(javax.transaction.Transaction tx) The transaction has committed (or rolled back).
int	getBusyMaxRecent()
int	getBusyMinRecent()
int	getCheckLevel()
java.lang.String	getClassName()
java.sql.Connection	getConnection()
java.sql.Connection	getConnection(java.lang.String username, java.lang.String password) Attempts to establish a connection with the data source that this DataSource object represents.
int	getConnectionFailures()
int	getConnectionLeaks()
static ConnectionManager	getConnectionManager(java.lang.String dsname) get the ConnectionManager matching the DataSource name
int	getCurrentBusy()
int	getCurrentInTx()
int	getCurrentOpened()
int	getCurrentWaiters()
java.lang.String	getDataSourceDescription()
java.lang.String	getDatasourceName()
java.lang.String	getDSName()
int	getLoginTimeout()
java.io.PrintWriter	getLogWriter()
java.lang.String	getMapperName()
int	getMaxAge()
long	getMaxAgeMilli()
int	getMaxOpenTime()
long	getMaxOpenTimeMilli()
int	getMaxWaiters()
int	getMaxWaitTime()
int	getOpenedCount()
java.lang.String	getPassword()
Pool	getPool()
int	getPoolMax()
int	getPoolMin()
int	getPstmtMax()
javax.naming.Reference	getReference() Retrieves the Reference of this object.
int	getRejectedFull()
int	getRejectedOpen()
int	getRejectedOther()
int	getRejectedTimeout()
int	getSamplingPeriod()
int	getServedOpen()
java.lang.String	getTestStatement()
java.lang.String	getTransactionIsolation()
java.lang.String	getUrl()
java.lang.String	getUserName()
int	getWaiterCount()
int	getWaitersHigh()
int	getWaitersHighRecent()
long	getWaitingHigh()
long	getWaitingHighRecent()
long	getWaitingTime()
javax.sql.XAConnection	getXAConnection()
javax.sql.XAConnection	getXAConnection(java.lang.String user, java.lang.String passwd) Attempts to establish a physical database connection, using the given user name and password.
boolean	isClientCase() This manager is in the client case or not ?
JManagedConnection	openConnection(java.lang.String user, javax.transaction.Transaction tx) lookup connection in the pool for this user/tx
void	poolConfigure(java.lang.String connchecklevel, java.lang.String connmaxage, java.lang.String maxopentime, java.lang.String connteststmt, java.lang.String pstmtmax, java.lang.String minconpool, java.lang.String maxconpool, java.lang.String maxwaittime, java.lang.String maxwaiters, java.lang.String samplingperiod) Configure the Connection pool.
void	recomputeBusy() compute current min/max busyConnections
void	sampling() make samples with some monitoring values
void	setCheckLevel(int level)
void	setClassName(java.lang.String s)
void	setDataSourceDescription(java.lang.String dsDesc)
void	setDatasourceName(java.lang.String s)
void	setDSName(java.lang.String s)
void	setLoginTimeout(int seconds)
void	setLogWriter(java.io.PrintWriter out)
void	setMapperName(java.lang.String mappername)
void	setMaxAge(int mn)
void	setMaxOpenTime(int mn)
void	setMaxWaiters(int nb)
void	setMaxWaitTime(int sec)
void	setPassword(java.lang.String s)
void	setPoolMax(int max)
void	setPoolMin(int min)
void	setPstmtMax(int nb)
void	setSamplingPeriod(int sec)
void	setTestStatement(java.lang.String s)
void	setTransactionIsolation(java.lang.String level)
void	setUrl(java.lang.String s)
void	setUserName(java.lang.String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionManager

public ConnectionManager()
                  throws java.lang.Exception

Constructor for Factory

ConnectionManager

public ConnectionManager(boolean isClient)
                  throws java.lang.Exception

Always called with true

Method Detail

isClientCase

public boolean isClientCase()

This manager is in the client case or not ?

Returns:

boolean true if this is the client case TODO : must be removed. A client can lookup a datasource

getPool

public Pool getPool()

Returns:

The pool associated to this datasource

getConnectionManager

public static ConnectionManager getConnectionManager(java.lang.String dsname)

get the ConnectionManager matching the DataSource name

getDSName

public java.lang.String getDSName()

Returns:

Jndi name of the datasource

setDSName

public void setDSName(java.lang.String s)

Parameters:

s - Jndi name for the datasource

getDatasourceName

public java.lang.String getDatasourceName()

setDatasourceName

public void setDatasourceName(java.lang.String s)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String s)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String s)
                  throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String s)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String s)

setTransactionIsolation

public void setTransactionIsolation(java.lang.String level)

getTransactionIsolation

public java.lang.String getTransactionIsolation()

setMapperName

public void setMapperName(java.lang.String mappername)

getMapperName

public java.lang.String getMapperName()

getDataSourceDescription

public java.lang.String getDataSourceDescription()

Returns:

the desrciption of this datasource

setDataSourceDescription

public void setDataSourceDescription(java.lang.String dsDesc)

Parameters:

dsDesc - the desrciption of this datasource

getPoolMin

public int getPoolMin()

Specified by:

getPoolMin in interface Pool

Returns:

min pool size

setPoolMin

public void setPoolMin(int min)

Specified by:

setPoolMin in interface Pool

Parameters:

min - minimum connection pool size to be set.

getPoolMax

public int getPoolMax()

Specified by:

getPoolMax in interface Pool

Returns:

actual max pool size

setPoolMax

public void setPoolMax(int max)

Specified by:

setPoolMax in interface Pool

Parameters:

max - max pool size. -1 means "no limit".

getMaxAge

public int getMaxAge()

Specified by:

getMaxAge in interface Pool

Returns:

max age for connections (in mm)

getMaxAgeMilli

public long getMaxAgeMilli()

Specified by:

getMaxAgeMilli in interface Pool

Returns:

max age for connections (in millisec)

setMaxAge

public void setMaxAge(int mn)

Specified by:

setMaxAge in interface Pool

Parameters:

mn - max age of connection in minutes

getMaxOpenTime

public int getMaxOpenTime()

Specified by:

getMaxOpenTime in interface Pool

Returns:

max age for connections (in mns)

getMaxOpenTimeMilli

public long getMaxOpenTimeMilli()

Specified by:

getMaxOpenTimeMilli in interface Pool

Returns:

max age for connections (in millisecs)

setMaxOpenTime

public void setMaxOpenTime(int mn)

Specified by:

setMaxOpenTime in interface Pool

Parameters:

mn - max time of open connection in minutes

getMaxWaitTime

public int getMaxWaitTime()

Specified by:

getMaxWaitTime in interface Pool

Returns:

waiter timeout in seconds

setMaxWaitTime

public void setMaxWaitTime(int sec)

Specified by:

setMaxWaitTime in interface Pool

Parameters:

sec - max time to wait for a connection, in seconds

getMaxWaiters

public int getMaxWaiters()

Specified by:

getMaxWaiters in interface Pool

Returns:

max nb of waiters

setMaxWaiters

public void setMaxWaiters(int nb)

Specified by:

setMaxWaiters in interface Pool

Parameters:

nb - max nb of waiters

getSamplingPeriod

public int getSamplingPeriod()

Specified by:

getSamplingPeriod in interface Pool

Returns:

sampling period in sec.

setSamplingPeriod

public void setSamplingPeriod(int sec)

Specified by:

setSamplingPeriod in interface Pool

Parameters:

sec - sampling period in sec.

getCheckLevel

public int getCheckLevel()

Specified by:

getCheckLevel in interface Pool

Returns:

connection checking level

setCheckLevel

public void setCheckLevel(int level)

Specified by:

setCheckLevel in interface Pool

Parameters:

level - jdbc connection checking level (0, 1, or 2)

getPstmtMax

public int getPstmtMax()

Returns:

PreparedStatement cache size

setPstmtMax

public void setPstmtMax(int nb)

Parameters:

nb - PreparedStatement cache size

getTestStatement

public java.lang.String getTestStatement()

Specified by:

getTestStatement in interface Pool

Returns:

test statement used when checkLevel = 2.

setTestStatement

public void setTestStatement(java.lang.String s)

Specified by:

setTestStatement in interface Pool

Parameters:

s - test statement

poolConfigure

public void poolConfigure(java.lang.String connchecklevel,
                          java.lang.String connmaxage,
                          java.lang.String maxopentime,
                          java.lang.String connteststmt,
                          java.lang.String pstmtmax,
                          java.lang.String minconpool,
                          java.lang.String maxconpool,
                          java.lang.String maxwaittime,
                          java.lang.String maxwaiters,
                          java.lang.String samplingperiod)

Configure the Connection pool. Called by the Container at init. Configuration can be set in datasource.properties files.

Parameters:

connchecklevel - JDBC connection checking level

connmaxage - JDBC connection maximum age

maxopentime - JDBC connection maximum open time

connteststmt - SQL query for test statement

pstmtmax - prepare statement pool size per managed connection

minconpool - Min size for the connection pool

maxconpool - Max size for the connection pool

maxwaittime - Max time to wait for a connection (in seconds)

maxwaiters - Max nb of waiters for a connection

samplingperiod - sampling period in sec.

getBusyMaxRecent

public int getBusyMaxRecent()

Specified by:

getBusyMaxRecent in interface Pool

Returns:

maximum nb of busy connections in last sampling period

getBusyMinRecent

public int getBusyMinRecent()

Specified by:

getBusyMinRecent in interface Pool

Returns:

minimum nb of busy connections in last sampling period

getCurrentWaiters

public int getCurrentWaiters()

Specified by:

getCurrentWaiters in interface Pool

Returns:

current number of connection waiters

getOpenedCount

public int getOpenedCount()

Specified by:

getOpenedCount in interface Pool

Returns:

int number of physical jdbc connection opened

getConnectionFailures

public int getConnectionFailures()

Specified by:

getConnectionFailures in interface Pool

Returns:

int number of xa connection failures on open

getConnectionLeaks

public int getConnectionLeaks()

Specified by:

getConnectionLeaks in interface Pool

Returns:

int number of connection leaks

getServedOpen

public int getServedOpen()

Specified by:

getServedOpen in interface Pool

Returns:

int number of xa connection served

getRejectedFull

public int getRejectedFull()

Specified by:

getRejectedFull in interface Pool

Returns:

int number of open calls that were rejected due to waiter overflow

getRejectedTimeout

public int getRejectedTimeout()

Specified by:

getRejectedTimeout in interface Pool

Returns:

int number of open calls that were rejected by timeout

getRejectedOther

public int getRejectedOther()

Specified by:

getRejectedOther in interface Pool

Returns:

int number of open calls that were rejected

getRejectedOpen

public int getRejectedOpen()

Specified by:

getRejectedOpen in interface Pool

Returns:

int number of open calls that were rejected

getWaitersHigh

public int getWaitersHigh()

Specified by:

getWaitersHigh in interface Pool

Returns:

maximum nb of waiters since the datasource creation

getWaitersHighRecent

public int getWaitersHighRecent()

Specified by:

getWaitersHighRecent in interface Pool

Returns:

maximum nb of waiters in last sampling period

getWaiterCount

public int getWaiterCount()

Specified by:

getWaiterCount in interface Pool

Returns:

total nb of waiters since the datasource creation

getWaitingTime

public long getWaitingTime()

Specified by:

getWaitingTime in interface Pool

Returns:

total waiting time since the datasource creation

getWaitingHigh

public long getWaitingHigh()

Specified by:

getWaitingHigh in interface Pool

Returns:

max waiting time since the datasource creation

getWaitingHighRecent

public long getWaitingHighRecent()

Specified by:

getWaitingHighRecent in interface Pool

Returns:

max waiting time in last sampling period

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Specified by:

getLoginTimeout in interface javax.sql.DataSource

Throws:

java.sql.SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException

Specified by:

setLoginTimeout in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Specified by:

getLogWriter in interface javax.sql.DataSource

Throws:

java.sql.SQLException

setLogWriter

public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException

Specified by:

setLogWriter in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Attempts to establish a connection with the data source that this DataSource object represents. - comes from the javax.sql.DataSource interface

Specified by:

getConnection in interface javax.sql.DataSource

Parameters:

username - - the database user on whose behalf the connection is being made

password - - the user's password

Returns:

a connection to the data source

Throws:

java.sql.SQLException - - if a database access error occurs

getXAConnection

public javax.sql.XAConnection getXAConnection()
                                       throws java.sql.SQLException

Specified by:

getXAConnection in interface javax.sql.XADataSource

Throws:

java.sql.SQLException

getXAConnection

public javax.sql.XAConnection getXAConnection(java.lang.String user,
                                              java.lang.String passwd)
                                       throws java.sql.SQLException

Attempts to establish a physical database connection, using the given user name and password. The connection that is returned is one that can be used in a distributed transaction - comes from the javax.sql.XADataSource interface

Specified by:

getXAConnection in interface javax.sql.XADataSource

Parameters:

user - - the database user on whose behalf the connection is being made

passwd - - the user's password

Returns:

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction

Throws:

java.sql.SQLException - - if a database access error occurs

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException

Retrieves the Reference of this object. Used at binding time by JNDI to build a reference on this object.

Specified by:

getReference in interface javax.naming.Referenceable

Returns:

The non-null Reference of this object.

Throws:

javax.naming.NamingException - If a naming exception was encountered while retrieving the reference.

connectionClosed

public void connectionClosed(javax.sql.ConnectionEvent event)

Specified by:

connectionClosed in interface javax.sql.ConnectionEventListener

connectionErrorOccurred

public void connectionErrorOccurred(javax.sql.ConnectionEvent event)

Specified by:

connectionErrorOccurred in interface javax.sql.ConnectionEventListener

getCurrentOpened

public int getCurrentOpened()

Specified by:

getCurrentOpened in interface Pool

Returns:

int number of xa connection

getCurrentBusy

public int getCurrentBusy()

Specified by:

getCurrentBusy in interface Pool

Returns:

int number of busy xa connection

recomputeBusy

public void recomputeBusy()

compute current min/max busyConnections

getCurrentInTx

public int getCurrentInTx()

Specified by:

getCurrentInTx in interface Pool

Returns:

int number of xa connection reserved for tx

sampling

public void sampling()

make samples with some monitoring values

adjust

public void adjust()

Adjust the pool size, according to poolMax and poolMin values. Also remove old connections in the freeList.

openConnection

public JManagedConnection openConnection(java.lang.String user,
                                         javax.transaction.Transaction tx)
                                  throws java.sql.SQLException

lookup connection in the pool for this user/tx

Parameters:

user - user name

tx - Transaction the connection is involved

Returns:

a free JManagedConnection (never null)

Throws:

java.sql.SQLException - Cannot open a connection because the pool's max size is reached

freeConnections

public void freeConnections(javax.transaction.Transaction tx)

The transaction has committed (or rolled back). We can return its connections to the pool of available connections.

Parameters:

tx - the non null transaction

closeAllConnection

public void closeAllConnection()

Close all connections in the pool, when server is shut down.

checkConnection

public java.lang.String checkConnection(java.lang.String testStatement)
                                 throws java.sql.SQLException

Check on a connection the test statement

Specified by:

checkConnection in interface Pool

Parameters:

testStatement - the statement to use for test

Returns:

the test statement if the test succeeded, an error message otherwise

Throws:

java.sql.SQLException - If an error occured when trying to test (not due to the test itself, but to other preliminary or post operation).