jdk/src/share/classes/javax/sql/ConnectionPoolDataSource.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 2000-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.sql;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.sql.SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * A factory for <code>PooledConnection</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * objects.  An object that implements this interface will typically be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * registered with a naming service that is based on the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * Java<sup><font size=-2>TM</font></sup> Naming and Directory Interface
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * (JNDI).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
public interface ConnectionPoolDataSource  extends CommonDataSource {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
   * Attempts to establish a physical database connection that can
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
   * be used as a pooled connection.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
   * @return  a <code>PooledConnection</code> object that is a physical
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
   *         connection to the database that this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
   *         <code>ConnectionPoolDataSource</code> object represents
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
   * @exception SQLException if a database access error occurs
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
   * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
  PooledConnection getPooledConnection() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
   * Attempts to establish a physical database connection that can
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
   * be used as a pooled connection.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
   * @param user the database user on whose behalf the connection is being made
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
   * @param password the user's password
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
   * @return  a <code>PooledConnection</code> object that is a physical
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
   *         connection to the database that this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
   *         <code>ConnectionPoolDataSource</code> object represents
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
   * @exception SQLException if a database access error occurs
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
   * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
  PooledConnection getPooledConnection(String user, String password)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
 }