View Javadoc

    1   /***
    2    *
    3    * Copyright 2004 Hiram Chirino
    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.codehaus.activemq.service;
    19
    20  import org.codehaus.activemq.broker.BrokerClient;
    21  import org.codehaus.activemq.message.ActiveMQXid;
    22
    23  import javax.jms.JMSException;
    24  import javax.transaction.xa.XAException;
    25
    26  /***
    27   * A Transaction keeps track of all the tasks
    28   * that must be run before and after transactional events.
    29   *
    30   * @version $Revision: 1.5 $
    31   */
    32  public interface TransactionManager extends Service {
    33
    34      public void setContexTransaction(Transaction tx);
    35
    36      public Transaction getContexTransaction();
    37
    38      public Transaction createLocalTransaction(BrokerClient client, String txid) throws JMSException;
    39
    40      public Transaction getLocalTransaction(String txid) throws JMSException;
    41
    42      public Transaction createXATransaction(BrokerClient client, ActiveMQXid xid) throws XAException;
    43
    44      public Transaction getXATransaction(ActiveMQXid xid) throws XAException;
    45
    46      public ActiveMQXid[] getPreparedXATransactions() throws XAException;
    47
    48      /***
    49       * A hint to the TransactionManager that an BrokerClient has stopped
    50       * This enables the TransactionManager to rollback in progess transactions
    51       * that the client created.
    52       *
    53       * @param client
    54       */
    55      public void cleanUpClient(BrokerClient client) throws JMSException;
    56
    57
    58      /***
    59       * Called on restart when recovering prepared transactions to reload
    60       * a transaction from persistent store
    61       *
    62       * @param xid
    63       * @param transaction
    64       */
    65      public void loadTransaction(ActiveMQXid xid, Transaction transaction) throws XAException;
    66  }