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.Collection;
  14 import java.util.Map;
  15 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  16 import java.util.concurrent.atomic.AtomicLong;
  17 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  20 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  24 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * NormalizedNode implementation of {@link org.opendaylight.controller.md.sal.common.api.data.TransactionChain} which is backed
  30  * by several {@link DOMStoreTransactionChain} differentiated by provided
  31  * {@link org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType} type.
  32  *
  33  */
  34 final class DOMDataBrokerTransactionChainImpl extends AbstractDOMForwardedTransactionFactory<DOMStoreTransactionChain>
  35         implements DOMTransactionChain {
  36     private static enum State {
  37         RUNNING,
  38         CLOSING,
  39         CLOSED,
  40         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      *
  58      * @param chainId
  59      *            ID of transaction chain
  60      * @param chains
  61      *            Backing {@link DOMStoreTransactionChain}s.
  62      * @param coordinator
  63      *            Commit Coordinator which should be used to coordinate commits
  64      *            of transaction
  65      *            produced by this chain.
  66      * @param listener
  67      *            Listener, which listens on transaction chain events.
  68      * @throws NullPointerException
  69      *             If any of arguments is null.
  70      */
  71     public DOMDataBrokerTransactionChainImpl(final long chainId,
  72             final Map<LogicalDatastoreType, DOMStoreTransactionChain> chains,
  73             final AbstractDOMDataBroker broker, final TransactionChainListener listener) {
  74         super(chains);
  75         this.chainId = chainId;
  76         this.broker = Preconditions.checkNotNull(broker);
  77         this.listener = Preconditions.checkNotNull(listener);
  78     }
  79
  80     private void checkNotFailed() {
  81         Preconditions.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 CheckedFuture<Void, TransactionCommitFailedException> submit(
  91             final DOMDataWriteTransaction transaction, final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
  92         checkNotFailed();
  93         checkNotClosed();
  94
  95         final CheckedFuture<Void, TransactionCommitFailedException> ret = broker.submit(transaction, cohorts);
  96
  97         COUNTER_UPDATER.incrementAndGet(this);
  98         Futures.addCallback(ret, new FutureCallback<Void>() {
  99             @Override
 100             public void onSuccess(final Void result) {
 101                 transactionCompleted();
 102             }
 103
 104             @Override
 105             public void onFailure(final Throwable t) {
 106                 transactionFailed(transaction, t);
 107             }
 108         });
 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     private void transactionCompleted() {
 137         if (COUNTER_UPDATER.decrementAndGet(this) == 0 && state == State.CLOSING) {
 138             finishClose();
 139         }
 140     }
 141
 142     private void transactionFailed(final DOMDataWriteTransaction tx, final Throwable cause) {
 143         state = State.FAILED;
 144         LOG.debug("Transaction chain {} failed.", this, cause);
 145         listener.onTransactionChainFailed(this, tx, cause);
 146     }
 147 }