Class CPDSConnectionFactory

java.lang.Object

org.datanucleus.store.rdbms.datasource.dbcp2.datasources.CPDSConnectionFactory

All Implemented Interfaces:

EventListener, ConnectionEventListener, PooledConnectionManager, PooledObjectFactory<PooledConnectionAndInfo>

class CPDSConnectionFactory
extends Object
implements PooledObjectFactory<PooledConnectionAndInfo>, ConnectionEventListener, PooledConnectionManager

A PooledObjectFactory that creates PoolableConnections.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ConnectionPoolDataSource	cpds
private long	maxConnLifetimeMillis
private static final String	NO_KEY_MESSAGE
private final Map<PooledConnection, PooledConnectionAndInfo>	pcMap	Map of PooledConnectionAndInfo instances
private ObjectPool<PooledConnectionAndInfo>	pool
private final boolean	rollbackAfterValidation
private final String	userName
private char[]	userPassword
private final Set<PooledConnection>	validatingSet	Map of PooledConnections for which close events are ignored.
private final String	validationQuery
private final int	validationQueryTimeoutSeconds

Constructor Summary

Constructors

Constructor	Description
CPDSConnectionFactory(ConnectionPoolDataSource cpds, String validationQuery, int validationQueryTimeoutSeconds, boolean rollbackAfterValidation, String userName, char[] userPassword)	Creates a new PoolableConnectionFactory.
CPDSConnectionFactory(ConnectionPoolDataSource cpds, String validationQuery, int validationQueryTimeoutSeconds, boolean rollbackAfterValidation, String userName, String userPassword)	Creates a new PoolableConnectionFactory.

Method Summary

Modifier and Type	Method	Description
void	activateObject(PooledObject<PooledConnectionAndInfo> p)	Reinitializes an instance to be returned by the pool.
void	closePool(String userName)	Verifies that the user name matches the user whose connections are being managed by this factory and closes the pool if this is the case; otherwise does nothing.
void	connectionClosed(ConnectionEvent event)	This will be called if the Connection returned by the getConnection method came from a PooledConnection, and the user calls the close() method of this connection object.
void	connectionErrorOccurred(ConnectionEvent event)	If a fatal error occurs, close the underlying physical connection so as not to be returned in the future
void	destroyObject(PooledObject<PooledConnectionAndInfo> p)	Closes the PooledConnection and stops listening for events from it.
private void	doDestroyObject(PooledConnectionAndInfo pci)
(package private) char[]	getPasswordCharArray()	(Testing API) Gets the value of password for the default user.
ObjectPool<PooledConnectionAndInfo>	getPool()	Returns the object pool used to pool connections created by this factory.
void	invalidate(PooledConnection pc)	Invalidates the PooledConnection in the pool.
PooledObject<PooledConnectionAndInfo>	makeObject()	Creates an instance that can be served by the pool and wrap it in a PooledObject to be managed by the pool.
void	passivateObject(PooledObject<PooledConnectionAndInfo> p)	Uninitializes an instance to be returned to the idle object pool.
void	setMaxConnLifetimeMillis(long maxConnLifetimeMillis)	Sets the maximum lifetime in milliseconds of a connection after which the connection will always fail activation, passivation and validation.
void	setPassword(char[] userPassword)	Sets the database password used when creating new connections.
void	setPassword(String userPassword)	Sets the database password used when creating new connections.
void	setPool(ObjectPool<PooledConnectionAndInfo> pool)
String	toString()
private void	validateLifetime(PooledObject<PooledConnectionAndInfo> p)
boolean	validateObject(PooledObject<PooledConnectionAndInfo> p)	Ensures that the instance is safe to be returned by the pool.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NO_KEY_MESSAGE

private static final String NO_KEY_MESSAGE

See Also:

• Constant Field Values

cpds

private final ConnectionPoolDataSource cpds

validationQuery

private final String validationQuery

validationQueryTimeoutSeconds

private final int validationQueryTimeoutSeconds

rollbackAfterValidation

private final boolean rollbackAfterValidation

pool

private ObjectPool<PooledConnectionAndInfo> pool

userName

private final String userName

userPassword

private char[] userPassword

maxConnLifetimeMillis

private long maxConnLifetimeMillis

validatingSet

private final Set<PooledConnection> validatingSet

Map of PooledConnections for which close events are ignored. Connections are muted when they are being validated.

pcMap

private final Map<PooledConnection, PooledConnectionAndInfo> pcMap

Map of PooledConnectionAndInfo instances

Constructor Details

CPDSConnectionFactory

public CPDSConnectionFactory(ConnectionPoolDataSource cpds,
 String validationQuery,
 int validationQueryTimeoutSeconds,
 boolean rollbackAfterValidation,
 String userName,
 char[] userPassword)

Creates a new PoolableConnectionFactory.

Parameters:

cpds - the ConnectionPoolDataSource from which to obtain PooledConnection's

validationQuery - a query to use to validate Connections. Should return at least one row. May be null in which case Connection.isValid(int) will be used to validate connections.

validationQueryTimeoutSeconds - Timeout in seconds before validation fails

rollbackAfterValidation - whether a rollback should be issued after validating Connections.

userName - The user name to use to create connections

userPassword - The password to use to create connections

Since:

2.4.0

CPDSConnectionFactory

public CPDSConnectionFactory(ConnectionPoolDataSource cpds,
 String validationQuery,
 int validationQueryTimeoutSeconds,
 boolean rollbackAfterValidation,
 String userName,
 String userPassword)

Creates a new PoolableConnectionFactory.

Parameters:

cpds - the ConnectionPoolDataSource from which to obtain PooledConnection's

validationQuery - a query to use to validate Connections. Should return at least one row. May be null in which case Connection.isValid(int) will be used to validate connections.

validationQueryTimeoutSeconds - Timeout in seconds before validation fails

rollbackAfterValidation - whether a rollback should be issued after validating Connections.

userName - The user name to use to create connections

userPassword - The password to use to create connections

Method Details

getPasswordCharArray

char[] getPasswordCharArray()

(Testing API) Gets the value of password for the default user.

Returns:

value of password.

getPool

public ObjectPool<PooledConnectionAndInfo> getPool()

Returns the object pool used to pool connections created by this factory.

Returns:

ObjectPool managing pooled connections

setPool

public void setPool(ObjectPool<PooledConnectionAndInfo> pool)

Parameters:

pool - the ObjectPool in which to pool those Connections

makeObject

public PooledObject<PooledConnectionAndInfo> makeObject()

Description copied from interface: PooledObjectFactory

Creates an instance that can be served by the pool and wrap it in a PooledObject to be managed by the pool.

Specified by:

makeObject in interface PooledObjectFactory<PooledConnectionAndInfo>

Returns:

a PooledObject wrapping an instance that can be served by the pool

destroyObject

public void destroyObject(PooledObject<PooledConnectionAndInfo> p)
                   throws Exception

Closes the PooledConnection and stops listening for events from it.

Specified by:

destroyObject in interface PooledObjectFactory<PooledConnectionAndInfo>

Parameters:

p - a PooledObject wrapping the instance to be destroyed

Throws:

Exception - should be avoided as it may be swallowed by the pool implementation.

See Also:

• PooledObjectFactory.validateObject(PooledObject)
• ObjectPool.invalidateObject(T)

doDestroyObject

private void doDestroyObject(PooledConnectionAndInfo pci)
                      throws Exception

Throws:

Exception

validateObject

public boolean validateObject(PooledObject<PooledConnectionAndInfo> p)

Description copied from interface: PooledObjectFactory

Ensures that the instance is safe to be returned by the pool.

Specified by:

validateObject in interface PooledObjectFactory<PooledConnectionAndInfo>

Parameters:

p - a PooledObject wrapping the instance to be validated

Returns:

false if obj is not valid and should be dropped from the pool, true otherwise.

passivateObject

public void passivateObject(PooledObject<PooledConnectionAndInfo> p)
                     throws Exception

Description copied from interface: PooledObjectFactory

Uninitializes an instance to be returned to the idle object pool.

Specified by:

passivateObject in interface PooledObjectFactory<PooledConnectionAndInfo>

Parameters:

p - a PooledObject wrapping the instance to be passivated

Throws:

Exception - if there is a problem passivating obj, this exception may be swallowed by the pool.

See Also:

• PooledObjectFactory.destroyObject(PooledObject)

activateObject

public void activateObject(PooledObject<PooledConnectionAndInfo> p)
                    throws Exception

Description copied from interface: PooledObjectFactory

Reinitializes an instance to be returned by the pool.

Specified by:

activateObject in interface PooledObjectFactory<PooledConnectionAndInfo>

Parameters:

p - a PooledObject wrapping the instance to be activated

Throws:

Exception - if there is a problem activating obj, this exception may be swallowed by the pool.

See Also:

• PooledObjectFactory.destroyObject(PooledObject)

connectionClosed

public void connectionClosed(ConnectionEvent event)

This will be called if the Connection returned by the getConnection method came from a PooledConnection, and the user calls the close() method of this connection object. What we need to do here is to release this PooledConnection from our pool...

Specified by:

connectionClosed in interface ConnectionEventListener

connectionErrorOccurred

public void connectionErrorOccurred(ConnectionEvent event)

If a fatal error occurs, close the underlying physical connection so as not to be returned in the future

Specified by:

connectionErrorOccurred in interface ConnectionEventListener

invalidate

public void invalidate(PooledConnection pc)
                throws SQLException

Invalidates the PooledConnection in the pool. The CPDSConnectionFactory closes the connection and pool counters are updated appropriately. Also closes the pool. This ensures that all idle connections are closed and connections that are checked out are closed on return.

Specified by:

invalidate in interface PooledConnectionManager

Parameters:

pc - PooledConnection to be invalidated

Throws:

SQLException - if an SQL error occurs closing the connection

setPassword

public void setPassword(char[] userPassword)

Sets the database password used when creating new connections.

Parameters:

userPassword - new password

setPassword

public void setPassword(String userPassword)

Sets the database password used when creating new connections.

Specified by:

setPassword in interface PooledConnectionManager

Parameters:

userPassword - new password

setMaxConnLifetimeMillis

public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)

Sets the maximum lifetime in milliseconds of a connection after which the connection will always fail activation, passivation and validation.

Parameters:

maxConnLifetimeMillis - A value of zero or less indicates an infinite lifetime. The default value is -1.

closePool

public void closePool(String userName)
               throws SQLException

Verifies that the user name matches the user whose connections are being managed by this factory and closes the pool if this is the case; otherwise does nothing.

Specified by:

closePool in interface PooledConnectionManager

Parameters:

userName - user name

Throws:

SQLException - if an error occurs closing idle connections in the pool

validateLifetime

private void validateLifetime(PooledObject<PooledConnectionAndInfo> p)
                       throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

Since:

2.6.0