2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.adapter;
10 import static com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
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 edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
19 import java.util.function.Function;
20 import java.util.function.Supplier;
21 import org.opendaylight.mdsal.binding.api.ReadTransaction;
22 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
23 import org.opendaylight.mdsal.binding.api.TransactionChain;
24 import org.opendaylight.mdsal.binding.api.TransactionChainClosedException;
25 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
26 import org.opendaylight.mdsal.binding.api.WriteTransaction;
27 import org.opendaylight.mdsal.common.api.CommitInfo;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
30 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
31 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
32 import org.opendaylight.mdsal.dom.api.DOMTransactionChainClosedException;
33 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
34 import org.opendaylight.yangtools.concepts.Delegator;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
38 final class BindingDOMTransactionChainAdapter implements TransactionChain, Delegator<DOMTransactionChain> {
40 private static final Logger LOG = LoggerFactory.getLogger(BindingDOMTransactionChainAdapter.class);
42 private final DOMTransactionChain delegate;
43 private final AdapterContext adapterContext;
44 private final DelegateChainListener domListener;
45 private final TransactionChainListener bindingListener;
47 BindingDOMTransactionChainAdapter(final Function<DOMTransactionChainListener, DOMTransactionChain> chainFactory,
48 final AdapterContext codec, final TransactionChainListener listener) {
49 requireNonNull(chainFactory, "DOM Transaction chain factory must not be null");
50 this.domListener = new DelegateChainListener();
51 this.bindingListener = listener;
52 this.delegate = chainFactory.apply(domListener);
53 this.adapterContext = requireNonNull(codec);
57 public DOMTransactionChain getDelegate() {
62 public ReadTransaction newReadOnlyTransaction() {
63 return new BindingDOMReadTransactionAdapter(adapterContext,
64 createTransaction(delegate::newReadOnlyTransaction));
68 public WriteTransaction newWriteOnlyTransaction() {
69 final DOMDataTreeWriteTransaction delegateTx = createTransaction(delegate::newWriteOnlyTransaction);
70 return new BindingDOMWriteTransactionAdapter<>(adapterContext, delegateTx) {
72 public FluentFuture<? extends CommitInfo> commit() {
73 return listenForFailure(this, super.commit());
79 public ReadWriteTransaction newReadWriteTransaction() {
80 final DOMDataTreeReadWriteTransaction delegateTx = createTransaction(delegate::newReadWriteTransaction);
81 return new BindingDOMReadWriteTransactionAdapter(adapterContext, delegateTx) {
83 public FluentFuture<? extends CommitInfo> commit() {
84 return listenForFailure(this, super.commit());
89 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
90 justification = "https://github.com/spotbugs/spotbugs/issues/811")
91 private <T, F extends ListenableFuture<T>> F listenForFailure(final WriteTransaction tx, final F future) {
92 Futures.addCallback(future, new FutureCallback<T>() {
94 public void onFailure(final Throwable throwable) {
95 failTransactionChain(tx, throwable);
99 public void onSuccess(final T result) {
100 // Intentionally NOOP
102 }, MoreExecutors.directExecutor());
107 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
108 justification = "https://github.com/spotbugs/spotbugs/issues/811")
109 private void failTransactionChain(final WriteTransaction tx, final Throwable throwable) {
111 * We asume correct state change for underlaying transaction
113 * chain, so we are not changing any of our internal state
114 * to mark that we failed.
116 this.bindingListener.onTransactionChainFailed(this, tx, throwable);
120 public void close() {
124 private static <T> T createTransaction(final Supplier<T> supplier) {
126 return supplier.get();
127 } catch (DOMTransactionChainClosedException e) {
128 throw new TransactionChainClosedException("Transaction chain already closed", e);
132 private final class DelegateChainListener implements DOMTransactionChainListener {
134 public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
135 final Throwable cause) {
136 checkState(delegate.equals(chain), "Listener for %s was invoked for incorrect chain %s.", delegate, chain);
138 * Intentionally NOOP, callback for failure, since we
139 * are also listening on each transaction future for failure,
140 * in order to have reference to Binding Transaction (which was seen by client
141 * of this transaction chain), instead of DOM transaction
142 * which is known only to this chain, binding transaction implementation
143 * and underlying transaction chain.
145 LOG.debug("Transaction chain {} failed. Failed DOM Transaction {}",this,transaction,cause);
149 public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
150 checkState(delegate.equals(chain), "Listener for %s was invoked for incorrect chain %s.", delegate, chain);
151 bindingListener.onTransactionChainSuccessful(BindingDOMTransactionChainAdapter.this);