1 /*
   2  * Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.sql;
  27 
  28 import java.sql.SQLException;
  29 import java.sql.SQLFeatureNotSupportedException;
  30 
  31 
  32 /**
  33  * A factory for <code>PooledConnection</code>
  34  * objects.  An object that implements this interface will typically be
  35  * registered with a naming service that is based on the
  36  * Java&trade; Naming and Directory Interface
  37  * (JNDI).
  38  *
  39  * @since 1.4
  40  */
  41 
  42 public interface ConnectionPoolDataSource  extends CommonDataSource {
  43 
  44   /**
  45    * Attempts to establish a physical database connection that can
  46    * be used as a pooled connection.
  47    *
  48    * @return  a <code>PooledConnection</code> object that is a physical
  49    *         connection to the database that this
  50    *         <code>ConnectionPoolDataSource</code> object represents
  51    * @exception SQLException if a database access error occurs
  52    * @exception java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
  53    * this method
  54    * @since 1.4
  55    */
  56   PooledConnection getPooledConnection() throws SQLException;
  57 
  58   /**
  59    * Attempts to establish a physical database connection that can
  60    * be used as a pooled connection.
  61    *
  62    * @param user the database user on whose behalf the connection is being made
  63    * @param password the user's password
  64    * @return  a <code>PooledConnection</code> object that is a physical
  65    *         connection to the database that this
  66    *         <code>ConnectionPoolDataSource</code> object represents
  67    * @exception SQLException if a database access error occurs
  68    * @exception java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
  69    * this method
  70    * @since 1.4
  71    */
  72   PooledConnection getPooledConnection(String user, String password)
  73     throws SQLException;
  74 
  75   //------------------------- JDBC 4.3 -----------------------------------
  76 
  77   /**
  78    * Creates a new {@code createPooledConnectionBuilder} instance
  79    * @implSpec
  80    * The default implementation will throw a {@code SQLFeatureNotSupportedException}.
  81    * @return The ConnectionBuilder instance that was created
  82    * @throws SQLException if an error occurs creating the builder
  83    * @throws SQLFeatureNotSupportedException if the driver does not support sharding
  84    * @since 9
  85    * @see createPooledConnectionBuilder
  86    */
  87   default PooledConnectionBuilder createPooledConnectionBuilder() throws SQLException {
  88         throw new SQLFeatureNotSupportedException("createPooledConnectionBuilder not implemented");
  89   };
  90  }