Package org.apache.commons.dbcp.managed

Class ManagedDataSource

java.lang.Object

org.apache.commons.dbcp.PoolingDataSource

org.apache.commons.dbcp.managed.ManagedDataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

public class ManagedDataSource
extends PoolingDataSource

The ManagedDataSource is a PoolingDataSource that creates ManagedConnections.

Version:

$Revision$

Author:

Dain Sundstrom

Field Summary

Fields inherited from class org.apache.commons.dbcp.PoolingDataSource

_logWriter, _pool

Constructor Summary

Constructors

Constructor	Description
ManagedDataSource()	Creates an uninitialized datasource.
ManagedDataSource(org.apache.commons.pool.ObjectPool pool, TransactionRegistry transactionRegistry)	Creates a ManagedDataSource which obtains connections from the specified pool and manages them using the specified transaction registry.

Method Summary

Modifier and Type	Method	Description
java.sql.Connection	getConnection()	Return a Connection from my pool, according to the contract specified by ObjectPool.borrowObject().
void	setTransactionRegistry(TransactionRegistry transactionRegistry)	Sets the transaction registry from the XAConnectionFactory used to create the pool.

Methods inherited from class org.apache.commons.dbcp.PoolingDataSource

getConnection, getLoginTimeout, getLogWriter, getParentLogger, isAccessToUnderlyingConnectionAllowed, isWrapperFor, setAccessToUnderlyingConnectionAllowed, setLoginTimeout, setLogWriter, setPool, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Constructor Detail

ManagedDataSource

public ManagedDataSource()

Creates an uninitialized datasource. Before this data source can be used a pool and transaction registry must be set.

ManagedDataSource

public ManagedDataSource(org.apache.commons.pool.ObjectPool pool,
                         TransactionRegistry transactionRegistry)

Creates a ManagedDataSource which obtains connections from the specified pool and manages them using the specified transaction registry. The TransactionRegistry must be the transaction registry obtained from the XAConnectionFactory used to create the connection pool. If not an error will occure when attempting to use the connection in a global transaction because the XAResource object associated with the connection will be unavailable.

Parameters:

pool - the connection pool

transactionRegistry - the transaction registry obtained from the XAConnectionFactory used to create the connection pool object factory

Method Detail

setTransactionRegistry

public void setTransactionRegistry(TransactionRegistry transactionRegistry)

Sets the transaction registry from the XAConnectionFactory used to create the pool. The transaction registry can only be set once using either a connector or this setter method.

Parameters:

transactionRegistry - the transaction registry acquired from the XAConnectionFactory used to create the pool

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Description copied from class: PoolingDataSource

Return a Connection from my pool, according to the contract specified by ObjectPool.borrowObject().

Specified by:

getConnection in interface javax.sql.DataSource

Overrides:

getConnection in class PoolingDataSource

Throws:

java.sql.SQLException