jdk/src/share/classes/javax/sql/DataSource.java
changeset 15278 e081d3f73b75
parent 5506 202f599c92aa
child 18156 edb590d448c5
--- a/jdk/src/share/classes/javax/sql/DataSource.java	Sat Jan 19 10:11:19 2013 -0500
+++ b/jdk/src/share/classes/javax/sql/DataSource.java	Sat Jan 19 10:53:14 2013 -0500
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -31,69 +31,79 @@
 
 /**
  * <p>A factory for connections to the physical data source that this
- * <code>DataSource</code> object represents.  An alternative to the
- * <code>DriverManager</code> facility, a <code>DataSource</code> object
+ * {@code DataSource} object represents.  An alternative to the
+ * {@code DriverManager} facility, a {@code DataSource} object
  * is the preferred means of getting a connection. An object that implements
- * the <code>DataSource</code> interface will typically be
+ * the {@code DataSource} interface will typically be
  * registered with a naming service based on the
  * Java<sup><font size=-2>TM</font></sup> Naming and Directory (JNDI) API.
  * <P>
- * The <code>DataSource</code> interface is implemented by a driver vendor.
+ * The {@code DataSource} interface is implemented by a driver vendor.
  * There are three types of implementations:
  * <OL>
- *   <LI>Basic implementation -- produces a standard <code>Connection</code>
+ *   <LI>Basic implementation -- produces a standard {@code Connection}
  *       object
- *   <LI>Connection pooling implementation -- produces a <code>Connection</code>
+ *   <LI>Connection pooling implementation -- produces a {@code Connection}
  *       object that will automatically participate in connection pooling.  This
  *       implementation works with a middle-tier connection pooling manager.
  *   <LI>Distributed transaction implementation -- produces a
- *       <code>Connection</code> object that may be used for distributed
+ *       {@code Connection} object that may be used for distributed
  *       transactions and almost always participates in connection pooling.
  *       This implementation works with a middle-tier
  *       transaction manager and almost always with a connection
  *       pooling manager.
  * </OL>
  * <P>
- * A <code>DataSource</code> object has properties that can be modified
+ * A {@code DataSource} object has properties that can be modified
  * when necessary.  For example, if the data source is moved to a different
  * server, the property for the server can be changed.  The benefit is that
  * because the data source's properties can be changed, any code accessing
  * that data source does not need to be changed.
  * <P>
- * A driver that is accessed via a <code>DataSource</code> object does not
- * register itself with the <code>DriverManager</code>.  Rather, a
- * <code>DataSource</code> object is retrieved though a lookup operation
- * and then used to create a <code>Connection</code> object.  With a basic
- * implementation, the connection obtained through a <code>DataSource</code>
+ * A driver that is accessed via a {@code DataSource} object does not
+ * register itself with the {@code DriverManager}.  Rather, a
+ * {@code DataSource} object is retrieved though a lookup operation
+ * and then used to create a {@code Connection} object.  With a basic
+ * implementation, the connection obtained through a {@code DataSource}
  * object is identical to a connection obtained through the
- * <code>DriverManager</code> facility.
+ * {@code DriverManager} facility.
+ * <p>
+ * An implementation of {@code DataSource} must include a public no-arg
+ * constructor.
  *
  * @since 1.4
  */
 
-public interface DataSource  extends CommonDataSource,Wrapper {
+public interface DataSource  extends CommonDataSource, Wrapper {
 
   /**
    * <p>Attempts to establish a connection with the data source that
-   * this <code>DataSource</code> object represents.
+   * this {@code DataSource} object represents.
    *
    * @return  a connection to the data source
    * @exception SQLException if a database access error occurs
+   * @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
    */
   Connection getConnection() throws SQLException;
 
   /**
    * <p>Attempts to establish a connection with the data source that
-   * this <code>DataSource</code> object represents.
+   * this {@code DataSource} object represents.
    *
    * @param username the database user on whose behalf the connection is
    *  being made
    * @param password the user's password
    * @return  a connection to the data source
    * @exception SQLException if a database access error occurs
+   * @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
    */
   Connection getConnection(String username, String password)
     throws SQLException;
-
 }