Package org.apache.tomcat.dbcp.dbcp2.datasources

Class 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
    See Also:
    Serialized Form

    • Constructor Detail

      • PerUserPoolDataSource

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

    • Method Detail

      • clear

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

      • getConnectionManager

        protected org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionManager getConnectionManager​(org.apache.tomcat.dbcp.dbcp2.datasources.UserPassKey upKey)
        Specified by:
        getConnectionManager in class InstanceKeyDataSource

      • 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​(java.lang.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​(java.lang.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​(java.lang.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 java.lang.Boolean getPerUserDefaultAutoCommit​(java.lang.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 java.lang.Boolean getPerUserDefaultReadOnly​(java.lang.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 java.lang.Integer getPerUserDefaultTransactionIsolation​(java.lang.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 java.time.Duration getPerUserDurationBetweenEvictionRuns​(java.lang.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 java.lang.String getPerUserEvictionPolicyClassName​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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 java.time.Duration getPerUserMaxWaitDuration​(java.lang.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

      • getPerUserMinEvictableIdleDuration

        public java.time.Duration getPerUserMinEvictableIdleDuration​(java.lang.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

      • getPerUserMinIdle

        public int getPerUserMinIdle​(java.lang.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​(java.lang.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 java.time.Duration getPerUserSoftMinEvictableIdleDuration​(java.lang.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

      • getPerUserTestOnBorrow

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

      • getPooledConnectionAndInfo

        protected org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionAndInfo getPooledConnectionAndInfo​(java.lang.String userName,
                                                                                                      java.lang.String password)
                                                                                               throws java.sql.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:
        java.sql.SQLException - Connection or registration failure.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • setPerUserDurationBetweenEvictionRuns

        public void setPerUserDurationBetweenEvictionRuns​(java.lang.String userName,
                                                  java.time.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

        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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • setPerUserMaxWait

        public void setPerUserMaxWait​(java.lang.String userName,
                              java.time.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

      • setPerUserMinEvictableIdle

        public void setPerUserMinEvictableIdle​(java.lang.String userName,
                                       java.time.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

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • setPerUserSoftMinEvictableIdle

        public void setPerUserSoftMinEvictableIdle​(java.lang.String userName,
                                           java.time.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

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • 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.
        Parameters:
        userName - The user name key.
        value - The user specific value.

      • setupDefaults

        protected void setupDefaults​(java.sql.Connection con,
                             java.lang.String userName)
                      throws java.sql.SQLException
        Specified by:
        setupDefaults in class InstanceKeyDataSource
        Throws:
        java.sql.SQLException