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