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 static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.FluentFuture;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  18 import java.util.Collection;
  19 import java.util.Map;
  20 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  21 import java.util.concurrent.atomic.AtomicLong;
  22 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
  23 import org.opendaylight.mdsal.common.api.CommitInfo;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  26 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  27 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  28 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  29 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 /**
  34  * NormalizedNode implementation of {@link org.opendaylight.mdsal.common.api.TransactionChain} which is backed
  35  * by several {@link DOMStoreTransactionChain} differentiated by provided
  36  * {@link org.opendaylight.mdsal.common.api.LogicalDatastoreType} type.
  37  *
  38  */
  39 final class DOMDataBrokerTransactionChainImpl extends AbstractDOMForwardedTransactionFactory<DOMStoreTransactionChain>
  40         implements DOMTransactionChain {
  41     private enum State {
  42         RUNNING,
  43         CLOSING,
  44         CLOSED,
  45         FAILED,
  46     }
  47
  48     private static final AtomicIntegerFieldUpdater<DOMDataBrokerTransactionChainImpl> COUNTER_UPDATER =
  49             AtomicIntegerFieldUpdater.newUpdater(DOMDataBrokerTransactionChainImpl.class, "counter");
  50     private static final AtomicReferenceFieldUpdater<DOMDataBrokerTransactionChainImpl, State> STATE_UPDATER =
  51             AtomicReferenceFieldUpdater.newUpdater(DOMDataBrokerTransactionChainImpl.class, State.class, "state");
  52     private static final Logger LOG = LoggerFactory.getLogger(DOMDataBrokerTransactionChainImpl.class);
  53     private final AtomicLong txNum = new AtomicLong();
  54     private final AbstractDOMDataBroker broker;
  55     private final DOMTransactionChainListener listener;
  56     private final long chainId;
  57
  58     private volatile State state = State.RUNNING;
  59     private volatile int counter = 0;
  60
  61     /**
  62      *Constructor with args.
  63      *
  64      * @param chainId
  65      *            ID of transaction chain
  66      * @param chains
  67      *            Backing {@link DOMStoreTransactionChain}s.
  68      * @param coordinator
  69      *            Commit Coordinator which should be used to coordinate commits
  70      *            of transaction
  71      *            produced by this chain.
  72      * @param listener
  73      *            Listener, which listens on transaction chain events.
  74      * @throws NullPointerException
  75      *             If any of arguments is null.
  76      */
  77     DOMDataBrokerTransactionChainImpl(final long chainId,
  78             final Map<LogicalDatastoreType, DOMStoreTransactionChain> chains,
  79             final AbstractDOMDataBroker broker, final DOMTransactionChainListener listener) {
  80         super(chains);
  81         this.chainId = chainId;
  82         this.broker = requireNonNull(broker);
  83         this.listener = requireNonNull(listener);
  84     }
  85
  86     private void checkNotFailed() {
  87         Preconditions.checkState(state != State.FAILED, "Transaction chain has failed");
  88     }
  89
  90     @Override
  91     protected Object newTransactionIdentifier() {
  92         return "DOM-CHAIN-" + chainId + "-" + txNum.getAndIncrement();
  93     }
  94
  95     @Override
  96     protected FluentFuture<? extends CommitInfo> commit(final DOMDataTreeWriteTransaction transaction,
  97             final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
  98         checkNotFailed();
  99         checkNotClosed();
 100
 101         final FluentFuture<? extends CommitInfo> ret = broker.commit(transaction, cohorts);
 102
 103         COUNTER_UPDATER.incrementAndGet(this);
 104         ret.addCallback(new FutureCallback<CommitInfo>() {
 105             @Override
 106             public void onSuccess(final CommitInfo result) {
 107                 transactionCompleted();
 108             }
 109
 110             @Override
 111             public void onFailure(final Throwable throwable) {
 112                 transactionFailed(transaction, throwable);
 113             }
 114         }, MoreExecutors.directExecutor());
 115
 116         return ret;
 117     }
 118
 119     @Override
 120     public void close() {
 121         final boolean success = STATE_UPDATER.compareAndSet(this, State.RUNNING, State.CLOSING);
 122         if (!success) {
 123             LOG.debug("Chain {} is no longer running", this);
 124             return;
 125         }
 126
 127         super.close();
 128         for (DOMStoreTransactionChain subChain : getTxFactories().values()) {
 129             subChain.close();
 130         }
 131
 132         if (counter == 0) {
 133             finishClose();
 134         }
 135     }
 136
 137     private void finishClose() {
 138         state = State.CLOSED;
 139         listener.onTransactionChainSuccessful(this);
 140     }
 141
 142     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 143             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 144     private void transactionCompleted() {
 145         if (COUNTER_UPDATER.decrementAndGet(this) == 0 && state == State.CLOSING) {
 146             finishClose();
 147         }
 148     }
 149
 150     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 151             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 152     private void transactionFailed(final DOMDataTreeWriteTransaction tx, final Throwable cause) {
 153         state = State.FAILED;
 154         LOG.debug("Transaction chain {} failed.", this, cause);
 155         listener.onTransactionChainFailed(this, tx, cause);
 156     }
 157 }