KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > tm > recovery > TransactionCompletionLogger


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.nio.ByteBuffer JavaDoc;
25
26 /**
27  * This <code>TxCompletionHandler</code> implementation writes
28  * <code>TX_END</code> records to a <code>BatchLog</code>. At transaction
29  * completion, a <code>TX_END</code> record is written out to the
30  * <code>BatchLog</code>.
31  *
32  * @author <a HREF="mailto:reverbel@ime.usp.br">Francisco Reverbel</a>
33  * @version $Revision: 37459 $
34  */
35 class TransactionCompletionLogger implements TxCompletionHandler
36 {
37    /** The underlying <code>BatchLog</code> instance. */
38    private BatchLog log;
39    
40    /**
41     * Constructs a <code>TransactionCompletionLogger</code> that writes
42     * <code>TX_END</code> records to a given <code>BatchLog</code>.
43     *
44     * @param log the <code>BatchLog</code> to which <code>TX_END</code>
45     * records will be written out.
46     */
47    TransactionCompletionLogger(BatchLog log)
48    {
49       this.log = log;
50    }
51
52    /**
53     * Signals the end of the two-phase commit protocol for a committed
54     * transaction. This method should be invoked when the second phase of the
55     * two-phase commit protocol completes successfully and no heuristic
56     * decisions were made. In the case of a heuristically committed transaction,
57     * this method should not be invoked at the end of the second phase of the
58     * two-phase commit protocol. Instead, the <code>handleTxCompletion</code>
59     * call should be postponed until the heuristic outcome is forgotten.
60     *
61     * This implementation writes to the <code>BatchLog</code> a
62     * <code>TX_END</code> record for the transaction.
63     *
64     * @param localTransactionId the local id of the completed transaction.
65     */
66    public void handleTxCompletion(long localTransactionId)
67    {
68       ByteBuffer JavaDoc buffer = LogRecord.createTxEndRecord(localTransactionId);
69       BatchWriter writer = log.getBatchWriter();
70       writer.addBatch(buffer, log);
71    }
72
73 }
74
Popular Tags