dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMDataBrokerTransactionChainImpl.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.mdsal.dom.broker;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import java.util.Collection;
  16 import java.util.Map;
  17 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  18 import java.util.concurrent.atomic.AtomicLong;
  19 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
  20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  21 import org.opendaylight.mdsal.common.api.TransactionChainListener;
  22 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  23 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  24 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  25 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  26 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * NormalizedNode implementation of {@link org.opendaylight.mdsal.common.api.TransactionChain} which is backed
  32  * by several {@link DOMStoreTransactionChain} differentiated by provided
  33  * {@link org.opendaylight.mdsal.common.api.LogicalDatastoreType} type.
  34  *
  35  */
  36 final class DOMDataBrokerTransactionChainImpl extends AbstractDOMForwardedTransactionFactory<DOMStoreTransactionChain>
  37         implements DOMTransactionChain {
  38     private enum State {
  39         RUNNING,
  40         CLOSING,
  41         CLOSED,
  42         FAILED,
  43     }
  44
  45     private static final AtomicIntegerFieldUpdater<DOMDataBrokerTransactionChainImpl> COUNTER_UPDATER =
  46             AtomicIntegerFieldUpdater.newUpdater(DOMDataBrokerTransactionChainImpl.class, "counter");
  47     private static final AtomicReferenceFieldUpdater<DOMDataBrokerTransactionChainImpl, State> STATE_UPDATER =
  48             AtomicReferenceFieldUpdater.newUpdater(DOMDataBrokerTransactionChainImpl.class, State.class, "state");
  49     private static final Logger LOG = LoggerFactory.getLogger(DOMDataBrokerTransactionChainImpl.class);
  50     private final AtomicLong txNum = new AtomicLong();
  51     private final AbstractDOMDataBroker broker;
  52     private final TransactionChainListener listener;
  53     private final long chainId;
  54
  55     private volatile State state = State.RUNNING;
  56     private volatile int counter = 0;
  57
  58     /**
  59      *Constructor with args.
  60      *
  61      * @param chainId
  62      *            ID of transaction chain
  63      * @param chains
  64      *            Backing {@link DOMStoreTransactionChain}s.
  65      * @param coordinator
  66      *            Commit Coordinator which should be used to coordinate commits
  67      *            of transaction
  68      *            produced by this chain.
  69      * @param listener
  70      *            Listener, which listens on transaction chain events.
  71      * @throws NullPointerException
  72      *             If any of arguments is null.
  73      */
  74     DOMDataBrokerTransactionChainImpl(final long chainId,
  75             final Map<LogicalDatastoreType, DOMStoreTransactionChain> chains,
  76             final AbstractDOMDataBroker broker, final TransactionChainListener listener) {
  77         super(chains);
  78         this.chainId = chainId;
  79         this.broker = Preconditions.checkNotNull(broker);
  80         this.listener = Preconditions.checkNotNull(listener);
  81     }
  82
  83     private void checkNotFailed() {
  84         Preconditions.checkState(state != State.FAILED, "Transaction chain has failed");
  85     }
  86
  87     @Override
  88     protected Object newTransactionIdentifier() {
  89         return "DOM-CHAIN-" + chainId + "-" + txNum.getAndIncrement();
  90     }
  91
  92     @Override
  93     public CheckedFuture<Void, TransactionCommitFailedException> submit(
  94             final DOMDataTreeWriteTransaction transaction, final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
  95         checkNotFailed();
  96         checkNotClosed();
  97
  98         final CheckedFuture<Void, TransactionCommitFailedException> ret = broker.submit(transaction, cohorts);
  99
 100         COUNTER_UPDATER.incrementAndGet(this);
 101         Futures.addCallback(ret, new FutureCallback<Void>() {
 102             @Override
 103             public void onSuccess(final Void result) {
 104                 transactionCompleted();
 105             }
 106
 107             @Override
 108             public void onFailure(final Throwable throwable) {
 109                 transactionFailed(transaction, throwable);
 110             }
 111         });
 112
 113         return ret;
 114     }
 115
 116     @Override
 117     public void close() {
 118         final boolean success = STATE_UPDATER.compareAndSet(this, State.RUNNING, State.CLOSING);
 119         if (!success) {
 120             LOG.debug("Chain {} is no longer running", this);
 121             return;
 122         }
 123
 124         super.close();
 125         for (DOMStoreTransactionChain subChain : getTxFactories().values()) {
 126             subChain.close();
 127         }
 128
 129         if (counter == 0) {
 130             finishClose();
 131         }
 132     }
 133
 134     private void finishClose() {
 135         state = State.CLOSED;
 136         listener.onTransactionChainSuccessful(this);
 137     }
 138
 139     private void transactionCompleted() {
 140         if (COUNTER_UPDATER.decrementAndGet(this) == 0 && state == State.CLOSING) {
 141             finishClose();
 142         }
 143     }
 144
 145     private void transactionFailed(final DOMDataTreeWriteTransaction tx, final Throwable cause) {
 146         state = State.FAILED;
 147         LOG.debug("Transaction chain {} failed.", this, cause);
 148         listener.onTransactionChainFailed(this, tx, cause);
 149     }
 150 }