org.apache.commons.dbcp2.datasources

Class PerUserPoolDataSource

java.lang.Object

org.apache.commons.dbcp2.datasources.InstanceKeyDataSource

org.apache.commons.dbcp2.datasources.PerUserPoolDataSource

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.sql.Wrapper, javax.naming.Referenceable, javax.sql.CommonDataSource, javax.sql.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

Version:

$Id: PerUserPoolDataSource.java 1649430 2015-01-04 21:29:32Z tn $

Author:

John D. McNally

See Also:

Serialized Form

Constructor Summary

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.
int	getNumActive() Get the number of active connections in the default pool.
int	getNumActive(java.lang.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(java.lang.String username) Get the number of idle connections in the pool for a given user.
boolean	getPerUserBlockWhenExhausted(java.lang.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.
java.lang.Boolean	getPerUserDefaultAutoCommit(java.lang.String key) Gets the user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.
java.lang.Boolean	getPerUserDefaultReadOnly(java.lang.String key) Gets the user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.
java.lang.Integer	getPerUserDefaultTransactionIsolation(java.lang.String key) Gets the user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.
java.lang.String	getPerUserEvictionPolicyClassName(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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.
javax.naming.Reference	getReference() Returns a PerUserPoolDataSource Reference.
void	setPerUserBlockWhenExhausted(java.lang.String username, java.lang.Boolean value) Sets a user specific value for BaseGenericObjectPool.getBlockWhenExhausted() for the specified user's pool.
void	setPerUserDefaultAutoCommit(java.lang.String username, java.lang.Boolean value) Sets a user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.
void	setPerUserDefaultReadOnly(java.lang.String username, java.lang.Boolean value) Sets a user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.
void	setPerUserDefaultTransactionIsolation(java.lang.String username, java.lang.Integer value) Sets a user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.
void	setPerUserEvictionPolicyClassName(java.lang.String username, java.lang.String value) Sets a user specific value for BaseGenericObjectPool.getEvictionPolicyClassName() for the specified user's pool.
void	setPerUserLifo(java.lang.String username, java.lang.Boolean value) Sets a user specific value for BaseGenericObjectPool.getLifo() for the specified user's pool.
void	setPerUserMaxIdle(java.lang.String username, java.lang.Integer value) Sets a user specific value for GenericObjectPool.getMaxIdle() for the specified user's pool.
void	setPerUserMaxTotal(java.lang.String username, java.lang.Integer value) Sets a user specific value for BaseGenericObjectPool.getMaxTotal() for the specified user's pool.
void	setPerUserMaxWaitMillis(java.lang.String username, java.lang.Long value) Sets a user specific value for BaseGenericObjectPool.getMaxWaitMillis() for the specified user's pool.
void	setPerUserMinEvictableIdleTimeMillis(java.lang.String username, java.lang.Long value) Sets a user specific value for BaseGenericObjectPool.getMinEvictableIdleTimeMillis() for the specified user's pool.
void	setPerUserMinIdle(java.lang.String username, java.lang.Integer value) Sets a user specific value for GenericObjectPool.getMinIdle() for the specified user's pool.
void	setPerUserNumTestsPerEvictionRun(java.lang.String username, java.lang.Integer value) Sets a user specific value for BaseGenericObjectPool.getNumTestsPerEvictionRun() for the specified user's pool.
void	setPerUserSoftMinEvictableIdleTimeMillis(java.lang.String username, java.lang.Long value) Sets a user specific value for BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis() for the specified user's pool.
void	setPerUserTestOnBorrow(java.lang.String username, java.lang.Boolean value) Sets a user specific value for BaseGenericObjectPool.getTestOnBorrow() for the specified user's pool.
void	setPerUserTestOnCreate(java.lang.String username, java.lang.Boolean value) Sets a user specific value for BaseGenericObjectPool.getTestOnCreate() for the specified user's pool.
void	setPerUserTestOnReturn(java.lang.String username, java.lang.Boolean value) Sets a user specific value for BaseGenericObjectPool.getTestOnReturn() for the specified user's pool.
void	setPerUserTestWhileIdle(java.lang.String username, java.lang.Boolean value) Sets a user specific value for BaseGenericObjectPool.getTestWhileIdle() for the specified user's pool.
void	setPerUserTimeBetweenEvictionRunsMillis(java.lang.String username, java.lang.Long value) Sets a user specific value for () for the specified user's pool.

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

getConnection, getConnection, getConnectionPoolDataSource, getDataSourceName, getDefaultBlockWhenExhausted, getDefaultEvictionPolicyClassName, getDefaultLifo, getDefaultMaxIdle, getDefaultMaxTotal, getDefaultMaxWaitMillis, getDefaultMinEvictableIdleTimeMillis, getDefaultMinIdle, getDefaultNumTestsPerEvictionRun, getDefaultSoftMinEvictableIdleTimeMillis, getDefaultTestOnBorrow, getDefaultTestOnCreate, getDefaultTestOnReturn, getDefaultTestWhileIdle, getDefaultTimeBetweenEvictionRunsMillis, getDefaultTransactionIsolation, getDescription, 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, unwrap

Methods inherited from class java.lang.Object

equals, 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 java.lang.AutoCloseable

Specified by:

close in class InstanceKeyDataSource

getNumActive

public int getNumActive()

Get the number of active connections in the default pool.

getNumActive

public int getNumActive(java.lang.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(java.lang.String username)

Get the number of idle connections in the pool for a given user.

getPerUserBlockWhenExhausted

public boolean getPerUserBlockWhenExhausted(java.lang.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.

getPerUserDefaultAutoCommit

public java.lang.Boolean getPerUserDefaultAutoCommit(java.lang.String key)

Gets the user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.

getPerUserDefaultReadOnly

public java.lang.Boolean getPerUserDefaultReadOnly(java.lang.String key)

Gets the user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.

getPerUserDefaultTransactionIsolation

public java.lang.Integer getPerUserDefaultTransactionIsolation(java.lang.String key)

Gets the user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.

getPerUserEvictionPolicyClassName

public java.lang.String getPerUserEvictionPolicyClassName(java.lang.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.

getPerUserLifo

public boolean getPerUserLifo(java.lang.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.

getPerUserMaxIdle

public int getPerUserMaxIdle(java.lang.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.

getPerUserMaxTotal

public int getPerUserMaxTotal(java.lang.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.

getPerUserMaxWaitMillis

public long getPerUserMaxWaitMillis(java.lang.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.

getPerUserMinEvictableIdleTimeMillis

public long getPerUserMinEvictableIdleTimeMillis(java.lang.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.

getPerUserMinIdle

public int getPerUserMinIdle(java.lang.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.

getPerUserNumTestsPerEvictionRun

public int getPerUserNumTestsPerEvictionRun(java.lang.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.

getPerUserSoftMinEvictableIdleTimeMillis

public long getPerUserSoftMinEvictableIdleTimeMillis(java.lang.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.

getPerUserTestOnBorrow

public boolean getPerUserTestOnBorrow(java.lang.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.

getPerUserTestOnCreate

public boolean getPerUserTestOnCreate(java.lang.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.

getPerUserTestOnReturn

public boolean getPerUserTestOnReturn(java.lang.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.

getPerUserTestWhileIdle

public boolean getPerUserTestWhileIdle(java.lang.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.

getPerUserTimeBetweenEvictionRunsMillis

public long getPerUserTimeBetweenEvictionRunsMillis(java.lang.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.

getReference

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

Returns a PerUserPoolDataSource Reference.

Throws:

javax.naming.NamingException

setPerUserBlockWhenExhausted

public void setPerUserBlockWhenExhausted(java.lang.String username,
                                java.lang.Boolean value)

Sets a user specific value for BaseGenericObjectPool.getBlockWhenExhausted() for the specified user's pool.

setPerUserDefaultAutoCommit

public void setPerUserDefaultAutoCommit(java.lang.String username,
                               java.lang.Boolean value)

Sets a user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.

setPerUserDefaultReadOnly

public void setPerUserDefaultReadOnly(java.lang.String username,
                             java.lang.Boolean value)

Sets a user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.

setPerUserDefaultTransactionIsolation

public void setPerUserDefaultTransactionIsolation(java.lang.String username,
                                         java.lang.Integer value)

Sets a user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.

setPerUserEvictionPolicyClassName

public void setPerUserEvictionPolicyClassName(java.lang.String username,
                                     java.lang.String value)

Sets a user specific value for BaseGenericObjectPool.getEvictionPolicyClassName() for the specified user's pool.

setPerUserLifo

public void setPerUserLifo(java.lang.String username,
                  java.lang.Boolean value)

Sets a user specific value for BaseGenericObjectPool.getLifo() for the specified user's pool.

setPerUserMaxIdle

public void setPerUserMaxIdle(java.lang.String username,
                     java.lang.Integer value)

Sets a user specific value for GenericObjectPool.getMaxIdle() for the specified user's pool.

setPerUserMaxTotal

public void setPerUserMaxTotal(java.lang.String username,
                      java.lang.Integer value)

Sets a user specific value for BaseGenericObjectPool.getMaxTotal() for the specified user's pool.

setPerUserMaxWaitMillis

public void setPerUserMaxWaitMillis(java.lang.String username,
                           java.lang.Long value)

Sets a user specific value for BaseGenericObjectPool.getMaxWaitMillis() for the specified user's pool.

setPerUserMinEvictableIdleTimeMillis

public void setPerUserMinEvictableIdleTimeMillis(java.lang.String username,
                                        java.lang.Long value)

Sets a user specific value for BaseGenericObjectPool.getMinEvictableIdleTimeMillis() for the specified user's pool.

setPerUserMinIdle

public void setPerUserMinIdle(java.lang.String username,
                     java.lang.Integer value)

Sets a user specific value for GenericObjectPool.getMinIdle() for the specified user's pool.

setPerUserNumTestsPerEvictionRun

public void setPerUserNumTestsPerEvictionRun(java.lang.String username,
                                    java.lang.Integer value)

Sets a user specific value for BaseGenericObjectPool.getNumTestsPerEvictionRun() for the specified user's pool.

setPerUserSoftMinEvictableIdleTimeMillis

public void setPerUserSoftMinEvictableIdleTimeMillis(java.lang.String username,
                                            java.lang.Long value)

Sets a user specific value for BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis() for the specified user's pool.

setPerUserTestOnBorrow

public void setPerUserTestOnBorrow(java.lang.String username,
                          java.lang.Boolean value)

Sets a user specific value for BaseGenericObjectPool.getTestOnBorrow() for the specified user's pool.

setPerUserTestOnCreate

public void setPerUserTestOnCreate(java.lang.String username,
                          java.lang.Boolean value)

Sets a user specific value for BaseGenericObjectPool.getTestOnCreate() for the specified user's pool.

setPerUserTestOnReturn

public void setPerUserTestOnReturn(java.lang.String username,
                          java.lang.Boolean value)

Sets a user specific value for BaseGenericObjectPool.getTestOnReturn() for the specified user's pool.

setPerUserTestWhileIdle

public void setPerUserTestWhileIdle(java.lang.String username,
                           java.lang.Boolean value)

Sets a user specific value for BaseGenericObjectPool.getTestWhileIdle() for the specified user's pool.

setPerUserTimeBetweenEvictionRunsMillis

public void setPerUserTimeBetweenEvictionRunsMillis(java.lang.String username,
                                           java.lang.Long value)

Sets a user specific value for () for the specified user's pool.