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 package javax.sql;
  26 
  27 import java.sql.*;
  28 
  29 /**
  30  * An object that provides support for distributed transactions. An
  31  * {@code XAConnection} object may be enlisted in a distributed transaction
  32  * by means of an {@code XAResource} object. A transaction manager, usually
  33  * part of a middle tier server, manages an {@code XAConnection} object
  34  * through the {@code XAResource} object.
  35  * <P>
  36  * An application programmer does not use this interface directly; rather, it is
  37  * used by a transaction manager working in the middle tier server.
  38  *
  39  * @since 1.4
  40  */
  41 public interface XAConnection extends PooledConnection {
  42 
  43     /**
  44      * Retrieves an {@code XAResource} object that the transaction manager
  45      * will use to manage this {@code XAConnection} object's participation
  46      * in a distributed transaction.
  47      *
  48      * @return the {@code XAResource} object
  49      * @exception SQLException if a database access error occurs
  50      * @exception SQLFeatureNotSupportedException if the JDBC driver does not
  51      * support this method
  52      * @since 1.4
  53      */
  54     javax.transaction.xa.XAResource getXAResource() throws SQLException;
  55 }