Interface XADataSource

All Superinterfaces:
CommonDataSource

public interface XADataSource
extends CommonDataSource

A factory for XAConnection objects that is used internally. An object that implements the XADataSource interface is typically registered with a naming service that uses the Java Naming and Directory Interface™ (JNDI).

An implementation of XADataSource must include a public no-arg constructor.

Since:
1.4

Methods

Modifier and Type Method and Description
XAConnection getXAConnection()

Attempts to establish a physical database connection that can be used in a distributed transaction.

XAConnection getXAConnection(String user, String password)

Attempts to establish a physical database connection, using the given user name and password.

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Methods

getXAConnection

XAConnection getXAConnection()
                      throws SQLException

Attempts to establish a physical database connection that can be used in a distributed transaction.

Returns:
an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction
Throws:
SQLException - if a database access error occurs
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
SQLTimeoutException - when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt
Since:
1.4

getXAConnection

XAConnection getXAConnection(String user,
                             String password)
                      throws SQLException

Attempts to establish a physical database connection, using the given user name and password. The connection that is returned is one that can be used in a distributed transaction.

Parameters:
user - the database user on whose behalf the connection is being made
password - the user's password
Returns:
an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction
Throws:
SQLException - if a database access error occurs
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
SQLTimeoutException - when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt
Since:
1.4

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/sql/XADataSource.html