| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 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 | * A factory for <code>XAConnection</code> objects that is used internally. |
| 32 | * An object that implements the <code>XADataSource</code> interface is |
| 33 | * typically registered with a naming service that uses the |
| 34 | * Java Naming and Directory Interface<sup><font size=-3>TM</font></sup> |
| 35 | * (JNDI). |
| 36 | * |
| 37 | * @since 1.4 |
| 38 | */ |
| 39 | |
| 40 | public interface XADataSource extends CommonDataSource { |
| 41 | |
| 42 | /** |
| 43 | * Attempts to establish a physical database connection that can be |
| 44 | * used in a distributed transaction. |
| 45 | * |
| 46 | * @return an <code>XAConnection</code> object, which represents a |
| 47 | * physical connection to a data source, that can be used in |
| 48 | * a distributed transaction |
| 49 | * @exception SQLException if a database access error occurs |
| 50 | * @exception SQLFeatureNotSupportedException if the JDBC driver does not support |
| 51 | * this method |
| 52 | * @since 1.4 |
| 53 | */ |
| 54 | XAConnection getXAConnection() throws SQLException; |
| 55 | |
| 56 | /** |
| 57 | * Attempts to establish a physical database connection, using the given |
| 58 | * user name and password. The connection that is returned is one that |
| 59 | * can be used in a distributed transaction. |
| 60 | * |
| 61 | * @param user the database user on whose behalf the connection is being made |
| 62 | * @param password the user's password |
| 63 | * @return an <code>XAConnection</code> object, which represents a |
| 64 | * physical connection to a data source, that can be used in |
| 65 | * a distributed transaction |
| 66 | * @exception SQLException if a database access error occurs |
| 67 | * @exception SQLFeatureNotSupportedException if the JDBC driver does not support |
| 68 | * this method |
| 69 | * @since 1.4 |
| 70 | */ |
| 71 | XAConnection getXAConnection(String user, String password) |
| 72 | throws SQLException; |
| 73 | } |