com.atomikos.jdbc

Class AtomikosDataSourceBean

java.lang.Object

com.atomikos.jdbc.internal.AbstractDataSourceBean

com.atomikos.jdbc.AtomikosDataSourceBean

All Implemented Interfaces:

ConnectionPoolProperties, com.atomikos.icatch.OrderedLifecycleComponent, Serializable, Wrapper, Referenceable, CommonDataSource, DataSource

public class AtomikosDataSourceBean
extends AbstractDataSourceBean

The preferred class for using Atomikos connection pooling. Use an instance of this class if you want to use Atomikos JTA-enabled connection pooling. All you need to do is construct an instance and set the required properties as outlined below. The resulting bean will automatically register with the transaction service (for recovery) and take part in active transactions. All SQL done over connections (gotten from this class) will participate in JTA transactions.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties

DEFAULT_BORROW_CONNECTION_TIMEOUT, DEFAULT_ISOLATION_LEVEL_UNSET, DEFAULT_MAINTENANCE_INTERVAL, DEFAULT_MAX_IDLE_TIME, DEFAULT_MAX_LIFETIME, DEFAULT_POOL_SIZE

Constructor Summary

Constructors

Constructor and Description
AtomikosDataSourceBean()

Method Summary

Modifier and Type	Method and Description
protected void	doClose()
protected ConnectionFactory<Connection>	doInit()
boolean	getIgnoreJtaTransactions()
boolean	getLocalTransactionMode() Tests whether local transactions are allowed - defaults to false for JDBC.
XADataSource	getXaDataSource() Gets the configured XADataSource (if any).
String	getXaDataSourceClassName() Get the XADataSource class name.
Properties	getXaProperties() Gets the properties used to configure the XADataSource.
protected boolean	isAssignableFromWrappedVendorClass(Class<?> iface)
void	setLocalTransactionMode(boolean localTransactionMode) Sets localTransactionMode.
void	setXaDataSource(XADataSource xaDataSource) Sets the XADataSource directly - instead of providing the xaDataSourceClassName and xaProperties.
void	setXaDataSourceClassName(String xaDataSourceClassName) Sets the fully qualified underlying XADataSource class name.
void	setXaProperties(Properties xaProperties) Sets the properties (name,value pairs) used to configure the XADataSource.
protected Object	unwrapVendorInstance()

Methods inherited from class com.atomikos.jdbc.internal.AbstractDataSourceBean

close, getBorrowConnectionTimeout, getConcurrentConnectionValidation, getConnection, getConnection, getDefaultIsolationLevel, getLoginTimeout, getLogWriter, getMaintenanceInterval, getMaxIdleTime, getMaxLifetime, getMaxPoolSize, getMinPoolSize, getParentLogger, getReference, getTestQuery, getUniqueResourceName, init, isWrapperFor, poolAvailableSize, poolTotalSize, refreshPool, setBorrowConnectionTimeout, setConcurrentConnectionValidation, setDefaultIsolationLevel, setLoginTimeout, setLogWriter, setMaintenanceInterval, setMaxIdleTime, setMaxLifetime, setMaxPoolSize, setMinPoolSize, setPoolSize, setTestQuery, setUniqueResourceName, throwAtomikosSQLException, toString, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomikosDataSourceBean

public AtomikosDataSourceBean()

Method Detail

getXaProperties

public Properties getXaProperties()

Gets the properties used to configure the XADataSource.

setXaProperties

public void setXaProperties(Properties xaProperties)

Sets the properties (name,value pairs) used to configure the XADataSource. Required, unless you call setXaDataSource directly.

Parameters:

xaProperties -

getXaDataSourceClassName

public String getXaDataSourceClassName()

Get the XADataSource class name.

setXaDataSourceClassName

public void setXaDataSourceClassName(String xaDataSourceClassName)

Sets the fully qualified underlying XADataSource class name. Required, unless you call setXaDataSource directly.

Parameters:

xaDataSourceClassName -

getXaDataSource

public XADataSource getXaDataSource()

Gets the configured XADataSource (if any).

Returns:

The instance, or null if none.

setXaDataSource

public void setXaDataSource(XADataSource xaDataSource)

Sets the XADataSource directly - instead of providing the xaDataSourceClassName and xaProperties.

Parameters:

xaDataSource -

getLocalTransactionMode

public boolean getLocalTransactionMode()

Description copied from class: AbstractDataSourceBean

Tests whether local transactions are allowed - defaults to false for JDBC. This property is used by the pooling mechanism. If false, then attempting to use a JDBC connection without a JTA transaction for the calling thread will fail.

Specified by:

getLocalTransactionMode in interface ConnectionPoolProperties

Overrides:

getLocalTransactionMode in class AbstractDataSourceBean

setLocalTransactionMode

public void setLocalTransactionMode(boolean localTransactionMode)

Sets localTransactionMode. Optional, defaults to true.

Parameters:

localTransactionMode - If true, then (for historical reasons) this datasource supports "hybrid" behaviour: if a JTA transaction is present then XA will be used, if not then a regular JDBC connection with connection-level commit/rollback will be returned. For safety, this property is best left to false: that way, there is no doubt about the transactional nature of your JDBC work.

doInit

protected ConnectionFactory<Connection> doInit()
                                        throws Exception

Specified by:

doInit in class AbstractDataSourceBean

Throws:

Exception

doClose

protected void doClose()

Specified by:

doClose in class AbstractDataSourceBean

isAssignableFromWrappedVendorClass

protected boolean isAssignableFromWrappedVendorClass(Class<?> iface)

Specified by:

isAssignableFromWrappedVendorClass in class AbstractDataSourceBean

unwrapVendorInstance

protected Object unwrapVendorInstance()

Specified by:

unwrapVendorInstance in class AbstractDataSourceBean

getIgnoreJtaTransactions

public boolean getIgnoreJtaTransactions()