Home | History | Annotate | Download | only in sql
      1 /*
      2  * Copyright (c) 2000, 2006, 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 
     30 
     31 /**
     32  * A factory for <code>PooledConnection</code>
     33  * objects.  An object that implements this interface will typically be
     34  * registered with a naming service that is based on the
     35  * Java<sup><font size=-2>TM</font></sup> Naming and Directory Interface
     36  * (JNDI).
     37  *
     38  * @since 1.4
     39  */
     40 
     41 public interface ConnectionPoolDataSource  extends CommonDataSource {
     42 
     43   /**
     44    * Attempts to establish a physical database connection that can
     45    * be used as a pooled connection.
     46    *
     47    * @return  a <code>PooledConnection</code> object that is a physical
     48    *         connection to the database that this
     49    *         <code>ConnectionPoolDataSource</code> object represents
     50    * @exception SQLException if a database access error occurs
     51    * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
     52    * this method
     53    * @since 1.4
     54    */
     55   PooledConnection getPooledConnection() throws SQLException;
     56 
     57   /**
     58    * Attempts to establish a physical database connection that can
     59    * be used as a pooled connection.
     60    *
     61    * @param user the database user on whose behalf the connection is being made
     62    * @param password the user's password
     63    * @return  a <code>PooledConnection</code> object that is a physical
     64    *         connection to the database that this
     65    *         <code>ConnectionPoolDataSource</code> object represents
     66    * @exception SQLException if a database access error occurs
     67    * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
     68    * this method
     69    * @since 1.4
     70    */
     71   PooledConnection getPooledConnection(String user, String password)
     72     throws SQLException;
     73  }
     74