jdk/src/share/classes/javax/sql/XADataSource.java
author lancea
Sat, 19 Jan 2013 10:53:14 -0500
changeset 15278 e081d3f73b75
parent 5506 202f599c92aa
child 18564 f9db68ff2cbb
permissions -rw-r--r--
8005080: JDBC 4.2 Core changes Reviewed-by: naoto
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
2
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
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
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
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
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.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    31
 * A factory for {@code XAConnection} objects that is used internally.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    32
 * An object that implements the {@code XADataSource} interface is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * typically registered with a naming service that uses the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * Java Naming and Directory Interface<sup><font size=-3>TM</font></sup>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * (JNDI).
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    36
 *  <p>
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    37
 * An implementation of {@code XADataSource} must include a public no-arg
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    38
 * constructor.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
public interface XADataSource extends CommonDataSource {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
   * Attempts to establish a physical database connection that can be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
   * used in a distributed transaction.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
   *
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    48
   * @return  an {@code XAConnection} object, which represents a
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
   *          physical connection to a data source, that can be used in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
   *          a distributed transaction
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
   * @exception SQLException if a database access error occurs
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
   * this method
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    54
   * @throws SQLTimeoutException when the driver has determined that the
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    55
   * timeout value specified by the {@code setLoginTimeout} method
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    56
   * has been exceeded and has at least tried to cancel the
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    57
   * current database connection attempt
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
   * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
  XAConnection getXAConnection() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
   * Attempts to establish a physical database connection, using the given
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
   * user name and password. The connection that is returned is one that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
   * can be used in a distributed transaction.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
   * @param user the database user on whose behalf the connection is being made
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
   * @param password the user's password
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    69
   * @return  an {@code XAConnection} object, which represents a
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
   *          physical connection to a data source, that can be used in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
   *          a distributed transaction
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
   * @exception SQLException if a database access error occurs
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
   * this method
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    75
   * @throws SQLTimeoutException when the driver has determined that the
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    76
   * timeout value specified by the {@code setLoginTimeout} method
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    77
   * has been exceeded and has at least tried to cancel the
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 5506
diff changeset
    78
   * current database connection attempt
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
   * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
  XAConnection getXAConnection(String user, String password)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
 }