Class PerUserPoolDataSource
- All Implemented Interfaces:
Serializable,AutoCloseable,Wrapper,Referenceable,CommonDataSource,DataSource
A pooling DataSource appropriate for deployment within J2EE environment. There are many configuration
options, most of which are defined in the parent class. This datasource uses individual pools per user, and some
properties can be set specifically for a given user, if the deployment environment can support initialization of
mapped properties. So for example, a pool of admin or write-access Connections can be guaranteed a certain number of
connections, separate from a maximum set for users with read-only connections.
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, the existing pool is cleared and a new pool is created
for connections using the new password.
- Since:
- 2.0
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.dbcp2.datasources.InstanceKeyDataSource
UNKNOWN_TRANSACTIONISOLATION -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Clears pool(s) maintained by this data source.voidclose()Closes pool(s) maintained by this data source.protected org.apache.commons.dbcp2.datasources.PooledConnectionManagergetConnectionManager(org.apache.commons.dbcp2.datasources.UserPassKey upKey) intGets the number of active connections in the default pool.intgetNumActive(String userName) Gets the number of active connections in the pool for a given user.intGets the number of idle connections in the default pool.intgetNumIdle(String userName) Gets the number of idle connections in the pool for a given user.booleangetPerUserBlockWhenExhausted(String userName) Gets the user specific value forBaseGenericObjectPool.getBlockWhenExhausted()for the specified user's pool or the default if no user specific value is defined.getPerUserDefaultAutoCommit(String userName) Gets the user specific default value forConnection.setAutoCommit(boolean)for the specified user's pool.getPerUserDefaultReadOnly(String userName) Gets the user specific default value forConnection.setReadOnly(boolean)for the specified user's pool.getPerUserDefaultTransactionIsolation(String userName) Gets the user specific default value forConnection.setTransactionIsolation(int)for the specified user's pool.getPerUserDurationBetweenEvictionRuns(String userName) Gets the user specific value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for the specified user's pool or the default if no user specific value is defined.getPerUserEvictionPolicyClassName(String userName) Gets the user specific value forBaseGenericObjectPool.getEvictionPolicyClassName()for the specified user's pool or the default if no user specific value is defined.booleangetPerUserLifo(String userName) Gets the user specific value forBaseGenericObjectPool.getLifo()for the specified user's pool or the default if no user specific value is defined.intgetPerUserMaxIdle(String userName) Gets the user specific value forGenericObjectPool.getMaxIdle()for the specified user's pool or the default if no user specific value is defined.intgetPerUserMaxTotal(String userName) Gets the user specific value forBaseGenericObjectPool.getMaxTotal()for the specified user's pool or the default if no user specific value is defined.getPerUserMaxWaitDuration(String userName) Gets the user specific value forBaseGenericObjectPool.getMaxWaitDuration()for the specified user's pool or the default if no user specific value is defined.longgetPerUserMaxWaitMillis(String userName) Deprecated.getPerUserMinEvictableIdleDuration(String userName) Gets the user specific value forBaseGenericObjectPool.getMinEvictableIdleDuration()for the specified user's pool or the default if no user specific value is defined.longgetPerUserMinEvictableIdleTimeMillis(String userName) Deprecated.intgetPerUserMinIdle(String userName) Gets the user specific value forGenericObjectPool.getMinIdle()for the specified user's pool or the default if no user specific value is defined.intgetPerUserNumTestsPerEvictionRun(String userName) Gets the user specific value forBaseGenericObjectPool.getNumTestsPerEvictionRun()for the specified user's pool or the default if no user specific value is defined.getPerUserSoftMinEvictableIdleDuration(String userName) Gets the user specific value forBaseGenericObjectPool.getSoftMinEvictableIdleDuration()for the specified user's pool or the default if no user specific value is defined.longDeprecated.booleangetPerUserTestOnBorrow(String userName) Gets the user specific value forBaseGenericObjectPool.getTestOnBorrow()for the specified user's pool or the default if no user specific value is defined.booleangetPerUserTestOnCreate(String userName) Gets the user specific value forBaseGenericObjectPool.getTestOnCreate()for the specified user's pool or the default if no user specific value is defined.booleangetPerUserTestOnReturn(String userName) Gets the user specific value forBaseGenericObjectPool.getTestOnReturn()for the specified user's pool or the default if no user specific value is defined.booleangetPerUserTestWhileIdle(String userName) Gets the user specific value forBaseGenericObjectPool.getTestWhileIdle()for the specified user's pool or the default if no user specific value is defined.longDeprecated.protected org.apache.commons.dbcp2.datasources.PooledConnectionAndInfogetPooledConnectionAndInfo(String userName, String password) This method is protected but can only be implemented in this package because PooledConnectionAndInfo is a package private type.Returns aPerUserPoolDataSourceReference.voidsetPerUserBlockWhenExhausted(String userName, Boolean value) Sets a user specific value forBaseGenericObjectPool.getBlockWhenExhausted()for the specified user's pool.voidsetPerUserDefaultAutoCommit(String userName, Boolean value) Sets a user specific default value forConnection.setAutoCommit(boolean)for the specified user's pool.voidsetPerUserDefaultReadOnly(String userName, Boolean value) Sets a user specific default value forConnection.setReadOnly(boolean)for the specified user's pool.voidsetPerUserDefaultTransactionIsolation(String userName, Integer value) Sets a user specific default value forConnection.setTransactionIsolation(int)for the specified user's pool.voidsetPerUserDurationBetweenEvictionRuns(String userName, Duration value) Sets a user specific value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for the specified user's pool.voidsetPerUserEvictionPolicyClassName(String userName, String value) Sets a user specific value forBaseGenericObjectPool.getEvictionPolicyClassName()for the specified user's pool.voidsetPerUserLifo(String userName, Boolean value) Sets a user specific value forBaseGenericObjectPool.getLifo()for the specified user's pool.voidsetPerUserMaxIdle(String userName, Integer value) Sets a user specific value forGenericObjectPool.getMaxIdle()for the specified user's pool.voidsetPerUserMaxTotal(String userName, Integer value) Sets a user specific value forBaseGenericObjectPool.getMaxTotal()for the specified user's pool.voidsetPerUserMaxWait(String userName, Duration value) Sets a user specific value forBaseGenericObjectPool.getMaxWaitDuration()for the specified user's pool.voidsetPerUserMaxWaitMillis(String userName, Long value) Deprecated.voidsetPerUserMinEvictableIdle(String userName, Duration value) Sets a user specific value forBaseGenericObjectPool.getMinEvictableIdleDuration()for the specified user's pool.voidsetPerUserMinEvictableIdleTimeMillis(String userName, Long value) Deprecated.voidsetPerUserMinIdle(String userName, Integer value) Sets a user specific value forGenericObjectPool.getMinIdle()for the specified user's pool.voidsetPerUserNumTestsPerEvictionRun(String userName, Integer value) Sets a user specific value forBaseGenericObjectPool.getNumTestsPerEvictionRun()for the specified user's pool.voidsetPerUserSoftMinEvictableIdle(String userName, Duration value) Sets a user specific value forBaseGenericObjectPool.getSoftMinEvictableIdleDuration()for the specified user's pool.voidsetPerUserSoftMinEvictableIdleTimeMillis(String userName, Long value) Deprecated.voidsetPerUserTestOnBorrow(String userName, Boolean value) Sets a user specific value forBaseGenericObjectPool.getTestOnBorrow()for the specified user's pool.voidsetPerUserTestOnCreate(String userName, Boolean value) Sets a user specific value forBaseGenericObjectPool.getTestOnCreate()for the specified user's pool.voidsetPerUserTestOnReturn(String userName, Boolean value) Sets a user specific value forBaseGenericObjectPool.getTestOnReturn()for the specified user's pool.voidsetPerUserTestWhileIdle(String userName, Boolean value) Sets a user specific value forBaseGenericObjectPool.getTestWhileIdle()for the specified user's pool.voidsetPerUserTimeBetweenEvictionRunsMillis(String userName, Long value) Deprecated.protected voidsetupDefaults(Connection con, String userName) Methods inherited from class org.apache.commons.dbcp2.datasources.InstanceKeyDataSource
assertInitializationAllowed, getConnection, getConnection, getConnectionPoolDataSource, getDataSourceName, getDefaultBlockWhenExhausted, getDefaultDurationBetweenEvictionRuns, getDefaultEvictionPolicyClassName, getDefaultLifo, getDefaultMaxIdle, getDefaultMaxTotal, getDefaultMaxWait, getDefaultMaxWaitMillis, getDefaultMinEvictableIdleDuration, getDefaultMinEvictableIdleTimeMillis, getDefaultMinIdle, getDefaultNumTestsPerEvictionRun, getDefaultSoftMinEvictableIdleDuration, getDefaultSoftMinEvictableIdleTimeMillis, getDefaultTestOnBorrow, getDefaultTestOnCreate, getDefaultTestOnReturn, getDefaultTestWhileIdle, getDefaultTimeBetweenEvictionRunsMillis, getDefaultTransactionIsolation, getDescription, getInstanceKey, getJndiEnvironment, getLoginTimeout, getLoginTimeoutDuration, getLogWriter, getMaxConnDuration, getMaxConnLifetime, getMaxConnLifetimeMillis, getParentLogger, getValidationQuery, getValidationQueryTimeout, getValidationQueryTimeoutDuration, isDefaultAutoCommit, isDefaultReadOnly, isRollbackAfterValidation, isWrapperFor, setConnectionPoolDataSource, setDataSourceName, setDefaultAutoCommit, setDefaultBlockWhenExhausted, setDefaultDurationBetweenEvictionRuns, setDefaultEvictionPolicyClassName, setDefaultLifo, setDefaultMaxIdle, setDefaultMaxTotal, setDefaultMaxWait, setDefaultMaxWaitMillis, setDefaultMinEvictableIdle, setDefaultMinEvictableIdleTimeMillis, setDefaultMinIdle, setDefaultNumTestsPerEvictionRun, setDefaultReadOnly, setDefaultSoftMinEvictableIdle, setDefaultSoftMinEvictableIdleTimeMillis, setDefaultTestOnBorrow, setDefaultTestOnCreate, setDefaultTestOnReturn, setDefaultTestWhileIdle, setDefaultTimeBetweenEvictionRunsMillis, setDefaultTransactionIsolation, setDescription, setJndiEnvironment, setLoginTimeout, setLoginTimeout, setLogWriter, setMaxConnLifetime, setMaxConnLifetimeMillis, setRollbackAfterValidation, setValidationQuery, setValidationQueryTimeout, setValidationQueryTimeout, testCPDS, toString, toStringFields, unwrap
-
Constructor Details
-
PerUserPoolDataSource
public PerUserPoolDataSource()Constructs a new instance.
-
-
Method Details
-
clear
Clears pool(s) maintained by this data source.- Since:
- 2.3.0
- See Also:
-
close
Closes pool(s) maintained by this data source.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein classInstanceKeyDataSource- See Also:
-
getConnectionManager
protected org.apache.commons.dbcp2.datasources.PooledConnectionManager getConnectionManager(org.apache.commons.dbcp2.datasources.UserPassKey upKey) - Specified by:
getConnectionManagerin classInstanceKeyDataSource
-
getNumActive
Gets the number of active connections in the default pool.- Returns:
- The number of active connections in the default pool.
-
getNumActive
Gets the number of active connections in the pool for a given user.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getNumIdle
Gets the number of idle connections in the default pool.- Returns:
- The number of idle connections in the default pool.
-
getNumIdle
Gets the number of idle connections in the pool for a given user.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserBlockWhenExhausted
Gets the user specific value forBaseGenericObjectPool.getBlockWhenExhausted()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserDefaultAutoCommit
Gets the user specific default value forConnection.setAutoCommit(boolean)for the specified user's pool.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserDefaultReadOnly
Gets the user specific default value forConnection.setReadOnly(boolean)for the specified user's pool.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserDefaultTransactionIsolation
Gets the user specific default value forConnection.setTransactionIsolation(int)for the specified user's pool.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserDurationBetweenEvictionRuns
Gets the user specific value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
- Since:
- 2.10.0
-
getPerUserEvictionPolicyClassName
Gets the user specific value forBaseGenericObjectPool.getEvictionPolicyClassName()for the specified user's pool or the default if no user specific value is defined.The class must implement
EvictionPolicy.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserLifo
Gets the user specific value forBaseGenericObjectPool.getLifo()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserMaxIdle
Gets the user specific value forGenericObjectPool.getMaxIdle()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserMaxTotal
Gets the user specific value forBaseGenericObjectPool.getMaxTotal()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserMaxWaitDuration
Gets the user specific value forBaseGenericObjectPool.getMaxWaitDuration()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
- Since:
- 2.10.0
-
getPerUserMaxWaitMillis
Deprecated.Gets the user specific value forBaseGenericObjectPool.getMaxWaitDuration()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserMinEvictableIdleDuration
Gets the user specific value forBaseGenericObjectPool.getMinEvictableIdleDuration()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value, never null.
- Since:
- 2.10.0
-
getPerUserMinEvictableIdleTimeMillis
Deprecated.Gets the user specific value forBaseGenericObjectPool.getMinEvictableIdleDuration()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserMinIdle
Gets the user specific value forGenericObjectPool.getMinIdle()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserNumTestsPerEvictionRun
Gets the user specific value forBaseGenericObjectPool.getNumTestsPerEvictionRun()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserSoftMinEvictableIdleDuration
Gets the user specific value forBaseGenericObjectPool.getSoftMinEvictableIdleDuration()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
- Since:
- 2.10.0
-
getPerUserSoftMinEvictableIdleTimeMillis
Deprecated.Gets the user specific value forBaseGenericObjectPool.getSoftMinEvictableIdleDuration()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserTestOnBorrow
Gets the user specific value forBaseGenericObjectPool.getTestOnBorrow()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserTestOnCreate
Gets the user specific value forBaseGenericObjectPool.getTestOnCreate()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserTestOnReturn
Gets the user specific value forBaseGenericObjectPool.getTestOnReturn()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserTestWhileIdle
Gets the user specific value forBaseGenericObjectPool.getTestWhileIdle()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPerUserTimeBetweenEvictionRunsMillis
Deprecated.Gets the user specific value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for the specified user's pool or the default if no user specific value is defined.- Parameters:
userName- The user name key.- Returns:
- The user specific value.
-
getPooledConnectionAndInfo
protected org.apache.commons.dbcp2.datasources.PooledConnectionAndInfo getPooledConnectionAndInfo(String userName, String password) throws SQLException Description copied from class:InstanceKeyDataSourceThis method is protected but can only be implemented in this package because PooledConnectionAndInfo is a package private type.- Specified by:
getPooledConnectionAndInfoin classInstanceKeyDataSource- Parameters:
userName- The user name.password- The user password.- Returns:
- Matching PooledConnectionAndInfo.
- Throws:
SQLException- Connection or registration failure.
-
getReference
Returns aPerUserPoolDataSourceReference.- Throws:
NamingException
-
setPerUserBlockWhenExhausted
Sets a user specific value forBaseGenericObjectPool.getBlockWhenExhausted()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserDefaultAutoCommit
Sets a user specific default value forConnection.setAutoCommit(boolean)for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserDefaultReadOnly
Sets a user specific default value forConnection.setReadOnly(boolean)for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserDefaultTransactionIsolation
Sets a user specific default value forConnection.setTransactionIsolation(int)for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserDurationBetweenEvictionRuns
Sets a user specific value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.- Since:
- 2.10.0
-
setPerUserEvictionPolicyClassName
Sets a user specific value forBaseGenericObjectPool.getEvictionPolicyClassName()for the specified user's pool.The class must implement
EvictionPolicy.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserLifo
Sets a user specific value forBaseGenericObjectPool.getLifo()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserMaxIdle
Sets a user specific value forGenericObjectPool.getMaxIdle()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserMaxTotal
Sets a user specific value forBaseGenericObjectPool.getMaxTotal()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserMaxWait
Sets a user specific value forBaseGenericObjectPool.getMaxWaitDuration()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.- Since:
- 2.10.0
-
setPerUserMaxWaitMillis
Deprecated.Sets a user specific value forBaseGenericObjectPool.getMaxWaitDuration()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserMinEvictableIdle
Sets a user specific value forBaseGenericObjectPool.getMinEvictableIdleDuration()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.- Since:
- 2.10.0
-
setPerUserMinEvictableIdleTimeMillis
Deprecated.Sets a user specific value forBaseGenericObjectPool.getMinEvictableIdleDuration()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserMinIdle
Sets a user specific value forGenericObjectPool.getMinIdle()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserNumTestsPerEvictionRun
Sets a user specific value forBaseGenericObjectPool.getNumTestsPerEvictionRun()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserSoftMinEvictableIdle
Sets a user specific value forBaseGenericObjectPool.getSoftMinEvictableIdleDuration()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.- Since:
- 2.10.0
-
setPerUserSoftMinEvictableIdleTimeMillis
Deprecated.Sets a user specific value forBaseGenericObjectPool.getSoftMinEvictableIdleDuration()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserTestOnBorrow
Sets a user specific value forBaseGenericObjectPool.getTestOnBorrow()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserTestOnCreate
Sets a user specific value forBaseGenericObjectPool.getTestOnCreate()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserTestOnReturn
Sets a user specific value forBaseGenericObjectPool.getTestOnReturn()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserTestWhileIdle
Sets a user specific value forBaseGenericObjectPool.getTestWhileIdle()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setPerUserTimeBetweenEvictionRunsMillis
Deprecated.Sets a user specific value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for the specified user's pool.- Parameters:
userName- The user name key.value- The user specific value.
-
setupDefaults
- Specified by:
setupDefaultsin classInstanceKeyDataSource- Throws:
SQLException
-
getPerUserMaxWaitDuration(java.lang.String).