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 package org.opendaylight.mdsal.dom.broker;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.FluentFuture;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import com.google.common.util.concurrent.SettableFuture;
  18 import java.util.Map;
  19 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  20 import java.util.concurrent.atomic.AtomicLong;
  21 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
  22 import org.eclipse.jdt.annotation.NonNull;
  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.spi.store.DOMStoreThreePhaseCommitCohort;
  28 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  29 import org.opendaylight.yangtools.yang.common.Empty;
  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
  54     private final @NonNull SettableFuture<Empty> future = SettableFuture.create();
  55     private final AtomicLong txNum = new AtomicLong();
  56     private final AbstractDOMDataBroker broker;
  57     private final long chainId;
  58
  59     private volatile State state = State.RUNNING;
  60     private volatile int counter = 0;
  61
  62     /**
  63      *Constructor with args.
  64      *
  65      * @param chainId
  66      *            ID of transaction chain
  67      * @param chains
  68      *            Backing {@link DOMStoreTransactionChain}s.
  69      * @param coordinator
  70      *            Commit Coordinator which should be used to coordinate commits
  71      *            of transaction
  72      *            produced by this chain.
  73      * @param listener
  74      *            Listener, which listens on transaction chain events.
  75      * @throws NullPointerException
  76      *             If any of arguments is null.
  77      */
  78     DOMDataBrokerTransactionChainImpl(final long chainId,
  79             final Map<LogicalDatastoreType, DOMStoreTransactionChain> chains, final AbstractDOMDataBroker broker) {
  80         super(chains);
  81         this.chainId = chainId;
  82         this.broker = requireNonNull(broker);
  83     }
  84
  85     private void checkNotFailed() {
  86         Preconditions.checkState(state != State.FAILED, "Transaction chain has failed");
  87     }
  88
  89     @Override
  90     public ListenableFuture<Empty> future() {
  91         return future;
  92     }
  93
  94     @Override
  95     protected Object newTransactionIdentifier() {
  96         return "DOM-CHAIN-" + chainId + "-" + txNum.getAndIncrement();
  97     }
  98
  99     @Override
 100     protected FluentFuture<? extends CommitInfo> commit(final DOMDataTreeWriteTransaction transaction,
 101             final DOMStoreThreePhaseCommitCohort cohort) {
 102         checkNotFailed();
 103         checkNotClosed();
 104
 105         final var ret = broker.commit(transaction, cohort);
 106         COUNTER_UPDATER.incrementAndGet(this);
 107
 108         ret.addCallback(new FutureCallback<CommitInfo>() {
 109             @Override
 110             public void onSuccess(final CommitInfo result) {
 111                 transactionCompleted();
 112             }
 113
 114             @Override
 115             public void onFailure(final Throwable throwable) {
 116                 transactionFailed(transaction, throwable);
 117             }
 118         }, MoreExecutors.directExecutor());
 119
 120         return ret;
 121     }
 122
 123     @Override
 124     public void close() {
 125         final boolean success = STATE_UPDATER.compareAndSet(this, State.RUNNING, State.CLOSING);
 126         if (!success) {
 127             LOG.debug("Chain {} is no longer running", this);
 128             return;
 129         }
 130
 131         super.close();
 132         for (DOMStoreTransactionChain subChain : getTxFactories().values()) {
 133             subChain.close();
 134         }
 135
 136         if (counter == 0) {
 137             finishClose();
 138         }
 139     }
 140
 141     private void finishClose() {
 142         state = State.CLOSED;
 143         future.set(Empty.value());
 144     }
 145
 146     private void transactionCompleted() {
 147         if (COUNTER_UPDATER.decrementAndGet(this) == 0 && state == State.CLOSING) {
 148             finishClose();
 149         }
 150     }
 151
 152     private void transactionFailed(final DOMDataTreeWriteTransaction tx, final Throwable cause) {
 153         state = State.FAILED;
 154         LOG.debug("Transaction chain {} failed.", this, cause);
 155         future.setException(cause);
 156     }
 157 }