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
See Also:

  • Field Details

  • Constructor Details

    • PerUserPoolDataSource

      public PerUserPoolDataSource()
      Default no-arg constructor for Serialization.

  • Method Details

    • createMap

      private static <K, V> HashMap<K,V> createMap()

    • clear

      public void clear()
      Clears pool(s) maintained by this data source.
      Since:
      2.3.0
      See Also:
      • ObjectPool.clear()

    • close

      public void close()
      Closes pool(s) maintained by this data source.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in class InstanceKeyDataSource
      See Also:
      • ObjectPool.close()

    • convertMap

      private Map<String,Duration> convertMap(Map<String,Duration> currentMap, Map<String,Long> longMap)
      Converts a map with Long milliseconds values to another map with Duration values.

    • getConnectionManager

      protected PooledConnectionManager getConnectionManager(UserPassKey upKey)
      Specified by:
      getConnectionManager in class InstanceKeyDataSource

    • getCPDSConnectionFactoryPool

      private org.apache.commons.pool2.ObjectPool<PooledConnectionAndInfo> getCPDSConnectionFactoryPool(PooledConnectionManager manager)
      Gets the underlying pool but does NOT allocate it.
      Parameters:
      manager - A CPDSConnectionFactory.
      Returns:
      the underlying pool.

    • getNumActive

      public int getNumActive()
      Gets the number of active connections in the default pool.
      Returns:
      The number of active connections in the default pool.

    • getNumActive

      public int getNumActive(String userName)
      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

      public int getNumIdle()
      Gets the number of idle connections in the default pool.
      Returns:
      The number of idle connections in the default pool.

    • getNumIdle

      public int getNumIdle(String userName)
      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

      public boolean getPerUserBlockWhenExhausted(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public Boolean getPerUserDefaultAutoCommit(String userName)
      Gets the user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.
      Parameters:
      userName - The user name key.
      Returns:
      The user specific value.

    • getPerUserDefaultReadOnly

      public Boolean getPerUserDefaultReadOnly(String userName)
      Gets the user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.
      Parameters:
      userName - The user name key.
      Returns:
      The user specific value.

    • getPerUserDefaultTransactionIsolation

      public Integer getPerUserDefaultTransactionIsolation(String userName)
      Gets the user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.
      Parameters:
      userName - The user name key.
      Returns:
      The user specific value.

    • getPerUserDurationBetweenEvictionRuns

      public Duration getPerUserDurationBetweenEvictionRuns(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public String getPerUserEvictionPolicyClassName(String userName)
      Gets the user specific value for BaseGenericObjectPool.getEvictionPolicyClassName() 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.

    • getPerUserLifo

      public boolean getPerUserLifo(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public int getPerUserMaxIdle(String userName)
      Gets the user specific value for GenericObjectPool.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

      public int getPerUserMaxTotal(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public Duration getPerUserMaxWaitDuration(String userName)
      Gets the user specific value for BaseGenericObjectPool.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 public long getPerUserMaxWaitMillis(String userName)
      Deprecated.
      Use getPerUserMaxWaitDuration(java.lang.String).
      Gets the user specific value for BaseGenericObjectPool.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

      public Duration getPerUserMinEvictableIdleDuration(String userName)
      Gets the user specific value for BaseGenericObjectPool.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 public long getPerUserMinEvictableIdleTimeMillis(String userName)
      Deprecated.
      Use getPerUserMinEvictableIdleDuration(String).
      Gets the user specific value for BaseGenericObjectPool.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

      public int getPerUserMinIdle(String userName)
      Gets the user specific value for GenericObjectPool.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

      public int getPerUserNumTestsPerEvictionRun(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public Duration getPerUserSoftMinEvictableIdleDuration(String userName)
      Gets the user specific value for BaseGenericObjectPool.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 public long getPerUserSoftMinEvictableIdleTimeMillis(String userName)
      Deprecated.
      Use getPerUserSoftMinEvictableIdleDuration(String).
      Gets the user specific value for BaseGenericObjectPool.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

      public boolean getPerUserTestOnBorrow(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public boolean getPerUserTestOnCreate(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public boolean getPerUserTestOnReturn(String userName)
      Gets the user specific value for BaseGenericObjectPool.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

      public boolean getPerUserTestWhileIdle(String userName)
      Gets the user specific value for BaseGenericObjectPool.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 public long getPerUserTimeBetweenEvictionRunsMillis(String userName)
      Deprecated.
      Use getPerUserDurationBetweenEvictionRuns(String).
      Gets the user specific value for BaseGenericObjectPool.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.

    • getPool

      private org.apache.commons.pool2.ObjectPool<PooledConnectionAndInfo> getPool(PoolKey poolKey)
      Returns the object pool associated with the given PoolKey.
      Parameters:
      poolKey - PoolKey identifying the pool
      Returns:
      the GenericObjectPool pooling connections for the userName and datasource specified by the PoolKey

    • getPooledConnectionAndInfo

      protected PooledConnectionAndInfo getPooledConnectionAndInfo(String userName, String password) throws SQLException
      Description copied from class: InstanceKeyDataSource
      This method is protected but can only be implemented in this package because PooledConnectionAndInfo is a package private type.
      Specified by:
      getPooledConnectionAndInfo in class InstanceKeyDataSource
      Parameters:
      userName - The user name.
      password - The user password.
      Returns:
      Matching PooledConnectionAndInfo.
      Throws:
      SQLException - Connection or registration failure.

    • getPoolKey

      private PoolKey getPoolKey(String userName)
      Creates a pool key from the provided parameters.
      Parameters:
      userName - User name
      Returns:
      The pool key

    • getReference

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

    • put

      <K, V> Map<K,V> put(Map<K,V> map, K key, V value)

    • readObject

      private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
      Supports Serialization interface.
      Parameters:
      in - a ObjectInputStream value
      Throws:
      IOException - if an error occurs
      ClassNotFoundException - if an error occurs

    • registerPool

      private void registerPool(String userName, String password) throws NamingException, SQLException
      Throws:
      NamingException
      SQLException

    • replaceAll

      private <K, V> Map<K,V> replaceAll(Map<K,V> currentMap, Map<K,V> newMap)

    • setPerUserBlockWhenExhausted

      void setPerUserBlockWhenExhausted(Map<String,Boolean> newMap)

    • setPerUserBlockWhenExhausted

      public void setPerUserBlockWhenExhausted(String userName, Boolean value)
      Sets a user specific value for BaseGenericObjectPool.getBlockWhenExhausted() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserDefaultAutoCommit

      void setPerUserDefaultAutoCommit(Map<String,Boolean> newMap)

    • setPerUserDefaultAutoCommit

      public void setPerUserDefaultAutoCommit(String userName, Boolean value)
      Sets a user specific default value for Connection.setAutoCommit(boolean) for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserDefaultReadOnly

      void setPerUserDefaultReadOnly(Map<String,Boolean> newMap)

    • setPerUserDefaultReadOnly

      public void setPerUserDefaultReadOnly(String userName, Boolean value)
      Sets a user specific default value for Connection.setReadOnly(boolean) for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserDefaultTransactionIsolation

      void setPerUserDefaultTransactionIsolation(Map<String,Integer> newMap)

    • setPerUserDefaultTransactionIsolation

      public void setPerUserDefaultTransactionIsolation(String userName, Integer value)
      Sets a user specific default value for Connection.setTransactionIsolation(int) for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserDurationBetweenEvictionRuns

      void setPerUserDurationBetweenEvictionRuns(Map<String,Duration> newMap)

    • setPerUserDurationBetweenEvictionRuns

      public void setPerUserDurationBetweenEvictionRuns(String userName, Duration value)
      Sets a user specific value for BaseGenericObjectPool.getDurationBetweenEvictionRuns() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.
      Since:
      2.10.0

    • setPerUserEvictionPolicyClassName

      void setPerUserEvictionPolicyClassName(Map<String,String> newMap)

    • setPerUserEvictionPolicyClassName

      public void setPerUserEvictionPolicyClassName(String userName, String value)
      Sets a user specific value for BaseGenericObjectPool.getEvictionPolicyClassName() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserLifo

      void setPerUserLifo(Map<String,Boolean> newMap)

    • setPerUserLifo

      public void setPerUserLifo(String userName, Boolean value)
      Sets a user specific value for BaseGenericObjectPool.getLifo() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserMaxIdle

      void setPerUserMaxIdle(Map<String,Integer> newMap)

    • setPerUserMaxIdle

      public void setPerUserMaxIdle(String userName, Integer value)
      Sets a user specific value for GenericObjectPool.getMaxIdle() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserMaxTotal

      void setPerUserMaxTotal(Map<String,Integer> newMap)

    • setPerUserMaxTotal

      public void setPerUserMaxTotal(String userName, Integer value)
      Sets a user specific value for BaseGenericObjectPool.getMaxTotal() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserMaxWait

      public void setPerUserMaxWait(String userName, Duration value)
      Sets a user specific value for BaseGenericObjectPool.getMaxWaitDuration() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.
      Since:
      2.10.0

    • setPerUserMaxWaitDuration

      void setPerUserMaxWaitDuration(Map<String,Duration> newMap)

    • setPerUserMaxWaitMillis

      void setPerUserMaxWaitMillis(Map<String,Long> newMap)

    • setPerUserMaxWaitMillis

      @Deprecated public void setPerUserMaxWaitMillis(String userName, Long value)
      Deprecated.
      Use setPerUserMaxWait(String, Duration).
      Sets a user specific value for BaseGenericObjectPool.getMaxWaitDuration() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserMinEvictableIdle

      void setPerUserMinEvictableIdle(Map<String,Duration> newMap)

    • setPerUserMinEvictableIdle

      public void setPerUserMinEvictableIdle(String userName, Duration value)
      Sets a user specific value for BaseGenericObjectPool.getMinEvictableIdleDuration() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.
      Since:
      2.10.0

    • setPerUserMinEvictableIdleTimeMillis

      @Deprecated public void setPerUserMinEvictableIdleTimeMillis(String userName, Long value)
      Deprecated.
      Use setPerUserMinEvictableIdle(String, Duration).
      Sets a user specific value for BaseGenericObjectPool.getMinEvictableIdleDuration() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserMinIdle

      void setPerUserMinIdle(Map<String,Integer> newMap)

    • setPerUserMinIdle

      public void setPerUserMinIdle(String userName, Integer value)
      Sets a user specific value for GenericObjectPool.getMinIdle() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserNumTestsPerEvictionRun

      void setPerUserNumTestsPerEvictionRun(Map<String,Integer> newMap)

    • setPerUserNumTestsPerEvictionRun

      public void setPerUserNumTestsPerEvictionRun(String userName, Integer value)
      Sets a user specific value for BaseGenericObjectPool.getNumTestsPerEvictionRun() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserSoftMinEvictableIdle

      void setPerUserSoftMinEvictableIdle(Map<String,Duration> newMap)

    • setPerUserSoftMinEvictableIdle

      public void setPerUserSoftMinEvictableIdle(String userName, Duration value)
      Sets a user specific value for BaseGenericObjectPool.getSoftMinEvictableIdleDuration() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.
      Since:
      2.10.0

    • setPerUserSoftMinEvictableIdleTimeMillis

      @Deprecated public void setPerUserSoftMinEvictableIdleTimeMillis(String userName, Long value)
      Deprecated.
      Use setPerUserSoftMinEvictableIdle(String, Duration).
      Sets a user specific value for BaseGenericObjectPool.getSoftMinEvictableIdleDuration() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserTestOnBorrow

      void setPerUserTestOnBorrow(Map<String,Boolean> newMap)

    • setPerUserTestOnBorrow

      public void setPerUserTestOnBorrow(String userName, Boolean value)
      Sets a user specific value for BaseGenericObjectPool.getTestOnBorrow() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserTestOnCreate

      void setPerUserTestOnCreate(Map<String,Boolean> newMap)

    • setPerUserTestOnCreate

      public void setPerUserTestOnCreate(String userName, Boolean value)
      Sets a user specific value for BaseGenericObjectPool.getTestOnCreate() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserTestOnReturn

      void setPerUserTestOnReturn(Map<String,Boolean> newMap)

    • setPerUserTestOnReturn

      public void setPerUserTestOnReturn(String userName, Boolean value)
      Sets a user specific value for BaseGenericObjectPool.getTestOnReturn() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserTestWhileIdle

      void setPerUserTestWhileIdle(Map<String,Boolean> newMap)

    • setPerUserTestWhileIdle

      public void setPerUserTestWhileIdle(String userName, Boolean value)
      Sets a user specific value for BaseGenericObjectPool.getTestWhileIdle() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setPerUserTimeBetweenEvictionRunsMillis

      @Deprecated public void setPerUserTimeBetweenEvictionRunsMillis(String userName, Long value)
      Deprecated.
      Use setPerUserDurationBetweenEvictionRuns(String, Duration).
      Sets a user specific value for BaseGenericObjectPool.getDurationBetweenEvictionRuns() for the specified user's pool.
      Parameters:
      userName - The user name key.
      value - The user specific value.

    • setupDefaults

      protected void setupDefaults(Connection con, String userName) throws SQLException
      Specified by:
      setupDefaults in class InstanceKeyDataSource
      Throws:
      SQLException

    • toDurationOrNull

      private Duration toDurationOrNull(Long millis)