HeuristicStatusLogReader


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.Map  ;
25  
26  /**
27   * Interface that gives access to the information in a heuristic status 
28   * log file.
29   *
30   * @author <a HREF="mailto:reverbel@ime.usp.br">Francisco Reverbel</a>
31   * @version $Revision: 37459 $
32   */
33  public interface HeuristicStatusLogReader
34  {
35     /**
36      * Gets the name of the underlying heuristic status log file.
37      * 
38      * @return the name of the heuristic status log file.
39      */
40     String   getLogFileName();
41  
42     /**
43      * Recovers information on heuristically completed transactions from 
44      * the heuristic status log file.
45      *
46      * @param heuristicallyCompletedTransactions a <code>Map</code> to which
47      *              this method will one entry per heuristically completed
48      *              transaction. The map keys are <code>Long</code> values 
49      *              containing local transaction ids. The map values are
50      *              <code>LogRecord.HeurData</code> objects with information
51      *              on heuristically completed transactions.
52      */ 
53     void recover(Map   heuristicallyCompletedTransactions);
54  
55     /**
56      * Removes the underlying heuristic status log file.
57      */
58     void finishRecovery();
59  
60  }
61
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags