Package org.apache.tomcat.dbcp.dbcp2.datasources

Class SharedPoolDataSource

java.lang.Object

org.apache.tomcat.dbcp.dbcp2.datasources.InstanceKeyDataSource

org.apache.tomcat.dbcp.dbcp2.datasources.SharedPoolDataSource

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.sql.Wrapper, javax.naming.Referenceable, javax.sql.CommonDataSource, javax.sql.DataSource

public class SharedPoolDataSource
extends InstanceKeyDataSource

A pooling DataSource appropriate for deployment within J2EE environment. There are many configuration options, most of which are defined in the parent class. All users (based on username) share a single maximum number of Connections in this datasource.

User passwords can be changed without re-initializing the datasource. When a getConnection(username, password) request is processed with a password that is different from those used to create connections in the pool associated with username, an attempt is made to create a new connection using the supplied password and if this succeeds, idle connections created using the old password are destroyed and new connections are created using the new password.

Since:

2.0

Author:

John D. McNally

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.tomcat.dbcp.dbcp2.datasources.InstanceKeyDataSource

UNKNOWN_TRANSACTIONISOLATION

Constructor Summary

Constructors

Constructor	Description
SharedPoolDataSource()	Default no-arg constructor for Serialization

Method Summary

Modifier and Type	Method	Description
void	close()	Close pool being maintained by this datasource.
protected org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionManager	getConnectionManager(org.apache.tomcat.dbcp.dbcp2.datasources.UserPassKey upkey)
int	getMaxTotal()
int	getNumActive()
int	getNumIdle()
protected org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionAndInfo	getPooledConnectionAndInfo(java.lang.String username, java.lang.String password)
javax.naming.Reference	getReference()
void	setMaxTotal(int maxTotal)	Set BaseGenericObjectPool.getMaxTotal() for this pool.
protected void	setupDefaults(java.sql.Connection con, java.lang.String username)

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Methods inherited from class org.apache.tomcat.dbcp.dbcp2.datasources.InstanceKeyDataSource

assertInitializationAllowed, getConnection, getConnection, getConnectionPoolDataSource, getDataSourceName, getDefaultBlockWhenExhausted, getDefaultEvictionPolicyClassName, getDefaultLifo, getDefaultMaxIdle, getDefaultMaxTotal, getDefaultMaxWaitMillis, getDefaultMinEvictableIdleTimeMillis, getDefaultMinIdle, getDefaultNumTestsPerEvictionRun, getDefaultSoftMinEvictableIdleTimeMillis, getDefaultTestOnBorrow, getDefaultTestOnCreate, getDefaultTestOnReturn, getDefaultTestWhileIdle, getDefaultTimeBetweenEvictionRunsMillis, getDefaultTransactionIsolation, getDescription, getInstanceKey, getJndiEnvironment, getLoginTimeout, getLogWriter, getMaxConnLifetimeMillis, getParentLogger, getValidationQuery, getValidationQueryTimeout, isDefaultAutoCommit, isDefaultReadOnly, isRollbackAfterValidation, isWrapperFor, setConnectionPoolDataSource, setDataSourceName, setDefaultAutoCommit, setDefaultBlockWhenExhausted, setDefaultEvictionPolicyClassName, setDefaultLifo, setDefaultMaxIdle, setDefaultMaxTotal, setDefaultMaxWaitMillis, setDefaultMinEvictableIdleTimeMillis, setDefaultMinIdle, setDefaultNumTestsPerEvictionRun, setDefaultReadOnly, setDefaultSoftMinEvictableIdleTimeMillis, setDefaultTestOnBorrow, setDefaultTestOnCreate, setDefaultTestOnReturn, setDefaultTestWhileIdle, setDefaultTimeBetweenEvictionRunsMillis, setDefaultTransactionIsolation, setDescription, setJndiEnvironment, setLoginTimeout, setLogWriter, setMaxConnLifetimeMillis, setRollbackAfterValidation, setValidationQuery, setValidationQueryTimeout, testCPDS, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedPoolDataSource

public SharedPoolDataSource()

Default no-arg constructor for Serialization

Method Detail

close

public void close()
           throws java.lang.Exception

Close pool being maintained by this datasource.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class InstanceKeyDataSource

Throws:

java.lang.Exception

getMaxTotal

public int getMaxTotal()

Returns:

BaseGenericObjectPool.getMaxTotal() for this pool.

setMaxTotal

public void setMaxTotal(int maxTotal)

Set BaseGenericObjectPool.getMaxTotal() for this pool.

Parameters:

maxTotal - The max total value

getNumActive

public int getNumActive()

Returns:

the number of active connections in the pool.

getNumIdle

public int getNumIdle()

Returns:

the number of idle connections in the pool.

getPooledConnectionAndInfo

protected org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionAndInfo getPooledConnectionAndInfo(java.lang.String username,
                                                                                                      java.lang.String password)
                                                                                               throws java.sql.SQLException

Specified by:

getPooledConnectionAndInfo in class InstanceKeyDataSource

Throws:

java.sql.SQLException

getConnectionManager

protected org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionManager getConnectionManager(org.apache.tomcat.dbcp.dbcp2.datasources.UserPassKey upkey)

Specified by:

getConnectionManager in class InstanceKeyDataSource

getReference

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

Returns:

a SharedPoolDataSource Reference.

Throws:

javax.naming.NamingException - Should not occur

setupDefaults

protected void setupDefaults(java.sql.Connection con,
                             java.lang.String username)
                      throws java.sql.SQLException

Specified by:

setupDefaults in class InstanceKeyDataSource

Throws:

java.sql.SQLException