Package org.datanucleus.store.rdbms.datasource.dbcp2.cpdsadapter

Class DriverAdapterCPDS

  • All Implemented Interfaces:
    Serializable, Referenceable, ObjectFactory, CommonDataSource, ConnectionPoolDataSource
    public class DriverAdapterCPDS
extends Object
implements ConnectionPoolDataSource, Referenceable, Serializable, ObjectFactory

    An adapter for JDBC drivers that do not include an implementation of ConnectionPoolDataSource, but still include a DriverManager implementation. ConnectionPoolDataSources are not used within general applications. They are used by DataSource implementations that pool Connections, such as SharedPoolDataSource. A J2EE container will normally provide some method of initializing the ConnectionPoolDataSource whose attributes are presented as bean getters/setters and then deploying it via JNDI. It is then available as a source of physical connections to the database, when the pooling DataSource needs to create a new physical connection.

    Although normally used within a JNDI environment, the DriverAdapterCPDS can be instantiated and initialized as any bean and then attached directly to a pooling DataSource. Jdbc2PoolDataSource can use the ConnectionPoolDataSource with or without the use of JNDI.

    The DriverAdapterCPDS also provides PreparedStatement pooling which is not generally available in jdbc2 ConnectionPoolDataSource implementation, but is addressed within the jdbc3 specification. The PreparedStatement pool in DriverAdapterCPDS has been in the dbcp package for some time, but it has not undergone extensive testing in the configuration used here. It should be considered experimental and can be toggled with the poolPreparedStatements attribute.

    The package documentation contains an example using catalina and JNDI. The datasources package documentation shows how to use DriverAdapterCPDS as a source for Jdbc2PoolDataSource without the use of JNDI.

    Since:
    2.0
    See Also:
    Serialized Form

    • Constructor Detail

      • DriverAdapterCPDS

        public DriverAdapterCPDS()
        Default no-arg constructor for Serialization

    • Method Detail

      • getConnectionProperties

        public Properties getConnectionProperties()
        Gets the connection properties passed to the JDBC driver.
        Returns:
        the JDBC connection properties used when creating connections.

      • getDescription

        public String getDescription()
        Gets the value of description. This property is here for use by the code which will deploy this datasource. It is not used internally.
        Returns:
        value of description, may be null.
        See Also:
        setDescription(String)

      • getDriver

        public String getDriver()
        Gets the driver class name.
        Returns:
        value of driver.

      • getMaxIdle

        public int getMaxIdle()
        Gets the maximum number of statements that can remain idle in the pool, without extra ones being released, or negative for no limit.
        Returns:
        the value of maxIdle

      • getMaxPreparedStatements

        public int getMaxPreparedStatements()
        Gets the maximum number of prepared statements.
        Returns:
        maxPrepartedStatements value

      • getMinEvictableIdleTimeMillis

        public int getMinEvictableIdleTimeMillis()
        Gets the minimum amount of time a statement may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any).
        Returns:
        the minimum amount of time a statement may sit idle in the pool.
        See Also:
        setMinEvictableIdleTimeMillis(int), setTimeBetweenEvictionRunsMillis(long)

      • getNumTestsPerEvictionRun

        public int getNumTestsPerEvictionRun()
        Gets the number of statements to examine during each run of the idle object evictor thread (if any.)
        Returns:
        the number of statements to examine during each run of the idle object evictor thread (if any.)
        See Also:
        setNumTestsPerEvictionRun(int), setTimeBetweenEvictionRunsMillis(long)

      • getPassword

        public String getPassword()
        Gets the value of password for the default user.
        Returns:
        value of password.

      • getPasswordCharArray

        public char[] getPasswordCharArray()
        Gets the value of password for the default user.
        Returns:
        value of password.
        Since:
        2.4.0

      • getTimeBetweenEvictionRunsMillis

        public long getTimeBetweenEvictionRunsMillis()
        Gets the number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
        Returns:
        the value of the evictor thread timer
        See Also:
        setTimeBetweenEvictionRunsMillis(long)

      • getUrl

        public String getUrl()
        Gets the value of url used to locate the database for this datasource.
        Returns:
        value of url.

      • getUser

        public String getUser()
        Gets the value of default user (login or user name).
        Returns:
        value of user.

      • isAccessToUnderlyingConnectionAllowed

        public boolean isAccessToUnderlyingConnectionAllowed()
        Returns the value of the accessToUnderlyingConnectionAllowed property.
        Returns:
        true if access to the underlying is allowed, false otherwise.

      • isPoolPreparedStatements

        public boolean isPoolPreparedStatements()
        Whether to toggle the pooling of PreparedStatements
        Returns:
        value of poolPreparedStatements.

      • setAccessToUnderlyingConnectionAllowed

        public void setAccessToUnderlyingConnectionAllowed​(boolean allow)
        Sets the value of the accessToUnderlyingConnectionAllowed property. It controls if the PoolGuard allows access to the underlying connection. (Default: false)
        Parameters:
        allow - Access to the underlying connection is granted when true.

      • setDescription

        public void setDescription​(String v)
        Sets the value of description. This property is here for use by the code which will deploy this datasource. It is not used internally.
        Parameters:
        v - Value to assign to description.

      • setMaxIdle

        public void setMaxIdle​(int maxIdle)
        Gets the maximum number of statements that can remain idle in the pool, without extra ones being released, or negative for no limit.
        Parameters:
        maxIdle - The maximum number of statements that can remain idle
        Throws:
        IllegalStateException - if getPooledConnection() has been called

      • setMaxPreparedStatements

        public void setMaxPreparedStatements​(int maxPreparedStatements)
        Sets the maximum number of prepared statements.
        Parameters:
        maxPreparedStatements - the new maximum number of prepared statements

      • setMinEvictableIdleTimeMillis

        public void setMinEvictableIdleTimeMillis​(int minEvictableIdleTimeMillis)
        Sets the minimum amount of time a statement may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any). When non-positive, no objects will be evicted from the pool due to idle time alone.
        Parameters:
        minEvictableIdleTimeMillis - minimum time to set (in ms)
        Throws:
        IllegalStateException - if getPooledConnection() has been called
        See Also:
        getMinEvictableIdleTimeMillis(), setTimeBetweenEvictionRunsMillis(long)

      • setNumTestsPerEvictionRun

        public void setNumTestsPerEvictionRun​(int numTestsPerEvictionRun)
        Sets the number of statements to examine during each run of the idle object evictor thread (if any).

        When a negative value is supplied, ceil({*link #numIdle})/abs({*link #getNumTestsPerEvictionRun}) tests will be run. I.e., when the value is -n, roughly one nth of the idle objects will be tested per run.

        Parameters:
        numTestsPerEvictionRun - number of statements to examine per run
        Throws:
        IllegalStateException - if getPooledConnection() has been called
        See Also:
        getNumTestsPerEvictionRun(), setTimeBetweenEvictionRunsMillis(long)

      • setPassword

        public void setPassword​(char[] userPassword)
        Sets the value of password for the default user.
        Parameters:
        userPassword - Value to assign to password.
        Throws:
        IllegalStateException - if getPooledConnection() has been called

      • setPassword

        public void setPassword​(String userPassword)
        Sets the value of password for the default user.
        Parameters:
        userPassword - Value to assign to password.
        Throws:
        IllegalStateException - if getPooledConnection() has been called

      • setPoolPreparedStatements

        public void setPoolPreparedStatements​(boolean poolPreparedStatements)
        Whether to toggle the pooling of PreparedStatements
        Parameters:
        poolPreparedStatements - true to pool statements.
        Throws:
        IllegalStateException - if getPooledConnection() has been called

      • setTimeBetweenEvictionRunsMillis

        public void setTimeBetweenEvictionRunsMillis​(long timeBetweenEvictionRunsMillis)
        Sets the number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
        Parameters:
        timeBetweenEvictionRunsMillis - The number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
        Throws:
        IllegalStateException - if getPooledConnection() has been called
        See Also:
        getTimeBetweenEvictionRunsMillis()

      • toString

        public String toString()
        Does not print the userName and userPassword field nor the 'user' or 'password' in the connectionProperties.
        Overrides:
        toString in class Object
        Since:
        2.6.0