CommonDataSource
public interface XADataSource extends CommonDataSource
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.
Modifier and Type | Method | Description |
---|---|---|
default XAConnectionBuilder |
createXAConnectionBuilder() |
Creates a new
XAConnectionBuilder instance |
int |
getLoginTimeout() |
Gets the maximum time in seconds that this data source can wait
while attempting to connect to a database.
|
PrintWriter |
getLogWriter() |
Retrieves the log writer for this
DataSource
object. |
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.
|
void |
setLoginTimeout(int seconds) |
Sets the maximum time in seconds that this data source will wait
while attempting to connect to a database.
|
void |
setLogWriter(PrintWriter out) |
Sets the log writer for this
DataSource
object to the given java.io.PrintWriter object. |
createShardingKeyBuilder, getParentLogger
XAConnection getXAConnection() throws SQLException
XAConnection
object, which represents a
physical connection to a data source, that can be used in
a distributed transactionSQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSQLTimeoutException
- 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 attemptXAConnection getXAConnection(String user, String password) throws SQLException
user
- the database user on whose behalf the connection is being madepassword
- the user's passwordXAConnection
object, which represents a
physical connection to a data source, that can be used in
a distributed transactionSQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSQLTimeoutException
- 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 attemptPrintWriter getLogWriter() throws SQLException
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.
getLogWriter
in interface CommonDataSource
SQLException
- if a database access error occursCommonDataSource.setLogWriter(java.io.PrintWriter)
void setLogWriter(PrintWriter out) throws SQLException
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.
setLogWriter
in interface CommonDataSource
out
- the new log writer; to disable logging, set to nullSQLException
- if a database access error occursCommonDataSource.getLogWriter()
void setLoginTimeout(int seconds) throws SQLException
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.
setLoginTimeout
in interface CommonDataSource
seconds
- the data source login time limitSQLException
- if a database access error occurs.CommonDataSource.getLoginTimeout()
int getLoginTimeout() throws SQLException
DataSource
object is created, the login timeout is
initially zero.getLoginTimeout
in interface CommonDataSource
SQLException
- if a database access error occurs.CommonDataSource.setLoginTimeout(int)
default XAConnectionBuilder createXAConnectionBuilder() throws SQLException
XAConnectionBuilder
instanceSQLFeatureNotSupportedException
.SQLException
- if an error occurs creating the builderSQLFeatureNotSupportedException
- if the driver does not support shardingXAConnectionBuilder
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps