KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > transaction > manager > TransactionLog


1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * 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 org.apache.geronimo.transaction.manager;
19
20 import java.util.Collection JavaDoc;
21 import java.util.List JavaDoc;
22
23 import javax.transaction.xa.Xid JavaDoc;
24
25
26 /**
27  * Interface used to notify a logging subsystem of transaction events.
28  *
29  * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
30  */

31 public interface TransactionLog {
32
33     void begin(Xid JavaDoc xid) throws LogException;
34
35     /**
36      * log prepare for the global xid xid and the list of TransactionBranchInfo branches
37      * @param xid global xid for the transactions
38      * @param branches List of TransactionBranchInfo
39      * @throws LogException
40      */

41     Object JavaDoc prepare(Xid JavaDoc xid, List JavaDoc branches) throws LogException;
42
43     void commit(Xid JavaDoc xid, Object JavaDoc logMark) throws LogException;
44
45     void rollback(Xid JavaDoc xid, Object JavaDoc logMark) throws LogException;
46
47     /**
48      * Recovers the log, returning a map of (top level) xid to List of TransactionBranchInfo for the branches.
49      * Uses the XidFactory to reconstruct the xids.
50      *
51      * @param xidFactory
52      * @return Map of recovered xid to List of TransactionBranchInfo representing the branches.
53      * @throws LogException
54      */

55     Collection JavaDoc recover(XidFactory xidFactory) throws LogException;
56
57     String JavaDoc getXMLStats();
58
59     int getAverageForceTime();
60
61     int getAverageBytesPerForce();
62 }
63
Popular Tags