org.enhydra.jdbc.pool

Class StandardPoolDataSource

java.lang.Object

org.enhydra.jdbc.util.JdbcUtil

org.enhydra.jdbc.core.CoreDataSource

org.enhydra.jdbc.pool.StandardPoolDataSource

All Implemented Interfaces:

Serializable, Wrapper, EventListener, Referenceable, ObjectFactory, CommonDataSource, ConnectionEventListener, DataSource, PoolHelper

Direct Known Subclasses:

StandardXAPoolDataSource

public class StandardPoolDataSource
extends CoreDataSource
implements DataSource, PoolHelper, ConnectionEventListener

StandardPoolDataSource class allows to make some operations on PooledConnection. It implements PoolHelper for the 3 methods :

create : create a PooledConnection

create(user,password) : create a PooledConnection with an other user/password

testThisObject : check if the object is still valid

checkThisObject : check if the object is closed

expire : kill the object

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ConnectionPoolDataSource	cpds
String	dataSourceName
org.apache.commons.logging.Log	glog
Context	ictx
String	jdbcTestStmt
boolean	onOff
GenericPool	pool

Fields inherited from class org.enhydra.jdbc.core.CoreDataSource

logWriter, password, user

Fields inherited from class org.enhydra.jdbc.util.JdbcUtil

log

Constructor Summary

Constructors

Constructor and Description
StandardPoolDataSource() Constructor
StandardPoolDataSource(ConnectionPoolDataSource cc) Constructor
StandardPoolDataSource(ConnectionPoolDataSource cc, int initSize) Constructor
StandardPoolDataSource(int initSize) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	checkThisObject(Object o) This method tests if a connection is closed or not
void	connectionClosed(ConnectionEvent event) Invoked when the application calls close() on its representation of the connection
void	connectionErrorOccurred(ConnectionEvent event) connectionErrorOccurred and connectionClosed are methods from ConnectionEventListener interface Invoked when a fatal connection error occurs, just before an SQLException is thrown to the application
GenerationObject	create()
GenerationObject	create(String _user, String _password)
void	expire(Object o) object specific work to kill the object
int	getCheckLevelObject()
Connection	getConnection() getConnection allows to get an object from the pool and returns it to the user.
Connection	getConnection(String _user, String _password) getConnection allows to get an object from the pool and returns it to the user.
String	getDataSourceName()
long	getDeadLockMaxWait()
long	getDeadLockRetryWait()
int	getGeneration()
String	getJdbcTestStmt()
long	getLifeTime()
int	getLockedObjectCount()
PrintWriter	getLogWriter()
int	getMaxSize()
int	getMinSize()
Object	getObjectInstance(Object refObj, Name name, Context nameCtx, Hashtable env) Methods inherited from ObjectFactory
Logger	getParentLogger()
Reference	getReference() Retrieves the Reference of this object.
long	getSleepTime()
int	getUnlockedObjectCount()
boolean	isGC()
boolean	isWrapperFor(Class<?> iface)
void	setCheckLevelObject(int checkLevelObject) set the check level of the pooled object before using them
void	setDataSourceName(String dataSourceName) Set up the data source name, get the initial context, and lookup in JNDI to obtain a reference of the DataSourceName this method must be called before a getConnection (in this case an exception is returned
void	setDeadLockMaxWait(long deadLock) set the global time the pool can wait for a free object
void	setDeadLockRetryWait(long loopWait) set the time before 2 tries when trying to obtain an object from the pool
void	setDebug(boolean debug) set the debug flag
void	setGC(boolean gc) set the garbage collection option
void	setGeneration(int generation) set the generation number for future connection, the generation number is used to identify a group a created objects
void	setJdbcTestStmt(String jdbcTestStmt) set the String to test the jdbc connection before using it
void	setLifeTime(long lifeTime) set the life time of the pooled objects
void	setLogWriter(PrintWriter logWriter) set the logwriter for the current object, the logwriter will be use by the current object and by the generic pool
void	setMaxSize(int maxSize) set the maximum size of the pool
void	setMinSize(int minSize) set the minimum size of the pool
void	setSleepTime(long sleepTime) set the sleep time of pooled objects
void	setThreadFactory(JdbcThreadFactory tf) Override this so that the pool's tf gets set as well
void	shutdown(boolean force) shutdown is a placeholder for datasources which should shut down any pools which they maintain.
void	stopPool() stop method to switch off the pool
boolean	testThisObject(Object o) This method tests if a connection is valid or not
String	toString()
<T> T	unwrap(Class<T> iface)

Methods inherited from class org.enhydra.jdbc.core.CoreDataSource

getDescription, getLoginTimeout, getPassword, getThreadFactory, getUser, isDebug, isVerbose, setDescription, setLoginTimeout, setPassword, setUser, setVerbose

Methods inherited from class org.enhydra.jdbc.util.JdbcUtil

setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, setLoginTimeout

Field Detail

cpds

public ConnectionPoolDataSource cpds

pool

public GenericPool pool

dataSourceName

public String dataSourceName

jdbcTestStmt

public String jdbcTestStmt

onOff

public boolean onOff

ictx

public Context ictx

glog

public org.apache.commons.logging.Log glog

Constructor Detail

StandardPoolDataSource

public StandardPoolDataSource()

Constructor

StandardPoolDataSource

public StandardPoolDataSource(int initSize)

Constructor

StandardPoolDataSource

public StandardPoolDataSource(ConnectionPoolDataSource cc)

Constructor

StandardPoolDataSource

public StandardPoolDataSource(ConnectionPoolDataSource cc,
                              int initSize)

Constructor

Method Detail

setDataSourceName

public void setDataSourceName(String dataSourceName)

Set up the data source name, get the initial context, and lookup in JNDI to obtain a reference of the DataSourceName this method must be called before a getConnection (in this case an exception is returned

getDataSourceName

public String getDataSourceName()

getConnection

public Connection getConnection()
                         throws SQLException

getConnection allows to get an object from the pool and returns it to the user. In this case, we return an PooledConnection

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String _user,
                                String _password)
                         throws SQLException

getConnection allows to get an object from the pool and returns it to the user. In this case, we return an PooledConnection

Specified by:

getConnection in interface DataSource

Throws:

SQLException

connectionErrorOccurred

public void connectionErrorOccurred(ConnectionEvent event)

connectionErrorOccurred and connectionClosed are methods from ConnectionEventListener interface Invoked when a fatal connection error occurs, just before an SQLException is thrown to the application

Specified by:

connectionErrorOccurred in interface ConnectionEventListener

connectionClosed

public void connectionClosed(ConnectionEvent event)

Invoked when the application calls close() on its representation of the connection

Specified by:

connectionClosed in interface ConnectionEventListener

expire

public void expire(Object o)

object specific work to kill the object

Specified by:

expire in interface PoolHelper

checkThisObject

public boolean checkThisObject(Object o)

This method tests if a connection is closed or not

Specified by:

checkThisObject in interface PoolHelper

testThisObject

public boolean testThisObject(Object o)

This method tests if a connection is valid or not

Specified by:

testThisObject in interface PoolHelper

create

public GenerationObject create()
                        throws SQLException

Specified by:

create in interface PoolHelper

Throws:

SQLException

create

public GenerationObject create(String _user,
                               String _password)
                        throws SQLException

Specified by:

create in interface PoolHelper

Throws:

SQLException

stopPool

public void stopPool()

stop method to switch off the pool

shutdown

public void shutdown(boolean force)

Description copied from class: CoreDataSource

shutdown is a placeholder for datasources which should shut down any pools which they maintain.

Overrides:

shutdown in class CoreDataSource

setLogWriter

public void setLogWriter(PrintWriter logWriter)

set the logwriter for the current object, the logwriter will be use by the current object and by the generic pool

Specified by:

setLogWriter in interface CommonDataSource

Overrides:

setLogWriter in class CoreDataSource

Parameters:

logWriter - a PrintWriter object

setDebug

public void setDebug(boolean debug)

set the debug flag

Overrides:

setDebug in class CoreDataSource

Parameters:

debug - a boolean flag

setMinSize

public void setMinSize(int minSize)
                throws Exception

set the minimum size of the pool

Parameters:

minSize - minimum size of the pool

Throws:

Exception

setMaxSize

public void setMaxSize(int maxSize)
                throws Exception

set the maximum size of the pool

Parameters:

maxSize - maximum size of the pool

Throws:

Exception

setLifeTime

public void setLifeTime(long lifeTime)

set the life time of the pooled objects

Parameters:

lifeTime - life time of the pooled objects (in milliseconds)

setSleepTime

public void setSleepTime(long sleepTime)

set the sleep time of pooled objects

Parameters:

sleepTime - sleep time of the pooled objects (in milliseconds)

setGC

public void setGC(boolean gc)

set the garbage collection option

Parameters:

gc - true: the garbage collector will be launched when clean up of the pool, else false

setCheckLevelObject

public void setCheckLevelObject(int checkLevelObject)

set the check level of the pooled object before using them

Parameters:

checkLevelObject - (
0 = no special checking 1 = just a check on an object 2 = test the object 3 = just a check on an object (for all the objects) 4 = test the object (for all the objects)

setJdbcTestStmt

public void setJdbcTestStmt(String jdbcTestStmt)

set the String to test the jdbc connection before using it

Parameters:

jdbcTestStmt - an sql statement

setGeneration

public void setGeneration(int generation)

set the generation number for future connection, the generation number is used to identify a group a created objects

Parameters:

generation - an integer value which represents a generation

setDeadLockMaxWait

public void setDeadLockMaxWait(long deadLock)

set the global time the pool can wait for a free object

Parameters:

deadLock - in milliseconds

setDeadLockRetryWait

public void setDeadLockRetryWait(long loopWait)

set the time before 2 tries when trying to obtain an object from the pool

Parameters:

loopWait - in milliseconds

getLogWriter

public PrintWriter getLogWriter()

Specified by:

getLogWriter in interface CommonDataSource

Overrides:

getLogWriter in class CoreDataSource

getMinSize

public int getMinSize()

getMaxSize

public int getMaxSize()

getLifeTime

public long getLifeTime()

getSleepTime

public long getSleepTime()

getGeneration

public int getGeneration()

isGC

public boolean isGC()

getLockedObjectCount

public int getLockedObjectCount()

getUnlockedObjectCount

public int getUnlockedObjectCount()

getCheckLevelObject

public int getCheckLevelObject()

getJdbcTestStmt

public String getJdbcTestStmt()

getDeadLockMaxWait

public long getDeadLockMaxWait()

getDeadLockRetryWait

public long getDeadLockRetryWait()

toString

public String toString()

Specified by:

toString in interface PoolHelper

Overrides:

toString in class CoreDataSource

getReference

public Reference getReference()
                       throws 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 Referenceable

Overrides:

getReference in class CoreDataSource

Returns:

The non-null Reference of this object.

Throws:

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

getObjectInstance

public Object getObjectInstance(Object refObj,
                                Name name,
                                Context nameCtx,
                                Hashtable env)
                         throws Exception

Description copied from class: CoreDataSource

Methods inherited from ObjectFactory

Specified by:

getObjectInstance in interface ObjectFactory

Overrides:

getObjectInstance in class CoreDataSource

Throws:

Exception

setThreadFactory

public void setThreadFactory(JdbcThreadFactory tf)

Override this so that the pool's tf gets set as well

Overrides:

setThreadFactory in class CoreDataSource

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface CommonDataSource

Throws:

SQLFeatureNotSupportedException