01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package javax.sql;
19:
20: import java.sql.SQLException;
21: import javax.transaction.xa.XAResource;
22:
23: /**
24: * An interface that is used to support the participation of a database
25: * connection in distributed transactions. An XAConnection returns an XAResource
26: * object which can be used by a Transaction Manager to manage the XAConnection
27: * as part of a distributed transaction.
28: * <p>
29: * It is not intended that this interface is used directly by application code.
30: * It is designed for use by system components which implement distributed
31: * transaction support.
32: */
33: public interface XAConnection extends PooledConnection {
34:
35: /**
36: * Gets an XAResource which a transaction manager can use to manage the
37: * participation of this XAConnection in a distributed transaction.
38: *
39: * @return an XAResource object
40: * @throws SQLException
41: * if an error occurs in accessing the database.
42: */
43: public XAResource getXAResource() throws SQLException;
44: }
|