to.etc.dbpool

Class PoolManager

java.lang.Object

to.etc.dbpool.PoolManager

public final class PoolManager
extends Object

Root of the database pool manager code.

Author:

Frits Jalvingh Created on Nov 2, 2010

Constructor Summary

Constructors

Constructor and Description
PoolManager()

Method Summary

Modifier and Type	Method and Description
static void	addListener(Connection dbc, IDatabaseEventListener el) Add an event listener to the specified connection.
void	addMessageListener(IPoolMessageHandler pmh)
void	clearThreadConnections()
ConnectionPool	definePool(File poolfile, String id) This defines a pool, taking it's config from a properties file.
ConnectionPool	definePool(PoolConfigSource cs, String id) Defines the pool with the specified ID from the ConfigSource passed.
ConnectionPool	definePool(String id) This defines a pool using the default poolfile ".dbpool.properties" stored in the user's home directory.
ConnectionPool	definePool(String id, PoolConfig pc)
ConnectionPool	definePool(String id, String driver, String url, String userid, String password, String driverpath)
void	destroyAll() Destroy all current pools.
void	destroyPool(String poolid)
static PoolManager	getInstance()
ConnectionPool	getPool(String id) Finds the named pool.
int	getPoolCount() Return the #of pools currently defined.
static ConnectionPool	getPoolFrom(DataSource ds)
ConnectionPool[]	getPoolList() Return all currently defined pools.
List<ConnectionProxy>	getThreadConnections()
static DataSource	getUnpooledFrom(DataSource ds) Try to get the unpooled datasource associated with this datasource, if that datasource comes from the pool manager.
ConnectionPool	initializePool(File poolfile, String id) This combines defining and initializing a pool, taking it's config from a properties file.
ConnectionPool	initializePool(PoolConfigSource cs, String id) This combines defining and initializing a pool.
ConnectionPool	initializePool(String id) Initializes the pool defined by ID by pre-allocating the first min connections from it.
boolean	isCheckCloseConnections()
boolean	isCollectStatistics()
void	logUnexpected(Exception t, String s)
void	logUnexpected(String s)
void	panic(String shortdesc, String body)
static void	removeListener(Connection dbc, IDatabaseEventListener el) Remove an event listener that was added before from the specified connection.
void	removeMessageListener(IPoolMessageHandler pmh)
void	sendLogUnexpected(Exception t, String s)
void	sendPanic(String shortdesc, String body)
void	setCheckCloseConnections(boolean checkCloseConnections)
void	setCollectStatistics(boolean on)
static void	setLongLiving(Connection dbc) Mark connection long living, for those connections which need to be opened for a long time (hanging connection check will skip this connection).
boolean	startCollecting(String key, IStatisticsListener collector) Registers a statistics collection listener for the current thread.
protected void	startExpiredConnectionScanner() Starts the scanner if database locking security is requested.
IStatisticsListener	stopCollecting(String key) Returns the collector with the specified key.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolManager

public PoolManager()

Method Detail

getInstance

public static PoolManager getInstance()

panic

public void panic(String shortdesc,
                  String body)

logUnexpected

public void logUnexpected(Exception t,
                          String s)

logUnexpected

public void logUnexpected(String s)

addMessageListener

public void addMessageListener(IPoolMessageHandler pmh)

removeMessageListener

public void removeMessageListener(IPoolMessageHandler pmh)

sendLogUnexpected

public void sendLogUnexpected(Exception t,
                              String s)

sendPanic

public void sendPanic(String shortdesc,
                      String body)

getPoolCount

public int getPoolCount()

Return the #of pools currently defined.

Returns:

getPool

@Nonnull
public ConnectionPool getPool(@Nonnull
                                       String id)
                                throws SQLException

Finds the named pool. Throws an exception if not found.

Throws:

SQLException

getPoolList

public ConnectionPool[] getPoolList()

Return all currently defined pools.

Returns:

definePool

public ConnectionPool definePool(String id,
                                 PoolConfig pc)
                          throws SQLException

Throws:

SQLException

definePool

public ConnectionPool definePool(PoolConfigSource cs,
                                 String id)
                          throws SQLException

Defines the pool with the specified ID from the ConfigSource passed. The pool is defined but NOT initialized. The same pool can be defined more than once provided it's parameters are all the same. After this call the pool can be used but it operates in "unpooled" mode, meaning that all allocated connections will be discarded after a close.

Throws:

SQLException

definePool

public ConnectionPool definePool(String id,
                                 String driver,
                                 String url,
                                 String userid,
                                 String password,
                                 String driverpath)
                          throws SQLException

Throws:

SQLException

definePool

public ConnectionPool definePool(File poolfile,
                                 String id)
                          throws Exception

This defines a pool, taking it's config from a properties file.

Parameters:

poolfile -

id -

Throws:

Exception

definePool

public ConnectionPool definePool(String id)
                          throws Exception

This defines a pool using the default poolfile ".dbpool.properties" stored in the user's home directory. If no such file is found then an exception is thrown.

Parameters:

id -

Returns:

Throws:

Exception

initializePool

public ConnectionPool initializePool(String id)
                              throws Exception

Initializes the pool defined by ID by pre-allocating the first min connections from it. If the pool has already initialized it returns immediately. If the first connections fail to be allocated properly then an exception occurs and the pool is deinitialized. After this call the pool operates in pooled mode.

Throws:

Exception

initializePool

public ConnectionPool initializePool(PoolConfigSource cs,
                                     String id)
                              throws SQLException

This combines defining and initializing a pool.

Parameters:

cs - The configsource to take definitions from

id - The ID of the pool to define.

Throws:

Exception

SQLException

initializePool

public ConnectionPool initializePool(File poolfile,
                                     String id)
                              throws Exception

This combines defining and initializing a pool, taking it's config from a properties file.

Parameters:

poolfile -

id -

Throws:

Exception

destroyAll

public void destroyAll()

Destroy all current pools.

destroyPool

public void destroyPool(String poolid)
                 throws SQLException

Throws:

SQLException

startExpiredConnectionScanner

protected void startExpiredConnectionScanner()

Starts the scanner if database locking security is requested.

startCollecting

public boolean startCollecting(String key,
                               IStatisticsListener collector)

Registers a statistics collection listener for the current thread. If statistics gathering is disabled the call is ignored and returns false. Else the listener is added and will receive all statement events; in this case the call returns true.

stopCollecting

public IStatisticsListener stopCollecting(String key)

Returns the collector with the specified key. If statistics collection is not enabled this returns null always; else it returns and removes the collector- if found.

Parameters:

key -

Returns:

setCollectStatistics

public void setCollectStatistics(boolean on)

isCollectStatistics

public boolean isCollectStatistics()

addListener

public static void addListener(@Nonnull
                               Connection dbc,
                               @Nonnull
                               IDatabaseEventListener el)

Add an event listener to the specified connection. The connection must be one that is allocated through this pool manager or an exception is thrown.

Parameters:

dbc -

el -

removeListener

public static void removeListener(@Nonnull
                                  Connection dbc,
                                  @Nonnull
                                  IDatabaseEventListener el)

Remove an event listener that was added before from the specified connection. The connection must be one that is allocated through this pool manager or an exception is thrown.

Parameters:

dbc -

el -

isCheckCloseConnections

public boolean isCheckCloseConnections()

setCheckCloseConnections

public void setCheckCloseConnections(boolean checkCloseConnections)

getThreadConnections

public List<ConnectionProxy> getThreadConnections()

clearThreadConnections

public void clearThreadConnections()

setLongLiving

public static void setLongLiving(@Nonnull
                                 Connection dbc)
                          throws SQLException

Mark connection long living, for those connections which need to be opened for a long time (hanging connection check will skip this connection).

Parameters:

dbc -

Throws:

SQLException

getPoolFrom

@Nullable
public static ConnectionPool getPoolFrom(@Nonnull
                                                   DataSource ds)

getUnpooledFrom

@Nonnull
public static DataSource getUnpooledFrom(@Nonnull
                                                  DataSource ds)

Try to get the unpooled datasource associated with this datasource, if that datasource comes from the pool manager.

Parameters:

ds -

Returns: