PerUserPoolDataSource (Apache Commons DBCP 2.2.0 API)

java.lang.Object
- org.apache.commons.dbcp2.datasources.InstanceKeyDataSource
- - org.apache.commons.dbcp2.datasources.PerUserPoolDataSource

All Implemented Interfaces:

Serializable, AutoCloseable, Wrapper, Referenceable, CommonDataSource, DataSource
```
public class PerUserPoolDataSource
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. 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

Author:

John D. McNally

See Also:
Serialized Form

Field Summary
- Fields inherited from class org.apache.commons.dbcp2.datasources.InstanceKeyDataSource
  UNKNOWN_TRANSACTIONISOLATION

Constructor Summary

Constructors
Constructor and Description

PerUserPoolDataSource()
Default no-arg constructor for Serialization

Constructors
Constructor and Description
`PerUserPoolDataSource()` Default no-arg constructor for Serialization

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close pool(s) being maintained by this datasource.
`protected org.apache.commons.dbcp2.datasources.PooledConnectionManager`	`getConnectionManager(org.apache.commons.dbcp2.datasources.UserPassKey upkey)`
`int`	`getNumActive()` Get the number of active connections in the default pool.
`int`	`getNumActive(String username)` Get the number of active connections in the pool for a given user.
`int`	`getNumIdle()` Get the number of idle connections in the default pool.
`int`	`getNumIdle(String username)` Get the number of idle connections in the pool for a given user.
`boolean`	`getPerUserBlockWhenExhausted(String key)` Gets the user specific value for `BaseGenericObjectPool.getBlockWhenExhausted()` for the specified user's pool or the default if no user specific value is defined.
`Boolean`	`getPerUserDefaultAutoCommit(String key)` Gets the user specific default value for `Connection.setAutoCommit(boolean)` for the specified user's pool.
`Boolean`	`getPerUserDefaultReadOnly(String key)` Gets the user specific default value for `Connection.setReadOnly(boolean)` for the specified user's pool.
`Integer`	`getPerUserDefaultTransactionIsolation(String key)` Gets the user specific default value for `Connection.setTransactionIsolation(int)` for the specified user's pool.
`String`	`getPerUserEvictionPolicyClassName(String key)` Gets the user specific value for `BaseGenericObjectPool.getEvictionPolicyClassName()` for the specified user's pool or the default if no user specific value is defined.
`boolean`	`getPerUserLifo(String key)` Gets the user specific value for `BaseGenericObjectPool.getLifo()` for the specified user's pool or the default if no user specific value is defined.
`int`	`getPerUserMaxIdle(String key)` Gets the user specific value for `GenericObjectPool.getMaxIdle()` for the specified user's pool or the default if no user specific value is defined.
`int`	`getPerUserMaxTotal(String key)` Gets the user specific value for `BaseGenericObjectPool.getMaxTotal()` for the specified user's pool or the default if no user specific value is defined.
`long`	`getPerUserMaxWaitMillis(String key)` Gets the user specific value for `BaseGenericObjectPool.getMaxWaitMillis()` for the specified user's pool or the default if no user specific value is defined.
`long`	`getPerUserMinEvictableIdleTimeMillis(String key)` Gets the user specific value for `BaseGenericObjectPool.getMinEvictableIdleTimeMillis()` for the specified user's pool or the default if no user specific value is defined.
`int`	`getPerUserMinIdle(String key)` Gets the user specific value for `GenericObjectPool.getMinIdle()` for the specified user's pool or the default if no user specific value is defined.
`int`	`getPerUserNumTestsPerEvictionRun(String key)` Gets the user specific value for `BaseGenericObjectPool.getNumTestsPerEvictionRun()` for the specified user's pool or the default if no user specific value is defined.
`long`	`getPerUserSoftMinEvictableIdleTimeMillis(String key)` Gets the user specific value for `BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()` for the specified user's pool or the default if no user specific value is defined.
`boolean`	`getPerUserTestOnBorrow(String key)` Gets the user specific value for `BaseGenericObjectPool.getTestOnBorrow()` for the specified user's pool or the default if no user specific value is defined.
`boolean`	`getPerUserTestOnCreate(String key)` Gets the user specific value for `BaseGenericObjectPool.getTestOnCreate()` for the specified user's pool or the default if no user specific value is defined.
`boolean`	`getPerUserTestOnReturn(String key)` Gets the user specific value for `BaseGenericObjectPool.getTestOnReturn()` for the specified user's pool or the default if no user specific value is defined.
`boolean`	`getPerUserTestWhileIdle(String key)` Gets the user specific value for `BaseGenericObjectPool.getTestWhileIdle()` for the specified user's pool or the default if no user specific value is defined.
`long`	`getPerUserTimeBetweenEvictionRunsMillis(String key)` Gets the user specific value for `BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()` for the specified user's pool or the default if no user specific value is defined.
`protected org.apache.commons.dbcp2.datasources.PooledConnectionAndInfo`	`getPooledConnectionAndInfo(String username, String password)`
`Reference`	`getReference()` Returns a `PerUserPoolDataSource` `Reference`.
`void`	`setPerUserBlockWhenExhausted(String username, Boolean value)` Sets a user specific value for `BaseGenericObjectPool.getBlockWhenExhausted()` for the specified user's pool.
`void`	`setPerUserDefaultAutoCommit(String username, Boolean value)` Sets a user specific default value for `Connection.setAutoCommit(boolean)` for the specified user's pool.
`void`	`setPerUserDefaultReadOnly(String username, Boolean value)` Sets a user specific default value for `Connection.setReadOnly(boolean)` for the specified user's pool.
`void`	`setPerUserDefaultTransactionIsolation(String username, Integer value)` Sets a user specific default value for `Connection.setTransactionIsolation(int)` for the specified user's pool.
`void`	`setPerUserEvictionPolicyClassName(String username, String value)` Sets a user specific value for `BaseGenericObjectPool.getEvictionPolicyClassName()` for the specified user's pool.
`void`	`setPerUserLifo(String username, Boolean value)` Sets a user specific value for `BaseGenericObjectPool.getLifo()` for the specified user's pool.
`void`	`setPerUserMaxIdle(String username, Integer value)` Sets a user specific value for `GenericObjectPool.getMaxIdle()` for the specified user's pool.
`void`	`setPerUserMaxTotal(String username, Integer value)` Sets a user specific value for `BaseGenericObjectPool.getMaxTotal()` for the specified user's pool.
`void`	`setPerUserMaxWaitMillis(String username, Long value)` Sets a user specific value for `BaseGenericObjectPool.getMaxWaitMillis()` for the specified user's pool.
`void`	`setPerUserMinEvictableIdleTimeMillis(String username, Long value)` Sets a user specific value for `BaseGenericObjectPool.getMinEvictableIdleTimeMillis()` for the specified user's pool.
`void`	`setPerUserMinIdle(String username, Integer value)` Sets a user specific value for `GenericObjectPool.getMinIdle()` for the specified user's pool.
`void`	`setPerUserNumTestsPerEvictionRun(String username, Integer value)` Sets a user specific value for `BaseGenericObjectPool.getNumTestsPerEvictionRun()` for the specified user's pool.
`void`	`setPerUserSoftMinEvictableIdleTimeMillis(String username, Long value)` Sets a user specific value for `BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()` for the specified user's pool.
`void`	`setPerUserTestOnBorrow(String username, Boolean value)` Sets a user specific value for `BaseGenericObjectPool.getTestOnBorrow()` for the specified user's pool.
`void`	`setPerUserTestOnCreate(String username, Boolean value)` Sets a user specific value for `BaseGenericObjectPool.getTestOnCreate()` for the specified user's pool.
`void`	`setPerUserTestOnReturn(String username, Boolean value)` Sets a user specific value for `BaseGenericObjectPool.getTestOnReturn()` for the specified user's pool.
`void`	`setPerUserTestWhileIdle(String username, Boolean value)` Sets a user specific value for `BaseGenericObjectPool.getTestWhileIdle()` for the specified user's pool.
`void`	`setPerUserTimeBetweenEvictionRunsMillis(String username, Long value)` Sets a user specific value for `()` for the specified user's pool.
`protected void`	`setupDefaults(Connection con, String username)`

Methods inherited from class org.apache.commons.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
  - PerUserPoolDataSource
```
public PerUserPoolDataSource()
```
    Default no-arg constructor for Serialization
- Method Detail
  - close
```
public void close()
```
    Close pool(s) being maintained by this datasource.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class InstanceKeyDataSource
  - getPerUserBlockWhenExhausted
```
public boolean getPerUserBlockWhenExhausted(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getBlockWhenExhausted() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserBlockWhenExhausted
```
public void setPerUserBlockWhenExhausted(String username,
                                Boolean value)
```
    Sets a user specific value for BaseGenericObjectPool.getBlockWhenExhausted() for the specified user's pool.
  - getPerUserEvictionPolicyClassName
```
public String getPerUserEvictionPolicyClassName(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getEvictionPolicyClassName() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserEvictionPolicyClassName
```
public void setPerUserEvictionPolicyClassName(String username,
                                     String value)
```
    Sets a user specific value for BaseGenericObjectPool.getEvictionPolicyClassName() for the specified user's pool.
  - getPerUserLifo
```
public boolean getPerUserLifo(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getLifo() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserLifo
```
public void setPerUserLifo(String username,
                  Boolean value)
```
    Sets a user specific value for BaseGenericObjectPool.getLifo() for the specified user's pool.
  - getPerUserMaxIdle
```
public int getPerUserMaxIdle(String key)
```
    Gets the user specific value for GenericObjectPool.getMaxIdle() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserMaxIdle
```
public void setPerUserMaxIdle(String username,
                     Integer value)
```
    Sets a user specific value for GenericObjectPool.getMaxIdle() for the specified user's pool.
  - getPerUserMaxTotal
```
public int getPerUserMaxTotal(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getMaxTotal() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserMaxTotal
```
public void setPerUserMaxTotal(String username,
                      Integer value)
```
    Sets a user specific value for BaseGenericObjectPool.getMaxTotal() for the specified user's pool.
  - getPerUserMaxWaitMillis
```
public long getPerUserMaxWaitMillis(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getMaxWaitMillis() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserMaxWaitMillis
```
public void setPerUserMaxWaitMillis(String username,
                           Long value)
```
    Sets a user specific value for BaseGenericObjectPool.getMaxWaitMillis() for the specified user's pool.
  - getPerUserMinEvictableIdleTimeMillis
```
public long getPerUserMinEvictableIdleTimeMillis(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getMinEvictableIdleTimeMillis() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserMinEvictableIdleTimeMillis
```
public void setPerUserMinEvictableIdleTimeMillis(String username,
                                        Long value)
```
    Sets a user specific value for BaseGenericObjectPool.getMinEvictableIdleTimeMillis() for the specified user's pool.
  - getPerUserMinIdle
```
public int getPerUserMinIdle(String key)
```
    Gets the user specific value for GenericObjectPool.getMinIdle() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserMinIdle
```
public void setPerUserMinIdle(String username,
                     Integer value)
```
    Sets a user specific value for GenericObjectPool.getMinIdle() for the specified user's pool.
  - getPerUserNumTestsPerEvictionRun
```
public int getPerUserNumTestsPerEvictionRun(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getNumTestsPerEvictionRun() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserNumTestsPerEvictionRun
```
public void setPerUserNumTestsPerEvictionRun(String username,
                                    Integer value)
```
    Sets a user specific value for BaseGenericObjectPool.getNumTestsPerEvictionRun() for the specified user's pool.
  - getPerUserSoftMinEvictableIdleTimeMillis
```
public long getPerUserSoftMinEvictableIdleTimeMillis(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserSoftMinEvictableIdleTimeMillis
```
public void setPerUserSoftMinEvictableIdleTimeMillis(String username,
                                            Long value)
```
    Sets a user specific value for BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis() for the specified user's pool.
  - getPerUserTestOnCreate
```
public boolean getPerUserTestOnCreate(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getTestOnCreate() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserTestOnCreate
```
public void setPerUserTestOnCreate(String username,
                          Boolean value)
```
    Sets a user specific value for BaseGenericObjectPool.getTestOnCreate() for the specified user's pool.
  - getPerUserTestOnBorrow
```
public boolean getPerUserTestOnBorrow(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getTestOnBorrow() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserTestOnBorrow
```
public void setPerUserTestOnBorrow(String username,
                          Boolean value)
```
    Sets a user specific value for BaseGenericObjectPool.getTestOnBorrow() for the specified user's pool.
  - getPerUserTestOnReturn
```
public boolean getPerUserTestOnReturn(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getTestOnReturn() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserTestOnReturn
```
public void setPerUserTestOnReturn(String username,
                          Boolean value)
```
    Sets a user specific value for BaseGenericObjectPool.getTestOnReturn() for the specified user's pool.
  - getPerUserTestWhileIdle
```
public boolean getPerUserTestWhileIdle(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getTestWhileIdle() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserTestWhileIdle
```
public void setPerUserTestWhileIdle(String username,
                           Boolean value)
```
    Sets a user specific value for BaseGenericObjectPool.getTestWhileIdle() for the specified user's pool.
  - getPerUserTimeBetweenEvictionRunsMillis
```
public long getPerUserTimeBetweenEvictionRunsMillis(String key)
```
    Gets the user specific value for BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis() for the specified user's pool or the default if no user specific value is defined.
  - setPerUserTimeBetweenEvictionRunsMillis
```
public void setPerUserTimeBetweenEvictionRunsMillis(String username,
                                           Long value)
```
    Sets a user specific value for () for the specified user's pool.
  - getPerUserDefaultAutoCommit
```
public Boolean getPerUserDefaultAutoCommit(String key)
```
    Gets the user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.
  - setPerUserDefaultAutoCommit
```
public void setPerUserDefaultAutoCommit(String username,
                               Boolean value)
```
    Sets a user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.
  - getPerUserDefaultReadOnly
```
public Boolean getPerUserDefaultReadOnly(String key)
```
    Gets the user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.
  - setPerUserDefaultReadOnly
```
public void setPerUserDefaultReadOnly(String username,
                             Boolean value)
```
    Sets a user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.
  - getPerUserDefaultTransactionIsolation
```
public Integer getPerUserDefaultTransactionIsolation(String key)
```
    Gets the user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.
  - setPerUserDefaultTransactionIsolation
```
public void setPerUserDefaultTransactionIsolation(String username,
                                         Integer value)
```
    Sets a user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.
  - getNumActive
```
public int getNumActive()
```
    Get the number of active connections in the default pool.
  - getNumActive
```
public int getNumActive(String username)
```
    Get the number of active connections in the pool for a given user.
  - getNumIdle
```
public int getNumIdle()
```
    Get the number of idle connections in the default pool.
  - getNumIdle
```
public int getNumIdle(String username)
```
    Get the number of idle connections in the pool for a given user.
  - getPooledConnectionAndInfo
```
protected org.apache.commons.dbcp2.datasources.PooledConnectionAndInfo getPooledConnectionAndInfo(String username,
                                                                                      String password)
                                                                                           throws SQLException
```
    Specified by:
    
    getPooledConnectionAndInfo in class InstanceKeyDataSource
    
    Throws:
    
    SQLException
  - setupDefaults
```
protected void setupDefaults(Connection con,
                 String username)
                      throws SQLException
```
    Specified by:
    
    setupDefaults in class InstanceKeyDataSource
    
    Throws:
    
    SQLException
  - getConnectionManager
```
protected org.apache.commons.dbcp2.datasources.PooledConnectionManager getConnectionManager(org.apache.commons.dbcp2.datasources.UserPassKey upkey)
```
    Specified by:
    
    getConnectionManager in class InstanceKeyDataSource
  - getReference
```
public Reference getReference()
                       throws NamingException
```
    Returns a PerUserPoolDataSource Reference.
    
    Throws:
    
    NamingException

Class PerUserPoolDataSource

Field Summary

Fields inherited from class org.apache.commons.dbcp2.datasources.InstanceKeyDataSource

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.dbcp2.datasources.InstanceKeyDataSource

Methods inherited from class java.lang.Object

Constructor Detail

PerUserPoolDataSource

Method Detail

close

getPerUserBlockWhenExhausted

setPerUserBlockWhenExhausted

getPerUserEvictionPolicyClassName

setPerUserEvictionPolicyClassName

getPerUserLifo

setPerUserLifo

getPerUserMaxIdle

setPerUserMaxIdle

getPerUserMaxTotal

setPerUserMaxTotal

getPerUserMaxWaitMillis

setPerUserMaxWaitMillis

getPerUserMinEvictableIdleTimeMillis

setPerUserMinEvictableIdleTimeMillis

getPerUserMinIdle

setPerUserMinIdle

getPerUserNumTestsPerEvictionRun

setPerUserNumTestsPerEvictionRun

getPerUserSoftMinEvictableIdleTimeMillis

setPerUserSoftMinEvictableIdleTimeMillis

getPerUserTestOnCreate

setPerUserTestOnCreate

getPerUserTestOnBorrow

setPerUserTestOnBorrow

getPerUserTestOnReturn

setPerUserTestOnReturn

getPerUserTestWhileIdle

setPerUserTestWhileIdle

getPerUserTimeBetweenEvictionRunsMillis

setPerUserTimeBetweenEvictionRunsMillis

getPerUserDefaultAutoCommit

setPerUserDefaultAutoCommit

getPerUserDefaultReadOnly

setPerUserDefaultReadOnly

getPerUserDefaultTransactionIsolation

setPerUserDefaultTransactionIsolation

getNumActive

getNumActive

getNumIdle

getNumIdle

getPooledConnectionAndInfo

setupDefaults

getConnectionManager

getReference