src/java.sql/share/classes/javax/sql/XAConnection.java
author darcy
Thu, 01 Nov 2018 20:37:45 -0700
changeset 52380 6b31efbf833e
parent 47216 71c04702a3d5
permissions -rw-r--r--
6304578: (reflect) toGenericString fails to print bounds of type variables on generic methods Reviewed-by: vromero, plevart, briangoetz, mcimadamore
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
35277
eb4794f43d20 8146803: Enhance and update Sharding API
lancea
parents: 34338
diff changeset
     2
 * Copyright (c) 2000, 2016, 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
package javax.sql;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.sql.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
/**
34338
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    30
 * An object that provides support for distributed transactions. An
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    31
 * {@code XAConnection} object may be enlisted in a distributed transaction
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    32
 * by means of an {@code XAResource} object. A transaction manager, usually
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    33
 * part of a middle tier server, manages an {@code XAConnection} object
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    34
 * through the {@code XAResource} object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <P>
34338
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    36
 * An application programmer does not use this interface directly; rather, it is
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    37
 * used by a transaction manager working in the middle tier server.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
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
public interface XAConnection extends PooledConnection {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
34338
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    43
    /**
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    44
     * Retrieves an {@code XAResource} object that the transaction manager
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    45
     * will use to manage this {@code XAConnection} object's participation
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    46
     * in a distributed transaction.
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    47
     *
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    48
     * @return the {@code XAResource} object
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    49
     * @exception SQLException if a database access error occurs
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    50
     * @exception SQLFeatureNotSupportedException if the JDBC driver does not
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    51
     * support this method
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    52
     * @since 1.4
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    53
     */
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    54
    javax.transaction.xa.XAResource getXAResource() throws SQLException;
67d0e5867568 8085984: Add JDBC Sharding API
lancea
parents: 25859
diff changeset
    55
}