Module io.helidon.integrations.jta.jdbc

Package io.helidon.integrations.jta.jdbc

Class JtaAdaptingDataSource

java.lang.Object

io.helidon.integrations.jdbc.AbstractCommonDataSource

io.helidon.integrations.jdbc.AbstractDataSource

io.helidon.integrations.jta.jdbc.JtaAdaptingDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource

public final class JtaAdaptingDataSource
extends AbstractDataSource

An AbstractDataSource that wraps another DataSource that might not behave correctly in the presence of JTA transaction management, such as one supplied by any of several freely and commercially available connection pools, and that makes such a non-JTA-aware DataSource behave as sensibly as possible in the presence of a JTA-managed transaction.

Constructor Summary

Constructors

Constructor	Description
JtaAdaptingDataSource(TransactionSupplier ts, TransactionSynchronizationRegistry tsr, boolean interposedSynchronizations, ExceptionConverter ec, DataSource ds, boolean immediateEnlistment)	Creates a new JtaAdaptingDataSource that wraps the supplied DataSource and helps its connections participate in XA transactions.
JtaAdaptingDataSource(TransactionSupplier ts, TransactionSynchronizationRegistry tsr, boolean interposedSynchronizations, ExceptionConverter ec, DataSource ds, boolean immediateEnlistment, boolean preemptiveEnlistmentChecks)	Creates a new JtaAdaptingDataSource that wraps the supplied DataSource and helps its connections participate in XA transactions.
JtaAdaptingDataSource(TransactionSupplier ts, TransactionSynchronizationRegistry tsr, boolean interposedSynchronizations, ExceptionConverter ec, XADataSource xads, boolean immediateEnlistment, boolean closeXac)	Deprecated. This constructor exists only to handle certain XA-aware connection pools that allow an end-user caller to "borrow" XAConnections and to "return" them using their close() methods, a non-standard practice which is discouraged by the documentation of PooledConnection (from which XAConnection inherits).
JtaAdaptingDataSource(TransactionSupplier ts, TransactionSynchronizationRegistry tsr, boolean interposedSynchronizations, ExceptionConverter ec, XADataSource xads, boolean immediateEnlistment, boolean preemptiveEnlistmentChecks, boolean closeXac)	Deprecated. This constructor exists only to handle certain XA-aware connection pools that allow an end-user caller to "borrow" XAConnections and to "return" them using their close() methods, a non-standard practice which is discouraged by the documentation of PooledConnection (from which XAConnection inherits).

Method Summary

Modifier and Type	Method	Description
Connection	getConnection()
Connection	getConnection(String username, String password)

Methods inherited from class io.helidon.integrations.jdbc.AbstractDataSource

isWrapperFor, unwrap

Methods inherited from class io.helidon.integrations.jdbc.AbstractCommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

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, getParentLogger

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder, getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Constructor Details

JtaAdaptingDataSource

public JtaAdaptingDataSource(TransactionSupplier ts,
 TransactionSynchronizationRegistry tsr,
 boolean interposedSynchronizations,
 ExceptionConverter ec,
 DataSource ds,
 boolean immediateEnlistment)

Creates a new JtaAdaptingDataSource that wraps the supplied DataSource and helps its connections participate in XA transactions.

Behavior is left deliberately undefined if the supplied DataSource's DataSource.getConnection() or DataSource.getConnection(String, String) methods are implemented to return or augment the return value of an invocation of the XAConnection#getConnection() method. Less formally, and in general, this class is deliberately not designed to work with JDBC constructs that are already XA-aware.

Parameters:

ts - a TransactionSupplier; must not be null

tsr - a TransactionSynchronizationRegistry; must not be null

interposedSynchronizations - whether any Synchronizations registered should be registered as interposed synchronizations; see TransactionSynchronizationRegistry.registerInterposedSynchronization(jakarta.transaction.Synchronization) and Transaction.registerSynchronization(jakarta.transaction.Synchronization)

ec - an ExceptionConverter; may be null in which case a default implementation will be used instead

ds - a DataSource that may not be XA-compliant; must not be null; normally supplied by a connection pool implementation

immediateEnlistment - whether attempts to enlist new Connections in a global transaction should be made immediately upon Connection allocation

Throws:

NullPointerException - if ts, tsr or ds is null

See Also:

• JtaAdaptingDataSource(TransactionSupplier, TransactionSynchronizationRegistry, boolean, ExceptionConverter, DataSource, boolean, boolean)

JtaAdaptingDataSource

public JtaAdaptingDataSource(TransactionSupplier ts,
 TransactionSynchronizationRegistry tsr,
 boolean interposedSynchronizations,
 ExceptionConverter ec,
 DataSource ds,
 boolean immediateEnlistment,
 boolean preemptiveEnlistmentChecks)

Creates a new JtaAdaptingDataSource that wraps the supplied DataSource and helps its connections participate in XA transactions.

Behavior is left deliberately undefined if the supplied DataSource's DataSource.getConnection() or DataSource.getConnection(String, String) methods are implemented to return or augment the return value of an invocation of the XAConnection#getConnection() method. Less formally, and in general, this class is deliberately not designed to work with JDBC constructs that are already XA-aware.

Parameters:

ts - a TransactionSupplier; must not be null

tsr - a TransactionSynchronizationRegistry; must not be null

interposedSynchronizations - whether any Synchronizations registered should be registered as interposed synchronizations; see TransactionSynchronizationRegistry.registerInterposedSynchronization(jakarta.transaction.Synchronization) and Transaction.registerSynchronization(jakarta.transaction.Synchronization)

ec - an ExceptionConverter; may be null in which case a default implementation will be used instead

ds - a DataSource that may not be XA-compliant; must not be null; normally supplied by a connection pool implementation

immediateEnlistment - whether attempts to enlist new Connections in a global transaction should be made immediately upon Connection allocation

preemptiveEnlistmentChecks - whether early checks will be made to see if an enlistment attempt will succeed, or whether enlistment validation will be performed by the JTA implementation

Throws:

NullPointerException - if ts, tsr or ds is null

JtaAdaptingDataSource

@Deprecated(since="3.1.0")
public JtaAdaptingDataSource(TransactionSupplier ts,
 TransactionSynchronizationRegistry tsr,
 boolean interposedSynchronizations,
 ExceptionConverter ec,
 XADataSource xads,
 boolean immediateEnlistment,
 boolean closeXac)

Deprecated.

This constructor exists only to handle certain XA-aware connection pools that allow an end-user caller to "borrow" XAConnections and to "return" them using their close() methods, a non-standard practice which is discouraged by the documentation of PooledConnection (from which XAConnection inherits). For such connection pools, XAConnections that are "borrowed" must be returned in this manner to avoid leaks. This constructor implements this behavior. Before using it, you should make sure that the connection pool in question implementing or supplying the XADataSource has the behavior described above; normally an XAConnection should not be used directly or closed by end-user code.

Creates a new JtaAdaptingDataSource that adapts the supplied XADataSource and helps Connections it indirectly supplies (by way of its associated XAConnection) participate in XA transactions.

Parameters:

ts - a TransactionSupplier; must not be null

tsr - a TransactionSynchronizationRegistry; must not be null

interposedSynchronizations - whether any Synchronizations registered should be registered as interposed synchronizations; see TransactionSynchronizationRegistry.registerInterposedSynchronization(jakarta.transaction.Synchronization) and Transaction.registerSynchronization(jakarta.transaction.Synchronization)

ec - an ExceptionConverter; may be null in which case a default implementation will be used instead

xads - an XADataSource supplied by a connection pool implementation; must not be null

immediateEnlistment - whether attempts to enlist new Connections in a global transaction should be made immediately upon Connection allocation

closeXac - whether or not XAConnections supplied by the supplied XADataSource should be closed when their Connections are closed (in a non-standard fashion)

Throws:

NullPointerException - if ts, tsr or xads is null

JtaAdaptingDataSource

@Deprecated(since="3.1.0")
public JtaAdaptingDataSource(TransactionSupplier ts,
 TransactionSynchronizationRegistry tsr,
 boolean interposedSynchronizations,
 ExceptionConverter ec,
 XADataSource xads,
 boolean immediateEnlistment,
 boolean preemptiveEnlistmentChecks,
 boolean closeXac)

Deprecated.

This constructor exists only to handle certain XA-aware connection pools that allow an end-user caller to "borrow" XAConnections and to "return" them using their close() methods, a non-standard practice which is discouraged by the documentation of PooledConnection (from which XAConnection inherits). For such connection pools, XAConnections that are "borrowed" must be returned in this manner to avoid leaks. This constructor implements this behavior. Before using it, you should make sure that the connection pool in question implementing or supplying the XADataSource has the behavior described above; normally an XAConnection should not be used directly or closed by end-user code.

Creates a new JtaAdaptingDataSource that adapts the supplied XADataSource and helps Connections it indirectly supplies (by way of its associated XAConnection) participate in XA transactions.

Parameters:

ts - a TransactionSupplier; must not be null

tsr - a TransactionSynchronizationRegistry; must not be null

interposedSynchronizations - whether any Synchronizations registered should be registered as interposed synchronizations; see TransactionSynchronizationRegistry.registerInterposedSynchronization(jakarta.transaction.Synchronization) and Transaction.registerSynchronization(jakarta.transaction.Synchronization)

ec - an ExceptionConverter; may be null in which case a default implementation will be used instead

xads - an XADataSource supplied by a connection pool implementation; must not be null

immediateEnlistment - whether attempts to enlist new Connections in a global transaction should be made immediately upon Connection allocation

preemptiveEnlistmentChecks - whether early checks will be made to see if an enlistment attempt will succeed, or whether enlistment validation will be performed by the JTA implementation

closeXac - whether or not XAConnections supplied by the supplied XADataSource should be closed when their Connections are closed (in a non-standard fashion)

Throws:

NullPointerException - if ts, tsr or xads is null

Method Details

getConnection

public Connection getConnection(String username,
 String password)
                         throws SQLException

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws SQLException

Throws:

SQLException