jdk/src/share/classes/javax/sql/XADataSource.java
changeset 15278 e081d3f73b75
parent 5506 202f599c92aa
child 18564 f9db68ff2cbb
--- a/jdk/src/share/classes/javax/sql/XADataSource.java	Sat Jan 19 10:11:19 2013 -0500
+++ b/jdk/src/share/classes/javax/sql/XADataSource.java	Sat Jan 19 10:53:14 2013 -0500
@@ -28,12 +28,14 @@
 import java.sql.*;
 
 /**
- * A factory for <code>XAConnection</code> objects that is used internally.
- * An object that implements the <code>XADataSource</code> interface is
+ * A factory for {@code XAConnection} objects that is used internally.
+ * An object that implements the {@code XADataSource} interface is
  * typically registered with a naming service that uses the
  * Java Naming and Directory Interface<sup><font size=-3>TM</font></sup>
  * (JNDI).
- *
+ *  <p>
+ * An implementation of {@code XADataSource} must include a public no-arg
+ * constructor.
  * @since 1.4
  */
 
@@ -43,12 +45,16 @@
    * Attempts to establish a physical database connection that can be
    * used in a distributed transaction.
    *
-   * @return  an <code>XAConnection</code> object, which represents a
+   * @return  an {@code XAConnection} object, which represents a
    *          physical connection to a data source, that can be used in
    *          a distributed transaction
    * @exception SQLException if a database access error occurs
    * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
    * this method
+   * @throws SQLTimeoutException when the driver has determined that the
+   * timeout value specified by the {@code setLoginTimeout} method
+   * has been exceeded and has at least tried to cancel the
+   * current database connection attempt
    * @since 1.4
    */
   XAConnection getXAConnection() throws SQLException;
@@ -60,12 +66,16 @@
    *
    * @param user the database user on whose behalf the connection is being made
    * @param password the user's password
-   * @return  an <code>XAConnection</code> object, which represents a
+   * @return  an {@code XAConnection} object, which represents a
    *          physical connection to a data source, that can be used in
    *          a distributed transaction
    * @exception SQLException if a database access error occurs
    * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
    * this method
+   * @throws SQLTimeoutException when the driver has determined that the
+   * timeout value specified by the {@code setLoginTimeout} method
+   * has been exceeded and has at least tried to cancel the
+   * current database connection attempt
    * @since 1.4
    */
   XAConnection getXAConnection(String user, String password)