binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingDOMTransactionChainAdapter.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.mdsal.binding.dom.adapter;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.util.concurrent.FluentFuture;
  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 java.util.function.Function;
  19 import java.util.function.Supplier;
  20 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  21 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.mdsal.binding.api.TransactionChain;
  23 import org.opendaylight.mdsal.binding.api.TransactionChainClosedException;
  24 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  25 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  26 import org.opendaylight.mdsal.common.api.CommitInfo;
  27 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
  29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  30 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  31 import org.opendaylight.mdsal.dom.api.DOMTransactionChainClosedException;
  32 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  33 import org.opendaylight.yangtools.concepts.Delegator;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 final class BindingDOMTransactionChainAdapter implements TransactionChain, Delegator<DOMTransactionChain> {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(BindingDOMTransactionChainAdapter.class);
  40
  41     private final DOMTransactionChain delegate;
  42     private final AdapterContext adapterContext;
  43     private final DelegateChainListener domListener;
  44     private final TransactionChainListener bindingListener;
  45
  46     BindingDOMTransactionChainAdapter(final Function<DOMTransactionChainListener, DOMTransactionChain> chainFactory,
  47             final AdapterContext codec, final TransactionChainListener listener) {
  48         requireNonNull(chainFactory, "DOM Transaction chain factory must not be null");
  49         this.domListener = new DelegateChainListener();
  50         this.bindingListener = listener;
  51         this.delegate = chainFactory.apply(domListener);
  52         this.adapterContext = requireNonNull(codec);
  53     }
  54
  55     @Override
  56     public DOMTransactionChain getDelegate() {
  57         return delegate;
  58     }
  59
  60     @Override
  61     public ReadTransaction newReadOnlyTransaction() {
  62         return new BindingDOMReadTransactionAdapter(adapterContext,
  63             createTransaction(delegate::newReadOnlyTransaction));
  64     }
  65
  66     @Override
  67     public WriteTransaction newWriteOnlyTransaction() {
  68         final DOMDataTreeWriteTransaction delegateTx = createTransaction(delegate::newWriteOnlyTransaction);
  69         return new BindingDOMWriteTransactionAdapter<>(adapterContext, delegateTx) {
  70             @Override
  71             public FluentFuture<? extends CommitInfo> commit() {
  72                 return listenForFailure(this, super.commit());
  73             }
  74         };
  75     }
  76
  77     @Override
  78     public ReadWriteTransaction newReadWriteTransaction() {
  79         final DOMDataTreeReadWriteTransaction delegateTx = createTransaction(delegate::newReadWriteTransaction);
  80         return new BindingDOMReadWriteTransactionAdapter(adapterContext, delegateTx) {
  81             @Override
  82             public FluentFuture<? extends CommitInfo> commit() {
  83                 return listenForFailure(this, super.commit());
  84             }
  85         };
  86     }
  87
  88     private <T, F extends ListenableFuture<T>> F listenForFailure(final WriteTransaction tx, final F future) {
  89         Futures.addCallback(future, new FutureCallback<T>() {
  90             @Override
  91             public void onFailure(final Throwable throwable) {
  92                 failTransactionChain(tx, throwable);
  93             }
  94
  95             @Override
  96             public void onSuccess(final T result) {
  97                 // Intentionally NOOP
  98             }
  99         }, MoreExecutors.directExecutor());
 100
 101         return future;
 102     }
 103
 104     private void failTransactionChain(final WriteTransaction tx, final Throwable throwable) {
 105         /*
 106          *  We asume correct state change for underlaying transaction
 107          *
 108          * chain, so we are not changing any of our internal state
 109          * to mark that we failed.
 110          */
 111         this.bindingListener.onTransactionChainFailed(this, tx, throwable);
 112     }
 113
 114     @Override
 115     public void close() {
 116         delegate.close();
 117     }
 118
 119     private static <T> T createTransaction(final Supplier<T> supplier) {
 120         try {
 121             return supplier.get();
 122         } catch (DOMTransactionChainClosedException e) {
 123             throw new TransactionChainClosedException("Transaction chain already closed", e);
 124         }
 125     }
 126
 127     private final class DelegateChainListener implements DOMTransactionChainListener {
 128         @Override
 129         public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
 130                 final Throwable cause) {
 131             checkState(delegate.equals(chain), "Listener for %s was invoked for incorrect chain %s.", delegate, chain);
 132             /*
 133              * Intentionally NOOP, callback for failure, since we
 134              * are also listening on each transaction future for failure,
 135              * in order to have reference to Binding Transaction (which was seen by client
 136              * of this transaction chain), instead of DOM transaction
 137              * which is known only to this chain, binding transaction implementation
 138              * and underlying transaction chain.
 139              */
 140             LOG.debug("Transaction chain {} failed. Failed DOM Transaction {}",this,transaction,cause);
 141         }
 142
 143         @Override
 144         public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
 145             checkState(delegate.equals(chain), "Listener for %s was invoked for incorrect chain %s.", delegate, chain);
 146             bindingListener.onTransactionChainSuccessful(BindingDOMTransactionChainAdapter.this);
 147         }
 148     }
 149 }