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