OpenJDK 27 · javax.sql.XADataSource · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public default XAConnectionBuilder	Returns: The XAConnectionBuilder instance that was created createXAConnectionBuilder() Creates a new `XAConnectionBuilder` instance
public int	getLoginTimeout() Redeclares javax.sql.CommonDataSource.getLoginTimeout. Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
public PrintWriter	getLogWriter() Redeclares javax.sql.CommonDataSource.getLogWriter. Retrieves the log writer for this `DataSource` object.
public XAConnection	Returns: an `XAConnection` object, which represents a physical connection to a data source, that can be used in a distributed transaction getXAConnection() Attempts to establish a physical database connection that can be used in a distributed transaction.
public XAConnection	Returns: an `XAConnection` object, which represents a physical connection to a data source, that can be used in a distributed transaction getXAConnection(String the database user on whose behalf the connection is being made user, String the user's password password) Attempts to establish a physical database connection, using the given user name and password.
public void	setLoginTimeout(int seconds) Redeclares javax.sql.CommonDataSource.setLoginTimeout. Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
public void	setLogWriter(PrintWriter out) Redeclares javax.sql.CommonDataSource.setLogWriter. Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object.

Inherited from javax.sql.CommonDataSource:: createShardingKeyBuilder getParentLogger

Method Detail

createXAConnectionBuilder back to summary

createXAConnectionBuilder	back to summary
public default XAConnectionBuilder createXAConnectionBuilder() throws SQLException Creates a new `XAConnectionBuilder` instance Implementation Specification The default implementation will throw a `SQLFeatureNotSupportedException`. Returns:XAConnectionBuilder The XAConnectionBuilder instance that was created Exceptions SQLException: if an error occurs creating the builder SQLFeatureNotSupportedException: if the driver does not support sharding Since 9 See Also `XAConnectionBuilder`

public default XAConnectionBuilder createXAConnectionBuilder() throws SQLException

Creates a new XAConnectionBuilder instance

Implementation Specification

The default implementation will throw a SQLFeatureNotSupportedException.

Returns:XAConnectionBuilder

The XAConnectionBuilder instance that was created

Exceptions

SQLException:: if an error occurs creating the builder
SQLFeatureNotSupportedException:: if the driver does not support sharding

Since

See Also

XAConnectionBuilder

getLoginTimeout back to summary

getLoginTimeout	back to summary
public int getLoginTimeout() throws SQLException Redeclares javax.sql.CommonDataSource.getLoginTimeout. Doc from javax.sql.CommonDataSource.getLoginTimeout. Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a `DataSource` object is created, the login timeout is initially zero. Annotations @Override Exceptions SQLException: if a database access error occurs. Since 1.4

public int getLoginTimeout() throws SQLException

Redeclares javax.sql.CommonDataSource.getLoginTimeout.

Doc from javax.sql.CommonDataSource.getLoginTimeout.

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs.

Since

1.4

getLogWriter back to summary

getLogWriter	back to summary
public PrintWriter getLogWriter() throws SQLException Redeclares javax.sql.CommonDataSource.getLogWriter. Doc from javax.sql.CommonDataSource.getLogWriter. Retrieves the log writer for this `DataSource` object. The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the `java.sql.DriverManager` class. When a `DataSource` object is created, the log writer is initially null; in other words, the default is for logging to be disabled. Annotations @Override Exceptions SQLException: if a database access error occurs Since 1.4

public PrintWriter getLogWriter() throws SQLException

Redeclares javax.sql.CommonDataSource.getLogWriter.

Doc from javax.sql.CommonDataSource.getLogWriter.

Retrieves the log writer for this DataSource object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

Since

1.4

getXAConnection back to summary

getXAConnection	back to summary
public XAConnection getXAConnection() throws SQLException Attempts to establish a physical database connection that can be used in a distributed transaction. Returns:XAConnection an `XAConnection` object, which represents a physical connection to a data source, that can be used in a distributed transaction Exceptions 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

public XAConnection getXAConnection() throws SQLException

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

Returns:XAConnection

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction

Exceptions

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 back to summary

getXAConnection	back to summary
public 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:String the database user on whose behalf the connection is being made password:String the user's password Returns:XAConnection an `XAConnection` object, which represents a physical connection to a data source, that can be used in a distributed transaction Exceptions 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

public 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:String: the database user on whose behalf the connection is being made
password:String: the user's password

Returns:XAConnection

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction

Exceptions

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

setLoginTimeout back to summary

setLoginTimeout	back to summary
public void setLoginTimeout(int seconds) throws SQLException Redeclares javax.sql.CommonDataSource.setLoginTimeout. Doc from javax.sql.CommonDataSource.setLoginTimeout. Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a `DataSource` object is created, the login timeout is initially zero. Annotations @Override Exceptions SQLException: if a database access error occurs. Since 1.4

public void setLoginTimeout(int seconds) throws SQLException

Redeclares javax.sql.CommonDataSource.setLoginTimeout.

Doc from javax.sql.CommonDataSource.setLoginTimeout.

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs.

Since

1.4

setLogWriter back to summary

setLogWriter	back to summary
public void setLogWriter(PrintWriter out) throws SQLException Redeclares javax.sql.CommonDataSource.setLogWriter. Doc from javax.sql.CommonDataSource.setLogWriter. Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object. The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the `java.sql.DriverManager` class. When a `DataSource` object is created the log writer is initially null; in other words, the default is for logging to be disabled. Annotations @Override Exceptions SQLException: if a database access error occurs Since 1.4

public void setLogWriter(PrintWriter out) throws SQLException

Redeclares javax.sql.CommonDataSource.setLogWriter.

Doc from javax.sql.CommonDataSource.setLogWriter.

Sets the log writer for this DataSource object to the given java.io.PrintWriter object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

Since

1.4

public Interface XADataSource

Method Summary

Method Detail