org.firebirdsql.pool
Class DriverConnectionPoolDataSource

java.lang.Object
  org.firebirdsql.pool.AbstractConnectionPool
      org.firebirdsql.pool.BasicAbstractConnectionPool
          org.firebirdsql.pool.DriverConnectionPoolDataSource

All Implemented Interfaces:

javax.sql.ConnectionEventListener, ConnectionPoolConfiguration, javax.sql.ConnectionPoolDataSource, java.util.EventListener, javax.naming.spi.ObjectFactory, PooledConnectionEventListener, PooledObjectListener, javax.naming.Referenceable, java.io.Serializable

public class DriverConnectionPoolDataSource

extends BasicAbstractConnectionPool

implements javax.sql.ConnectionPoolDataSource, PooledConnectionEventListener

Generic implementation of ConnectionPoolDataSource that uses DriverManager to open physical connections to the database.

Author:

Roman Rokytskyy

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.firebirdsql.pool.AbstractConnectionPool

AbstractConnectionPool.UserPasswordPair

Field Summary

static AbstractConnectionPool.UserPasswordPair

EMPTY_USER_PASSWORD

Constructor Summary

DriverConnectionPoolDataSource()
Create instance of this class.

Method Summary

void	connectionClosed(javax.sql.ConnectionEvent connectionEvent) Notify about connection being closed.
void	connectionErrorOccurred(javax.sql.ConnectionEvent event) Notify about serious error when using the connection.
protected BasicAbstractConnectionPool	createObjectInstance() Create instance of this data source.
protected PooledConnectionManager	getConnectionManager() Get connection manager that will allocate physical connections to the database.
javax.naming.Reference	getDefaultReference() Get default JNDI reference for this instance.
java.lang.String	getDriverClassName()
int	getFreeSize() Get number of free connections in this pool.
java.lang.String	getJdbcUrl()
protected org.firebirdsql.logging.Logger	getLogger() Get logger for this instance.
int	getLoginTimeout() Get login timeout.
java.io.PrintWriter	getLogWriter()
java.lang.Object	getObjectInstance(java.lang.Object obj, javax.naming.Name name, javax.naming.Context nameCtx, java.util.Hashtable environment) Get object instance for the specified name in the specified context.
javax.sql.PooledConnection	getPooledConnection() Get pooled connection.
protected PooledObject	getPooledConnection(org.firebirdsql.pool.PooledConnectionQueue queue) Get pooled connection from the pooled queue.
javax.sql.PooledConnection	getPooledConnection(java.lang.String user, java.lang.String password) Get pooled connection for the specified user name and password.
protected java.lang.String	getPoolName() Get name of this connection pool.
java.util.Properties	getProperties()
java.lang.String	getProperty(java.lang.String name)
int	getTotalSize() Get total size of physical connections opened to the database.
int	getWorkingSize() Get number of connections that are in use.
void	physicalConnectionClosed(javax.sql.ConnectionEvent connectionEvent) Notify about physical connection being closed.
void	physicalConnectionDeallocated(javax.sql.ConnectionEvent connectionEvent) Notify about the deallocation of the physical connection.
void	setDriverClassName(java.lang.String driverClassName)
void	setJdbcUrl(java.lang.String jdbcUrl)
void	setLoginTimeout(int seconds) Set login timeout for new connection.
void	setLogWriter(java.io.PrintWriter out)
void	setProperties(java.util.Properties properties) Set JDBC properties that will be passed when opening a connection.
void	setProperty(java.lang.String name, java.lang.String value)

Methods inherited from class org.firebirdsql.pool.BasicAbstractConnectionPool

deserialize, getBlockingTimeout, getConfiguration, getIdleTimeout, getIsolation, getMaxConnections, getMaxIdleTime, getMaxPoolSize, getMaxStatements, getMinConnections, getMinPoolSize, getPingInterval, getPingStatement, getRefAddr, getReference, getRetryInterval, getTransactionIsolationLevel, isKeepStatements, isPingable, isPooling, isStatementPooling, serialize, setBlockingTimeout, setIdleTimeout, setIsolation, setKeepStatements, setMaxConnections, setMaxIdleTime, setMaxPoolSize, setMaxStatements, setMinConnections, setMinPoolSize, setPingInterval, setPingStatement, setPooling, setReference, setRetryInterval, setStatementPooling, setTransactionIsolationLevel

Methods inherited from class org.firebirdsql.pool.AbstractConnectionPool

finalize, getQueue, physicalConnectionDeallocated, pooledObjectReleased, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_USER_PASSWORD

public static final AbstractConnectionPool.UserPasswordPair EMPTY_USER_PASSWORD

Constructor Detail

DriverConnectionPoolDataSource

public DriverConnectionPoolDataSource()

Create instance of this class.

Method Detail

getJdbcUrl

public java.lang.String getJdbcUrl()

setJdbcUrl

public void setJdbcUrl(java.lang.String jdbcUrl)

getDriverClassName

public java.lang.String getDriverClassName()

setDriverClassName

public void setDriverClassName(java.lang.String driverClassName)

getProperty

public java.lang.String getProperty(java.lang.String name)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

getProperties

public java.util.Properties getProperties()

setProperties

public void setProperties(java.util.Properties properties)

Set JDBC properties that will be passed when opening a connection.

Parameters:

properties - instance of Properties containing properties of a connection to open.

See Also:

getProperties()

getLogger

protected org.firebirdsql.logging.Logger getLogger()

Description copied from class: AbstractConnectionPool

Get logger for this instance. By default all log messages belong to this class. Subclasses can override this behavior.

Specified by:

getLogger in class AbstractConnectionPool

Returns:

instance of Logger.

getLogWriter

public java.io.PrintWriter getLogWriter()

Specified by:

getLogWriter in interface javax.sql.ConnectionPoolDataSource

Specified by:

getLogWriter in class BasicAbstractConnectionPool

setLogWriter

public void setLogWriter(java.io.PrintWriter out)

Specified by:

setLogWriter in interface javax.sql.ConnectionPoolDataSource

Specified by:

setLogWriter in class BasicAbstractConnectionPool

getLoginTimeout

public int getLoginTimeout()

Get login timeout.

Specified by:

getLoginTimeout in interface javax.sql.ConnectionPoolDataSource

Specified by:

getLoginTimeout in class BasicAbstractConnectionPool

Returns:

value set in setLoginTimeout(int) method or 0.

setLoginTimeout

public void setLoginTimeout(int seconds)

Set login timeout for new connection. Currently ignored.

Specified by:

setLoginTimeout in interface javax.sql.ConnectionPoolDataSource

Specified by:

setLoginTimeout in class BasicAbstractConnectionPool

Parameters:

seconds - how long pool should wait until new connection is granted.

getConnectionManager

protected PooledConnectionManager getConnectionManager()
                                                throws java.sql.SQLException

Get connection manager that will allocate physical connections to the database.

Specified by:

getConnectionManager in class AbstractConnectionPool

Returns:

instance of PooledConnectionManager class.

Throws:

java.sql.SQLException - if connection manager cannot be obtained.

getPoolName

protected java.lang.String getPoolName()

Get name of this connection pool.

Specified by:

getPoolName in class AbstractConnectionPool

Returns:

name of the pool, equal to the JDBC URL value.

getPooledConnection

protected PooledObject getPooledConnection(org.firebirdsql.pool.PooledConnectionQueue queue)
                                    throws java.sql.SQLException

Get pooled connection from the pooled queue.

Overrides:

getPooledConnection in class AbstractConnectionPool

Parameters:

queue - instance of PooledConnectionQueue where connection will be obtained.

Returns:

instance of PooledObject.

Throws:

java.sql.SQLException - if pooled connection cannot be obtained.

getPooledConnection

public javax.sql.PooledConnection getPooledConnection()
                                               throws java.sql.SQLException

Get pooled connection. This method will block until there will be free connection to return.

Specified by:

getPooledConnection in interface javax.sql.ConnectionPoolDataSource

Specified by:

getPooledConnection in class BasicAbstractConnectionPool

Returns:

instance of PooledConnection.

Throws:

java.sql.SQLException - if pooled connection cannot be obtained.

getPooledConnection

public javax.sql.PooledConnection getPooledConnection(java.lang.String user,
                                                      java.lang.String password)
                                               throws java.sql.SQLException

Get pooled connection for the specified user name and password.

Specified by:

getPooledConnection in interface javax.sql.ConnectionPoolDataSource

Specified by:

getPooledConnection in class BasicAbstractConnectionPool

Parameters:

user - user name.

password - password corresponding to specified user name.

Returns:

instance of PooledConnection for the specified credentials.

Throws:

java.sql.SQLException - always, this method is not yet implemented.

connectionClosed

public void connectionClosed(javax.sql.ConnectionEvent connectionEvent)

Notify about connection being closed.

Specified by:

connectionClosed in interface javax.sql.ConnectionEventListener

Parameters:

connectionEvent - instance of ConnectionEvent.

physicalConnectionClosed

public void physicalConnectionClosed(javax.sql.ConnectionEvent connectionEvent)

Notify about physical connection being closed.

Specified by:

physicalConnectionClosed in interface PooledConnectionEventListener

Parameters:

connectionEvent - instance of ConnectionEvent.

physicalConnectionDeallocated

public void physicalConnectionDeallocated(javax.sql.ConnectionEvent connectionEvent)

Notify about the deallocation of the physical connection.

Specified by:

physicalConnectionDeallocated in interface PooledConnectionEventListener

Parameters:

connectionEvent - instance of ConnectionEvent.

connectionErrorOccurred

public void connectionErrorOccurred(javax.sql.ConnectionEvent event)

Notify about serious error when using the connection. Currently these events are ignored.

Specified by:

connectionErrorOccurred in interface javax.sql.ConnectionEventListener

Parameters:

event - instance of ConnectionEvent containing information about an error.

getFreeSize

public int getFreeSize()
                throws java.sql.SQLException

Description copied from class: AbstractConnectionPool

Get number of free connections in this pool. This method returns the number of free open connections to the specified database. It might return 0, but this does not mean that next request will block. This will happen only if getMaxSize() != 0 && getMaxSize() == getWorkingSize(), meaning that we have allocated maximum number of connections and all of them are in use.

Specified by:

getFreeSize in class AbstractConnectionPool

Returns:

number of free connections left.

Throws:

java.sql.SQLException

getTotalSize

public int getTotalSize()
                 throws java.sql.SQLException

Description copied from class: AbstractConnectionPool

Get total size of physical connections opened to the database.

Specified by:

getTotalSize in class AbstractConnectionPool

Returns:

total number of opened connections to the database.

Throws:

java.sql.SQLException

getWorkingSize

public int getWorkingSize()
                   throws java.sql.SQLException

Description copied from class: AbstractConnectionPool

Get number of connections that are in use.

Specified by:

getWorkingSize in class AbstractConnectionPool

Returns:

number of working connections.

Throws:

java.sql.SQLException

createObjectInstance

protected BasicAbstractConnectionPool createObjectInstance()

Create instance of this data source.

Specified by:

createObjectInstance in class BasicAbstractConnectionPool

getObjectInstance

public java.lang.Object getObjectInstance(java.lang.Object obj,
                                          javax.naming.Name name,
                                          javax.naming.Context nameCtx,
                                          java.util.Hashtable environment)
                                   throws java.lang.Exception

Get object instance for the specified name in the specified context.

Specified by:

getObjectInstance in interface javax.naming.spi.ObjectFactory

Overrides:

getObjectInstance in class BasicAbstractConnectionPool

Throws:

java.lang.Exception

getDefaultReference

public javax.naming.Reference getDefaultReference()

Get default JNDI reference for this instance.

Overrides:

getDefaultReference in class BasicAbstractConnectionPool

Returns:

instance of Reference containing all information that allows to reconstruct the datasource.