1 /*
2 * Copyright 2000-2006 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * 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 /**
32 * An object that provides support for distributed
33 * transactions. An <code>XAConnection</code> object may be enlisted
34 * in a distributed transaction by means of an <code>XAResource</code> object.
35 * A transaction manager, usually part of a middle tier server, manages an
36 * <code>XAConnection</code> object through the <code>XAResource</code> object.
37 * <P>
38 * An application programmer does not use this interface directly; rather,
39 * it is used by a transaction manager working in the middle tier server.
40 *
41 * @since 1.4
42 */
43
44 public interface XAConnection extends PooledConnection {
45
46
47 /**
48 * Retrieves an <code>XAResource</code> object that
49 * the transaction manager will use
50 * to manage this <code>XAConnection</code> object's participation in a
51 * distributed transaction.
52 *
53 * @return the <code>XAResource</code> object
54 * @exception SQLException if a database access error occurs
55 * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
56 * this method
57 * @since 1.4
58 */
59 javax.transaction.xa.XAResource getXAResource() throws SQLException;
60
61 }
Save This Page