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 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.MoreExecutors;
  15 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  16 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  17 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  18 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  19 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  20 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  21 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  22 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  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.yangtools.concepts.Delegator;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 final class BindingDOMTransactionChainAdapter implements BindingTransactionChain, Delegator<DOMTransactionChain> {
  33
  34     private static final Logger LOG = LoggerFactory.getLogger(BindingDOMTransactionChainAdapter.class);
  35
  36     private final DOMTransactionChain delegate;
  37     private final BindingToNormalizedNodeCodec codec;
  38     private final DelegateChainListener domListener;
  39     private final TransactionChainListener bindingListener;
  40
  41     BindingDOMTransactionChainAdapter(final DOMDataBroker chainFactory,
  42             final BindingToNormalizedNodeCodec codec, final TransactionChainListener listener) {
  43         Preconditions.checkNotNull(chainFactory, "DOM Transaction chain factory must not be null");
  44         this.domListener = new DelegateChainListener();
  45         this.bindingListener = listener;
  46         this.delegate = chainFactory.createTransactionChain(domListener);
  47         this.codec = codec;
  48     }
  49
  50     @Override
  51     public DOMTransactionChain getDelegate() {
  52         return delegate;
  53     }
  54
  55     @Override
  56     public ReadOnlyTransaction newReadOnlyTransaction() {
  57         final DOMDataReadOnlyTransaction delegateTx = delegate.newReadOnlyTransaction();
  58         return new BindingDOMReadTransactionAdapter(delegateTx, codec);
  59     }
  60
  61     @Override
  62     public ReadWriteTransaction newReadWriteTransaction() {
  63         final DOMDataReadWriteTransaction delegateTx = delegate.newReadWriteTransaction();
  64         return new BindingDOMReadWriteTransactionAdapter(delegateTx, codec) {
  65
  66             @Override
  67             public CheckedFuture<Void, TransactionCommitFailedException> submit() {
  68                 return listenForFailure(this,super.submit());
  69             }
  70
  71         };
  72     }
  73
  74     @Override
  75     public WriteTransaction newWriteOnlyTransaction() {
  76         final DOMDataWriteTransaction delegateTx = delegate.newWriteOnlyTransaction();
  77         return new BindingDOMWriteTransactionAdapter<DOMDataWriteTransaction>(delegateTx, codec) {
  78
  79             @Override
  80             public CheckedFuture<Void,TransactionCommitFailedException> submit() {
  81                 return listenForFailure(this,super.submit());
  82             }
  83
  84         };
  85     }
  86
  87     private CheckedFuture<Void, TransactionCommitFailedException> listenForFailure(
  88             final WriteTransaction tx, final CheckedFuture<Void, TransactionCommitFailedException> future) {
  89         Futures.addCallback(future, new FutureCallback<Void>() {
  90             @Override
  91             public void onFailure(final Throwable ex) {
  92                 failTransactionChain(tx,ex);
  93             }
  94
  95             @Override
  96             public void onSuccess(final Void result) {
  97                 // Intentionally NOOP
  98             }
  99         }, MoreExecutors.directExecutor());
 100
 101         return future;
 102     }
 103
 104     private void failTransactionChain(final WriteTransaction tx, final Throwable ex) {
 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, ex);
 112     }
 113
 114     @Override
 115     public void close() {
 116         delegate.close();
 117     }
 118
 119     private final class DelegateChainListener implements TransactionChainListener {
 120
 121         @Override
 122         public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 123                 final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 124             Preconditions.checkState(delegate.equals(chain),
 125                     "Illegal state - listener for %s was invoked for incorrect chain %s.", delegate, 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              */
 135             LOG.debug("Transaction chain {} failed. Failed DOM Transaction {}",this,transaction,cause);
 136         }
 137
 138         @Override
 139         public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 140             Preconditions.checkState(delegate.equals(chain),
 141                     "Illegal state - listener for %s was invoked for incorrect chain %s.", delegate, chain);
 142             bindingListener.onTransactionChainSuccessful(BindingDOMTransactionChainAdapter.this);
 143         }
 144     }
 145
 146 }