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 java.util.concurrent.atomic.AtomicLong;
  10
  11 import javax.annotation.concurrent.GuardedBy;
  12
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  15 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  18 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  19 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22
  23 import com.google.common.base.Optional;
  24 import com.google.common.base.Preconditions;
  25 import com.google.common.collect.ImmutableMap;
  26 import com.google.common.util.concurrent.CheckedFuture;
  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 public class DOMDataBrokerTransactionChainImpl extends AbstractDOMForwardedTransactionFactory<DOMStoreTransactionChain>
  35         implements DOMTransactionChain, DOMDataCommitErrorListener {
  36
  37     private static final Logger LOG = LoggerFactory.getLogger(DOMDataBrokerTransactionChainImpl.class);
  38     private final DOMDataCommitExecutor coordinator;
  39     private final TransactionChainListener listener;
  40     private final long chainId;
  41     private final AtomicLong txNum = new AtomicLong();
  42     @GuardedBy("this")
  43     private boolean failed = false;
  44
  45     /**
  46      *
  47      * @param chainId
  48      *            ID of transaction chain
  49      * @param chains
  50      *            Backing {@link DOMStoreTransactionChain}s.
  51      * @param coordinator
  52      *            Commit Coordinator which should be used to coordinate commits
  53      *            of transaction
  54      *            produced by this chain.
  55      * @param listener
  56      *            Listener, which listens on transaction chain events.
  57      * @throws NullPointerException
  58      *             If any of arguments is null.
  59      */
  60     public DOMDataBrokerTransactionChainImpl(final long chainId,
  61             final ImmutableMap<LogicalDatastoreType, DOMStoreTransactionChain> chains,
  62             final DOMDataCommitExecutor coordinator, final TransactionChainListener listener) {
  63         super(chains);
  64         this.chainId = chainId;
  65         this.coordinator = Preconditions.checkNotNull(coordinator);
  66         this.listener = Preconditions.checkNotNull(listener);
  67     }
  68
  69     @Override
  70     protected Object newTransactionIdentifier() {
  71         return "DOM-CHAIN-" + chainId + "-" + txNum.getAndIncrement();
  72     }
  73
  74     @Override
  75     public synchronized CheckedFuture<Void,TransactionCommitFailedException> submit(
  76             final DOMDataWriteTransaction transaction, final Iterable<DOMStoreThreePhaseCommitCohort> cohorts) {
  77         return coordinator.submit(transaction, cohorts, Optional.<DOMDataCommitErrorListener> of(this));
  78     }
  79
  80     @Override
  81     public synchronized void close() {
  82         super.close();
  83         for (DOMStoreTransactionChain subChain : getTxFactories().values()) {
  84             subChain.close();
  85         }
  86
  87         if (!failed) {
  88             LOG.debug("Transaction chain {} successfully finished.", this);
  89             listener.onTransactionChainSuccessful(this);
  90         }
  91     }
  92
  93     @Override
  94     public synchronized void onCommitFailed(final DOMDataWriteTransaction tx, final Throwable cause) {
  95         failed = true;
  96         LOG.debug("Transaction chain {} failed.", this, cause);
  97         listener.onTransactionChainFailed(this, tx, cause);
  98     }
  99 }