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