01 /*
02 * Copyright 2000-2006 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.sql;
27
28 import java.sql.*;
29
30 /**
31 * An object that provides support for distributed
32 * transactions. An <code>XAConnection</code> object may be enlisted
33 * in a distributed transaction by means of an <code>XAResource</code> object.
34 * A transaction manager, usually part of a middle tier server, manages an
35 * <code>XAConnection</code> object through the <code>XAResource</code> object.
36 * <P>
37 * An application programmer does not use this interface directly; rather,
38 * it is used by a transaction manager working in the middle tier server.
39 *
40 * @since 1.4
41 */
42
43 public interface XAConnection extends PooledConnection {
44
45 /**
46 * Retrieves an <code>XAResource</code> object that
47 * the transaction manager will use
48 * to manage this <code>XAConnection</code> object's participation in a
49 * distributed transaction.
50 *
51 * @return the <code>XAResource</code> object
52 * @exception SQLException if a database access error occurs
53 * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
54 * this method
55 * @since 1.4
56 */
57 javax.transaction.xa.XAResource getXAResource() throws SQLException;
58
59 }
|