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, InitConnectionCallback, Serializable, Wrapper, Referenceable, CommonDataSource, DataSource

Direct Known Subclasses:

AtomikosNonPoolingDataSourceBean

public class AtomikosDataSourceBean
extends AbstractDataSourceBean
implements DataSource

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()
int	getEndExistingXaBranchFlags()
boolean	getIgnoreJtaTransactions()
int	getJoinExistingXaBranchFlags()
boolean	getLocalTransactionMode() Tests whether local transactions are allowed - defaults to false for JDBC.
boolean	getPropagateJtaTimeoutToXaResource()
boolean	getRecycleActiveConnectionsInTransaction()
int	getResumeExistingXaBranchFlags()
int	getStartNewXaBranchFlags()
boolean	getSupportsTmJoin()
int	getSuspendExistingXaBranchFlags()
XADataSource	getXaDataSource() Gets the configured XADataSource (if any).
String	getXaDataSourceClassName() Gets the XADataSource class name.
Properties	getXaProperties() Gets the properties used to configure the XADataSource.
Set<String>	getXaPropertyNamesToHide()
protected boolean	isAssignableFromWrappedVendorClass(Class<?> iface)
protected String	printXaProperties()
void	setEndExistingXaBranchFlags(int vendorSpecificFlags) Sets vendor-specific XA flags to use when ending an existing XA branch.
void	setJoinExistingXaBranchFlags(int vendorSpecificFlags) Sets vendor-specific XA flags to use when joining an existing XA branch.
void	setLocalTransactionMode(boolean localTransactionMode) Sets localTransactionMode.
void	setPropagateJtaTimeoutToXaResource(boolean value) Sets whether to propagate JTA transaction timeout preferences to the underlying XAResource.
void	setRecycleActiveConnectionsInTransaction(boolean value) Should active connections be recycled? Optional, defaults to false.
void	setResumeExistingXaBranchFlags(int vendorSpecificFlags) Sets vendor-specific XA flags to use when resuming an existing XA branch.
void	setStartNewXaBranchFlags(int vendorSpecificFlags) Sets vendor-specific XA start flags used for creating a new branch.
void	setSupportsTmJoin(boolean value) Sets the behavior related to XA TMJOIN.
void	setSuspendExistingXaBranchFlags(int vendorSpecificFlags) Sets vendor-specific XA flags to use when suspending an existing XA branch.
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.
void	setXaPropertyNamesToHide(Set<String> xaPropertyNamesToHide) Sets the XA property names whose values should be hidden in the logs.
protected Object	unwrapVendorInstance()

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

assertPoolSizeSettings, close, getBorrowConnectionTimeout, getConcurrentConnectionValidation, getConnection, getConnection, getConnectionValidationInterval, getDefaultIsolationLevel, getFailOnInitIfDatabaseDown, getInitConnectionSql, getLoginTimeout, getLogWriter, getMaintenanceInterval, getMaxIdleTime, getMaxLifetime, getMaxPoolSize, getMinPoolSize, getNetworkTimeout, getParentLogger, getReference, getTestQuery, getUniqueResourceName, getUseDriverBasedConnectionValidation, hasInitConnectionSQL, init, intializeVendorConnection, isWrapperFor, poolAvailableSize, poolTotalSize, refreshPool, setBorrowConnectionTimeout, setConcurrentConnectionValidation, setConnectionValidationInterval, setDefaultIsolationLevel, setFailOnInitIfDatabaseDown, setInitConnectionSql, setLoginTimeout, setLogWriter, setMaintenanceInterval, setMaxIdleTime, setMaxLifetime, setMaxPoolSize, setMinPoolSize, setNetworkTimeout, setPoolSize, setTestQuery, setUniqueResourceName, setUseDriverBasedConnectionValidation, throwAtomikosSQLException, throwAtomikosSQLException, toString, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.DataSource

getConnection, getConnection

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

AtomikosDataSourceBean

public AtomikosDataSourceBean()

Method Detail

printXaProperties

protected String printXaProperties()

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()

Gets 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

getXaPropertyNamesToHide

public Set<String> getXaPropertyNamesToHide()

Returns:

The XA property names whose values should be hidden in the logs.

unwrapVendorInstance

protected Object unwrapVendorInstance()

Specified by:

unwrapVendorInstance in class AbstractDataSourceBean

setXaPropertyNamesToHide

public void setXaPropertyNamesToHide(Set<String> xaPropertyNamesToHide)

Sets the XA property names whose values should be hidden in the logs. Optional, defaults to empty set.

Parameters:

xaPropertyNamesToHide -

getStartNewXaBranchFlags

public int getStartNewXaBranchFlags()

setStartNewXaBranchFlags

public void setStartNewXaBranchFlags(int vendorSpecificFlags)

Sets vendor-specific XA start flags used for creating a new branch. Optional, defaults to XAResource.TMNOFLAGS if not set.

getPropagateJtaTimeoutToXaResource

public boolean getPropagateJtaTimeoutToXaResource()

setPropagateJtaTimeoutToXaResource

public void setPropagateJtaTimeoutToXaResource(boolean value)

Sets whether to propagate JTA transaction timeout preferences to the underlying XAResource. Optional, defaults to true.

Parameters:

value -

getJoinExistingXaBranchFlags

public int getJoinExistingXaBranchFlags()

setJoinExistingXaBranchFlags

public void setJoinExistingXaBranchFlags(int vendorSpecificFlags)

Sets vendor-specific XA flags to use when joining an existing XA branch. Optional, defaults to XAResource.TMJOIN if not set.

getResumeExistingXaBranchFlags

public int getResumeExistingXaBranchFlags()

setResumeExistingXaBranchFlags

public void setResumeExistingXaBranchFlags(int vendorSpecificFlags)

Sets vendor-specific XA flags to use when resuming an existing XA branch. Optional, defaults to XAResource.TMRESUME if not set.

getSuspendExistingXaBranchFlags

public int getSuspendExistingXaBranchFlags()

setSuspendExistingXaBranchFlags

public void setSuspendExistingXaBranchFlags(int vendorSpecificFlags)

Sets vendor-specific XA flags to use when suspending an existing XA branch. Optional, defaults to XAResource.TMSUSPEND if not set.

getEndExistingXaBranchFlags

public int getEndExistingXaBranchFlags()

setEndExistingXaBranchFlags

public void setEndExistingXaBranchFlags(int vendorSpecificFlags)

Sets vendor-specific XA flags to use when ending an existing XA branch. Optional, defaults to XAResource.TMSUCCESS if not set.

getSupportsTmJoin

public boolean getSupportsTmJoin()

Specified by:

getSupportsTmJoin in interface ConnectionPoolProperties

setSupportsTmJoin

public void setSupportsTmJoin(boolean value)

Sets the behavior related to XA TMJOIN. Set this to false if the underlying database does not support the XA TMJOIN flag. Optional, defaults to true.

setRecycleActiveConnectionsInTransaction

public void setRecycleActiveConnectionsInTransaction(boolean value)

Should active connections be recycled? Optional, defaults to false. If set then multiple getConnection() requests in the same transaction will get the same connection from the pool (a.k.a. "recycling"), even if that connection has not been "closed" yet. If not set, then only connections that are previously closed by the application will be eligible for recycling.

getRecycleActiveConnectionsInTransaction

public boolean getRecycleActiveConnectionsInTransaction()

getIgnoreJtaTransactions

public boolean getIgnoreJtaTransactions()

Specified by:

getIgnoreJtaTransactions in interface ConnectionPoolProperties