binding2/mdsal-binding2-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/adapter/impl/transaction/BindingDOMTransactionChainAdapter.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.javav2.dom.adapter.impl.transaction;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.util.concurrent.FluentFuture;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import java.util.function.Supplier;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.mdsal.binding.javav2.api.ReadTransaction;
  20 import org.opendaylight.mdsal.binding.javav2.api.TransactionChain;
  21 import org.opendaylight.mdsal.binding.javav2.api.TransactionChainClosedException;
  22 import org.opendaylight.mdsal.binding.javav2.api.TransactionChainListener;
  23 import org.opendaylight.mdsal.binding.javav2.api.WriteTransaction;
  24 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingToNormalizedNodeCodec;
  25 import org.opendaylight.mdsal.binding.javav2.spec.base.InstanceIdentifier;
  26 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
  27 import org.opendaylight.mdsal.common.api.AsyncReadWriteTransaction;
  28 import org.opendaylight.mdsal.common.api.CommitInfo;
  29 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  30 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
  31 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  32 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  33 import org.opendaylight.mdsal.dom.api.DOMTransactionChainClosedException;
  34 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  35 import org.opendaylight.yangtools.concepts.Delegator;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Transaction chain adapter.
  41  */
  42 @Beta
  43 public final class BindingDOMTransactionChainAdapter implements TransactionChain, Delegator<DOMTransactionChain> {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(BindingDOMTransactionChainAdapter.class);
  46
  47     private final DOMTransactionChain delegate;
  48     private final BindingToNormalizedNodeCodec codec;
  49     private final TransactionChainListener bindingListener;
  50
  51     public BindingDOMTransactionChainAdapter(final DOMDataBroker chainFactory, final BindingToNormalizedNodeCodec codec,
  52             final TransactionChainListener listener) {
  53         requireNonNull(chainFactory, "DOM Transaction chain factory must not be null");
  54         this.bindingListener = listener;
  55         this.delegate = chainFactory.createTransactionChain(new DelegateChainListener());
  56         this.codec = codec;
  57     }
  58
  59     @Override
  60     public DOMTransactionChain getDelegate() {
  61         return delegate;
  62     }
  63
  64     @Override
  65     public ReadTransaction newReadOnlyTransaction() {
  66         return new BindingDOMReadTransactionAdapter(createTransaction(delegate::newReadOnlyTransaction), codec);
  67     }
  68
  69     @Override
  70     public WriteTransaction newWriteOnlyTransaction() {
  71         final DOMDataTreeWriteTransaction delegateTx = createTransaction(delegate::newWriteOnlyTransaction);
  72         return new BindingDOMWriteTransactionAdapter<DOMDataTreeWriteTransaction>(delegateTx, codec) {
  73
  74             @Override
  75             public @NonNull FluentFuture<? extends @NonNull CommitInfo> commit() {
  76                 return listenForFailure(this, super.commit());
  77             }
  78
  79         };
  80     }
  81
  82     @Override
  83     public AsyncReadWriteTransaction<InstanceIdentifier<?>, TreeNode> newReadWriteTransaction() {
  84         // TODO - placeholder for now
  85         throw new UnsupportedOperationException();
  86     }
  87
  88     private <T, F extends FluentFuture<T>> F listenForFailure(final WriteTransaction tx, final F future) {
  89         future.addCallback(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 assume correct state change for underlying transaction
 107          *
 108          * chain, so we are not changing any of our internal state to mark that we failed.
 109          */
 110         this.bindingListener.onTransactionChainFailed(this, tx, throwable);
 111     }
 112
 113     @Override
 114     public void close() {
 115         delegate.close();
 116     }
 117
 118     private static <T> T createTransaction(final Supplier<T> supplier) {
 119         try {
 120             return supplier.get();
 121         } catch (DOMTransactionChainClosedException e) {
 122             throw new TransactionChainClosedException("Transaction chain already closed", e);
 123         }
 124     }
 125
 126     private final class DelegateChainListener implements DOMTransactionChainListener {
 127         @Override
 128         public void onTransactionChainFailed(final DOMTransactionChain chain,
 129                 final DOMDataTreeTransaction transaction, final Throwable cause) {
 130             checkState(delegate.equals(chain), "Listener for %s was invoked for incorrect chain %s.", delegate, chain);
 131             /*
 132              * Intentionally NOOP, callback for failure, since we are also listening on each transaction
 133              * future for failure, in order to have reference to Binding Transaction (which was seen by client
 134              * of this transaction chain), instead of DOM transaction which is known only to this chain,
 135              * binding transaction implementation and underlying transaction chain.
 136              *
 137              */
 138             LOG.debug("Transaction chain {} failed. Failed DOM Transaction {}", this, transaction, cause);
 139         }
 140
 141         @Override
 142         public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
 143             checkState(delegate.equals(chain), "Listener for %s was invoked for incorrect chain %s.", delegate, chain);
 144             bindingListener.onTransactionChainSuccessful(BindingDOMTransactionChainAdapter.this);
 145         }
 146     }
 147 }