1 /**
2 *
3 * Copyright 2003-2004 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * 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;
21 import java.util.List;
22
23 import javax.transaction.xa.Xid;
24
25
26 /**
27 * Interface used to notify a logging subsystem of transaction events.
28 *
29 * @version $Rev: 355877 $ $Date: 2005-12-10 18:48:27 -0800 (Sat, 10 Dec 2005) $
30 */
31 public interface TransactionLog {
32
33 void begin(Xid 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 prepare(Xid xid, List branches) throws LogException;
42
43 void commit(Xid xid, Object logMark) throws LogException;
44
45 void rollback(Xid xid, Object 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 recover(XidFactory xidFactory) throws LogException;
56
57 String getXMLStats();
58
59 int getAverageForceTime();
60
61 int getAverageBytesPerForce();
62 }