Package org.apache.tomcat.dbcp.dbcp2.managed

Class BasicManagedDataSource

java.lang.Object

org.apache.tomcat.dbcp.dbcp2.BasicDataSource

org.apache.tomcat.dbcp.dbcp2.managed.BasicManagedDataSource

All Implemented Interfaces:

java.lang.AutoCloseable, java.sql.Wrapper, javax.management.MBeanRegistration, javax.sql.CommonDataSource, javax.sql.DataSource, BasicDataSourceMXBean

public class BasicManagedDataSource
extends BasicDataSource

BasicManagedDataSource is an extension of BasicDataSource which creates ManagedConnections. This data source can create either full two-phase-commit XA connections or one-phase-commit local connections. Both types of connections are committed or rolled back as part of the global transaction (a.k.a. XA transaction or JTA Transaction), but only XA connections can be recovered in the case of a system crash.

BasicManagedDataSource adds the TransactionManager and XADataSource properties. The TransactionManager property is required and is used to enlist connections in global transactions. The XADataSource is optional and if set is the class name of the XADataSource class for a two-phase-commit JDBC driver. If the XADataSource property is set, the driverClassName is ignored and a DataSourceXAConnectionFactory is created. Otherwise, a standard DriverConnectionFactory is created and wrapped with a LocalXAConnectionFactory.

Since:

2.0

See Also:

BasicDataSource, ManagedConnection

Constructor Summary

Constructors

Constructor	Description
BasicManagedDataSource()

Method Summary

Modifier and Type	Method	Description
protected ConnectionFactory	createConnectionFactory()	Creates a JDBC connection factory for this datasource.
protected javax.sql.DataSource	createDataSourceInstance()	Creates the actual data source instance.
protected PoolableConnectionFactory	createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory)	Creates the PoolableConnectionFactory and attaches it to the connection pool.
javax.transaction.TransactionManager	getTransactionManager()	Gets the required transaction manager property.
protected TransactionRegistry	getTransactionRegistry()	Gets the transaction registry.
javax.transaction.TransactionSynchronizationRegistry	getTransactionSynchronizationRegistry()	Gets the optional TransactionSynchronizationRegistry.
java.lang.String	getXADataSource()	Gets the optional XADataSource class name.
javax.sql.XADataSource	getXaDataSourceInstance()	Gets the XADataSource instance used by the XAConnectionFactory.
void	setTransactionManager(javax.transaction.TransactionManager transactionManager)	Sets the required transaction manager property.
void	setTransactionSynchronizationRegistry(javax.transaction.TransactionSynchronizationRegistry transactionSynchronizationRegistry)	Sets the optional TransactionSynchronizationRegistry property.
void	setXADataSource(java.lang.String xaDataSource)	Sets the optional XADataSource class name.
void	setXaDataSourceInstance(javax.sql.XADataSource xaDataSourceInstance)	Sets the XADataSource instance used by the XAConnectionFactory.

Methods inherited from class org.apache.tomcat.dbcp.dbcp2.BasicDataSource

addConnectionProperty, close, createConnectionPool, createDataSource, createObjectPool, getAbandonedLogWriter, getAbandonedUsageTracking, getCacheState, getConnection, getConnection, getConnectionInitSqls, getConnectionInitSqlsAsArray, getConnectionPool, getDefaultAutoCommit, getDefaultCatalog, getDefaultQueryTimeout, getDefaultReadOnly, getDefaultSchema, getDefaultTransactionIsolation, getDisconnectionSqlCodes, getDisconnectionSqlCodesAsArray, getDriver, getDriverClassLoader, getDriverClassName, getEnableAutoCommitOnReturn, getEvictionPolicyClassName, getFastFailValidation, getInitialSize, getJmxName, getLifo, getLogAbandoned, getLogExpiredConnections, getLoginTimeout, getLogWriter, getMaxConnLifetimeMillis, getMaxIdle, getMaxOpenPreparedStatements, getMaxTotal, getMaxWaitMillis, getMinEvictableIdleTimeMillis, getMinIdle, getNumActive, getNumIdle, getNumTestsPerEvictionRun, getParentLogger, getPassword, getRegisteredJmxName, getRemoveAbandonedOnBorrow, getRemoveAbandonedOnMaintenance, getRemoveAbandonedTimeout, getRollbackOnReturn, getSoftMinEvictableIdleTimeMillis, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, getUrl, getUsername, getValidationQuery, getValidationQueryTimeout, invalidateConnection, isAccessToUnderlyingConnectionAllowed, isClosed, isPoolPreparedStatements, isWrapperFor, log, postDeregister, postRegister, preDeregister, preRegister, removeConnectionProperty, setAbandonedLogWriter, setAbandonedUsageTracking, setAccessToUnderlyingConnectionAllowed, setCacheState, setConnectionInitSqls, setConnectionProperties, setDefaultAutoCommit, setDefaultCatalog, setDefaultQueryTimeout, setDefaultReadOnly, setDefaultSchema, setDefaultTransactionIsolation, setDisconnectionSqlCodes, setDriver, setDriverClassLoader, setDriverClassName, setEnableAutoCommitOnReturn, setEvictionPolicyClassName, setFastFailValidation, setInitialSize, setJmxName, setLifo, setLogAbandoned, setLogExpiredConnections, setLoginTimeout, setLogWriter, setMaxConnLifetimeMillis, setMaxIdle, setMaxOpenPreparedStatements, setMaxTotal, setMaxWaitMillis, setMinEvictableIdleTimeMillis, setMinIdle, setNumTestsPerEvictionRun, setPassword, setPoolPreparedStatements, setRemoveAbandonedOnBorrow, setRemoveAbandonedOnMaintenance, setRemoveAbandonedTimeout, setRollbackOnReturn, setSoftMinEvictableIdleTimeMillis, setTestOnBorrow, setTestOnCreate, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setUrl, setUsername, setValidationQuery, setValidationQueryTimeout, startPoolMaintenance, unwrap, validateConnectionFactory

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicManagedDataSource

public BasicManagedDataSource()

Method Detail

getXaDataSourceInstance

public javax.sql.XADataSource getXaDataSourceInstance()

Gets the XADataSource instance used by the XAConnectionFactory.

Returns:

the XADataSource

setXaDataSourceInstance

public void setXaDataSourceInstance(javax.sql.XADataSource xaDataSourceInstance)

Sets the XADataSource instance used by the XAConnectionFactory.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:

xaDataSourceInstance - XADataSource instance

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Gets the required transaction manager property.

Returns:

the transaction manager used to enlist connections

getTransactionSynchronizationRegistry

public javax.transaction.TransactionSynchronizationRegistry getTransactionSynchronizationRegistry()

Gets the optional TransactionSynchronizationRegistry.

Returns:

the TSR that can be used to register synchronizations.

Since:

2.6.0

getTransactionRegistry

protected TransactionRegistry getTransactionRegistry()

Gets the transaction registry.

Returns:

the transaction registry associating XAResources with managed connections

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager transactionManager)

Sets the required transaction manager property.

Parameters:

transactionManager - the transaction manager used to enlist connections

setTransactionSynchronizationRegistry

public void setTransactionSynchronizationRegistry(javax.transaction.TransactionSynchronizationRegistry transactionSynchronizationRegistry)

Sets the optional TransactionSynchronizationRegistry property.

Parameters:

transactionSynchronizationRegistry - the TSR used to register synchronizations

Since:

2.6.0

getXADataSource

public java.lang.String getXADataSource()

Gets the optional XADataSource class name.

Returns:

the optional XADataSource class name

setXADataSource

public void setXADataSource(java.lang.String xaDataSource)

Sets the optional XADataSource class name.

Parameters:

xaDataSource - the optional XADataSource class name

createConnectionFactory

protected ConnectionFactory createConnectionFactory()
                                             throws java.sql.SQLException

Description copied from class: BasicDataSource

Creates a JDBC connection factory for this datasource. The JDBC driver is loaded using the following algorithm:

1. If a Driver instance has been specified via BasicDataSource.setDriver(Driver) use it
2. If no Driver instance was specified and BasicDataSource.driverClassName is specified that class is loaded using the ClassLoader of this class or, if BasicDataSource.driverClassLoader is set, BasicDataSource.driverClassName is loaded with the specified ClassLoader.
3. If BasicDataSource.driverClassName is specified and the previous attempt fails, the class is loaded using the context class loader of the current thread.
4. If a driver still isn't loaded one is loaded via the DriverManager using the specified BasicDataSource.url.

This method exists so subclasses can replace the implementation class.

Overrides:

createConnectionFactory in class BasicDataSource

Returns:

A new connection factory.

Throws:

java.sql.SQLException - If the connection factort cannot be created

createDataSourceInstance

protected javax.sql.DataSource createDataSourceInstance()
                                                 throws java.sql.SQLException

Description copied from class: BasicDataSource

Creates the actual data source instance. This method only exists so that subclasses can replace the implementation class.

Overrides:

createDataSourceInstance in class BasicDataSource

Returns:

A new DataSource instance

Throws:

java.sql.SQLException - if unable to create a datasource instance

createPoolableConnectionFactory

protected PoolableConnectionFactory createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory)
                                                             throws java.sql.SQLException

Creates the PoolableConnectionFactory and attaches it to the connection pool.

Overrides:

createPoolableConnectionFactory in class BasicDataSource

Parameters:

driverConnectionFactory - JDBC connection factory created by createConnectionFactory()

Returns:

A new PoolableConnectionFactory configured with the current configuration of this BasicDataSource

Throws:

java.sql.SQLException - if an error occurs creating the PoolableConnectionFactory