KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jotm > TransactionContext


1 /*
2  * @(#) TransactionContext.java
3  *
4  * JOTM: Java Open Transaction Manager
5  *
6  *
7  * This module was originally developed by
8  *
9  * - Bull S.A. as part of the JOnAS application server code released in
10  * July 1999 (www.bull.com)
11  *
12  * --------------------------------------------------------------------------
13  * The original code and portions created by Bull SA are
14  * Copyright (c) 1999 BULL SA
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are met:
19  *
20  * -Redistributions of source code must retain the above copyright notice, this
21  * list of conditions and the following disclaimer.
22  *
23  * -Redistributions in binary form must reproduce the above copyright notice,
24  * this list of conditions and the following disclaimer in the documentation
25  * and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  *
39  * --------------------------------------------------------------------------
40  * $Id: TransactionContext.java,v 1.9 2004/12/13 19:53:06 tonyortiz Exp $
41  * --------------------------------------------------------------------------
42  */

43 package org.objectweb.jotm;
44
45 import java.io.Serializable JavaDoc;
46
47 /**
48  * This is how the JTA Implementation in JOTM sees the Transaction Context.
49  * This interface is used to keep the code independant of the transport layer
50  * this context is for internal use only (JOTM and UserTransaction) it has to
51  * be translated for each protocol.
52  *
53  * For the moment this Transaction Context is Serializable
54  * for test suite
55  *
56  * @author jmesnil
57  * @version $Id: TransactionContext.java,v 1.9 2004/12/13 19:53:06 tonyortiz Exp $
58  */

59 public interface TransactionContext extends Serializable JavaDoc {
60     
61     /**
62      * get transaction timeout.
63      *
64      * @return transaction timeout
65      */

66     public int getTimeout();
67     
68     /**
69      * get the Coordinator of the transaction.
70      *
71      * @return Coordinator
72      */

73     public Coordinator getCoordinator();
74     
75     /**
76      * set the Coordinator of the transaction.
77      *
78      * @param c Coordinator
79      */

80     public void setCoordinator(Coordinator c);
81     
82     /**
83      * get the Terminator of the transaction.
84      *
85      * @return Terminator
86      */

87     public Terminator JavaDoc getTerminator();
88     
89     /**
90      * set the Terminator of the transaction.
91      *
92      * @param t Terminator
93      */

94     public void setTerminator(Terminator JavaDoc t);
95     
96     /**
97      * get the Control of the Transaction.
98      *
99      * @return Control
100      */

101     public Control getControl();
102     
103     /**
104      * get the Xid of the transaction.
105      *
106      * @return Xid
107      */

108     public org.objectweb.jotm.Xid getXid();
109
110     /**
111      * Set a flag in the context to indicate as coming from another Vendor
112      *
113      * @return boolean
114      */

115     public void setNotJotmCtx();
116
117     /**
118      * return true if this context was build from a JOTM's context
119      *
120      * @return boolean
121      */

122     public boolean isJotmCtx();
123     
124 }
125
Popular Tags