RecoveryLogReader


1   /*
2     * JBoss, Home of Professional Open Source
3     * Copyright 2005, JBoss Inc., and individual contributors as indicated
4     * by the @authors tag. See the copyright.txt in the distribution for a
5     * full listing of individual contributors.
6     *
7     * This is free software; you can redistribute it and/or modify it
8     * under the terms of the GNU Lesser General Public License as
9     * published by the Free Software Foundation; either version 2.1 of
10    * the License, or (at your option) any later version.
11    *
12    * This software is distributed in the hope that it will be useful,
13    * but WITHOUT ANY WARRANTY; without even the implied warranty of
14    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15    * Lesser General Public License for more details.
16    *
17    * You should have received a copy of the GNU Lesser General Public
18    * License along with this software; if not, write to the Free
19    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21    */
22  package org.jboss.tm.recovery;
23  
24  import java.util.List  ;
25  
26  /**
27   * Interface that gives access to the information in a recovery log file.
28   *
29   * @author <a HREF="mailto:bill@jboss.org">Bill Burke</a>
30   * @author <a HREF="mailto:reverbel@ime.usp.br">Francisco Reverbel</a>
31   * @version $Revision: 37459 $
32   */
33  public interface RecoveryLogReader
34  {
35     /**
36      * Gets the name of the underlying log file.
37      * 
38      * @return the name of the log file.
39      */
40     String   getLogFileName();
41  
42     /**
43      * Gets the branch qualifier string read from the log file.
44      * 
45      * @return the branch qualifier read from the log file.
46      */
47     String   getBranchQualifier();
48  
49     /**
50      * Recovers transaction information from the log file. 
51      * 
52      * @param committedSingleTmTransactions a <code>List</code> of 
53      *           <code>LogRecord.Data</code> instances with one element per
54      *           committed single-TM transaction logged to the log file
55      * @param committedMultiTmTransactions a <code>List</code> of 
56      *           <code>LogRecord.Data</code> instances with one element per
57      *           committed  multi-TM transaction that has not yet completed the
58      *           second phase of the 2PC protocol when the server crashed 
59      * @param inDoubtTransactions a <code>List</code> of 
60      *           <code>LogRecord.Data</code> instances with one element per
61      *           foreign transaction that arrived at the server via DTM/OTS
62      *           context propagation and was in the in-doubt state (i.e.,
63      *           replied to prepare with a commit vote but has not yet received
64      *           information on the transaction outcome) when the server crashed
65      * @param inDoubtJcaTransactions a <code>List</code> of 
66      *           <code>LogRecord.Data</code> instances with one element per
67      *           foreign transaction that arrived at the server via JCA 
68      *           transaction inflow and was in the in-doubt state (i.e., replied
69      *           to prepare with a commit vote and was waiting for information 
70      *           on the transaction outcome) when the server crashed.
71      */
72     void recover(List   committedSingleTmTransactions,
73                  List   committedMultiTmTransactions,
74                  List   inDoubtTransactions,
75                  List   inDoubtJcaTransactions);
76  
77     /**
78      * Removes the underlying log file.
79      */
80     void finishRecovery();
81  }
82
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags