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