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 com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import org.opendaylight.mdsal.binding.api.BindingTransactionChain;
  17 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  18 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  19 import org.opendaylight.mdsal.common.api.AsyncTransaction;
  20 import org.opendaylight.mdsal.common.api.TransactionChain;
  21 import org.opendaylight.mdsal.common.api.TransactionChainListener;
  22 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  23 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  24 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  25 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  26 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  27 import org.opendaylight.yangtools.concepts.Delegator;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 final class BindingDOMTransactionChainAdapter implements BindingTransactionChain, Delegator<DOMTransactionChain> {
  32
  33     private static final Logger LOG = LoggerFactory.getLogger(BindingDOMTransactionChainAdapter.class);
  34
  35     private final DOMTransactionChain delegate;
  36     private final BindingToNormalizedNodeCodec codec;
  37     private final DelegateChainListener domListener;
  38     private final TransactionChainListener bindingListener;
  39
  40     BindingDOMTransactionChainAdapter(final DOMDataBroker chainFactory,
  41             final BindingToNormalizedNodeCodec codec, final TransactionChainListener listener) {
  42         Preconditions.checkNotNull(chainFactory, "DOM Transaction chain factory must not be null");
  43         this.domListener = new DelegateChainListener();
  44         this.bindingListener = listener;
  45         this.delegate = chainFactory.createTransactionChain(domListener);
  46         this.codec = codec;
  47     }
  48
  49     @Override
  50     public DOMTransactionChain getDelegate() {
  51         return delegate;
  52     }
  53
  54     @Override
  55     public ReadTransaction newReadOnlyTransaction() {
  56         final DOMDataTreeReadTransaction delegateTx = delegate.newReadOnlyTransaction();
  57         return new BindingDOMReadTransactionAdapter(delegateTx, codec);
  58     }
  59
  60     @Override
  61     public WriteTransaction newWriteOnlyTransaction() {
  62         final DOMDataTreeWriteTransaction delegateTx = delegate.newWriteOnlyTransaction();
  63         return new BindingDOMWriteTransactionAdapter<DOMDataTreeWriteTransaction>(delegateTx, codec) {
  64
  65             @Override
  66             public CheckedFuture<Void,TransactionCommitFailedException> submit() {
  67                 return listenForFailure(this,super.submit());
  68             }
  69
  70         };
  71     }
  72
  73     private <T, F extends ListenableFuture<T>> F listenForFailure(final WriteTransaction tx, final F future) {
  74         Futures.addCallback(future, new FutureCallback<T>() {
  75             @Override
  76             public void onFailure(final Throwable throwable) {
  77                 failTransactionChain(tx, throwable);
  78             }
  79
  80             @Override
  81             public void onSuccess(final T result) {
  82                 // Intentionally NOOP
  83             }
  84         }, MoreExecutors.directExecutor());
  85
  86         return future;
  87     }
  88
  89     private void failTransactionChain(final WriteTransaction tx, final Throwable throwable) {
  90         /*
  91          *  We asume correct state change for underlaying transaction
  92          *
  93          * chain, so we are not changing any of our internal state
  94          * to mark that we failed.
  95          */
  96         this.bindingListener.onTransactionChainFailed(this, tx, throwable);
  97     }
  98
  99     @Override
 100     public void close() {
 101         delegate.close();
 102     }
 103
 104     private final class DelegateChainListener implements TransactionChainListener {
 105
 106         @Override
 107         public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 108                 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 109             Preconditions.checkState(delegate.equals(chain),
 110                     "Illegal state - listener for %s was invoked for incorrect chain %s.", delegate, chain);
 111             /*
 112              * Intentionally NOOP, callback for failure, since we
 113              * are also listening on each transaction future for failure,
 114              * in order to have reference to Binding Transaction (which was seen by client
 115              * of this transaction chain), instead of DOM transaction
 116              * which is known only to this chain, binding transaction implementation
 117              * and underlying transaction chain.
 118              *
 119              */
 120             LOG.debug("Transaction chain {} failed. Failed DOM Transaction {}",this,transaction,cause);
 121         }
 122
 123         @Override
 124         public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 125             Preconditions.checkState(delegate.equals(chain),
 126                     "Illegal state - listener for %s was invoked for incorrect chain %s.", delegate, chain);
 127             bindingListener.onTransactionChainSuccessful(BindingDOMTransactionChainAdapter.this);
 128         }
 129     }
 130
 131 }