KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > jcr > xa > XATicket


1 /*
2  * $Id: XATicket.java,v 1.2 2004/07/24 00:16:24 benjmestrallet Exp $
3  *
4  * Copyright 2002-2004 Day Management AG, Switzerland.
5  *
6  * Licensed under the Day RI License, Version 2.0 (the "License"),
7  * as a reference implementation of the following specification:
8  *
9  * Content Repository API for Java Technology, revision 0.12
10  * <http://www.jcp.org/en/jsr/detail?id=170>
11  *
12  * You may not use this file except in compliance with the License.
13  * You may obtain a copy of the License files at
14  *
15  * http://www.day.com/content/en/licenses/day-ri-license-2.0
16  * http://www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an "AS IS" BASIS,
20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  */
24 package javax.jcr.xa;
25
26 import javax.jcr.Ticket;
27 import javax.transaction.xa.XAResource JavaDoc;
28
29 /**
30  * The <code>XATicket</code> interface extends the capability of
31  * <code>Ticket</code> by adding access to a JCR repository's support for
32  * the Java Transaction API (JTA).
33  * <p/>
34  * <b>Level 2 only</b>
35  * <p/>
36  * This support takes the form of a <code>javax.transaction.xa.XAResource</code>
37  * object. The functionality of this object closely resembles that defined by
38  * the standard X/Open XA Resource interface.
39  * <p/>
40  * This interface is used by the transaction manager; an application does not
41  * use it directly.
42  *
43  * @author Stefan Guggisberg
44  */
45 public interface XATicket extends Ticket {
46
47   /**
48    * Retrieves an <code>XAResource</code> object that the transaction manager
49    * will use to manage this <code>XATicket</code> object's participation in
50    * a distributed transaction.
51    *
52    * @return the <code>XAResource</code> object.
53    */
54   public XAResource JavaDoc getXAResource();
55 }
Popular Tags