Package 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:
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
Version:
$Id: PerUserPoolDataSource.java 1649430 2015-01-04 21:29:32Z tn $
Author:
John D. McNally
See Also:

  • Constructor Details

    • PerUserPoolDataSource

      public PerUserPoolDataSource()
      Default no-arg constructor for Serialization

  • Method Details

    • 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.

    • getReference

      public Reference getReference() throws NamingException
      Returns a PerUserPoolDataSource Reference.
      Throws:
      NamingException