binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingDOMDataBrokerAdapter.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.annotations.VisibleForTesting;
  11 import com.google.common.collect.ClassToInstanceMap;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.Set;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.mdsal.binding.api.DataBroker;
  16 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
  17 import org.opendaylight.mdsal.binding.api.DataTreeChangeService;
  18 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  19 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  20 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  21 import org.opendaylight.mdsal.binding.api.TransactionChain;
  22 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  23 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
  24 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  25 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
  26 import org.opendaylight.mdsal.dom.api.DOMService;
  27 import org.opendaylight.yangtools.concepts.Registration;
  28 import org.opendaylight.yangtools.yang.binding.DataObject;
  29
  30 /**
  31  * The DataBrokerImpl simply defers to the DOMDataBroker for all its operations. All transactions and listener
  32  * registrations are wrapped by the DataBrokerImpl to allow binding aware components to use the DataBroker
  33  * transparently.
  34  *
  35  * <p>
  36  * Besides this the DataBrokerImpl and it's collaborators also cache data that is already transformed from the binding
  37  * independent to binding aware format.
  38  */
  39 @VisibleForTesting
  40 public class BindingDOMDataBrokerAdapter extends AbstractBindingAdapter<@NonNull DOMDataBroker> implements DataBroker {
  41     static final Factory<DataBroker> BUILDER_FACTORY = Builder::new;
  42     private final DataTreeChangeService treeChangeService;
  43
  44     public BindingDOMDataBrokerAdapter(final AdapterContext adapterContext, final DOMDataBroker domDataBroker) {
  45         super(adapterContext, domDataBroker);
  46         final var domTreeChange = domDataBroker.extension(DataTreeChangeExtension.class);
  47         treeChangeService = domTreeChange == null ? null
  48                 : new BindingDOMDataTreeChangeServiceAdapter(adapterContext, domTreeChange);
  49     }
  50
  51     @Override
  52     public ReadTransaction newReadOnlyTransaction() {
  53         return new BindingDOMReadTransactionAdapter(adapterContext(), getDelegate().newReadOnlyTransaction());
  54     }
  55
  56     @Override
  57     public WriteTransaction newWriteOnlyTransaction() {
  58         return new BindingDOMWriteTransactionAdapter<>(adapterContext(), getDelegate().newWriteOnlyTransaction());
  59     }
  60
  61     @Override
  62     public ReadWriteTransaction newReadWriteTransaction() {
  63         return new BindingDOMReadWriteTransactionAdapter(adapterContext(), getDelegate().newReadWriteTransaction());
  64     }
  65
  66     @Override
  67     public TransactionChain createTransactionChain() {
  68         return new BindingDOMTransactionChainAdapter(getDelegate().createTransactionChain(), adapterContext());
  69     }
  70
  71     @Override
  72     public TransactionChain createMergingTransactionChain() {
  73         return new BindingDOMTransactionChainAdapter(getDelegate().createMergingTransactionChain(), adapterContext());
  74     }
  75
  76     @Override
  77     public <T extends DataObject> Registration registerTreeChangeListener(final DataTreeIdentifier<T> treeId,
  78             final DataTreeChangeListener<T> listener) {
  79         return getTreeChangeService().registerTreeChangeListener(treeId, listener);
  80     }
  81
  82     @Override
  83     @Deprecated(since = "13.0.0", forRemoval = true)
  84     public <T extends DataObject> Registration registerLegacyTreeChangeListener(final DataTreeIdentifier<T> treeId,
  85             final DataTreeChangeListener<T> listener) {
  86         return getTreeChangeService().registerLegacyTreeChangeListener(treeId, listener);
  87     }
  88
  89     private @NonNull DataTreeChangeService getTreeChangeService() {
  90         final var local = treeChangeService;
  91         if (local == null) {
  92             throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
  93         }
  94         return local;
  95     }
  96
  97     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  98         Builder(final AdapterContext adapterContext) {
  99             super(adapterContext);
 100         }
 101
 102         @Override
 103         public Set<? extends Class<? extends DOMService<?, ?>>> getRequiredDelegates() {
 104             return ImmutableSet.of(DOMDataBroker.class);
 105         }
 106
 107         @Override
 108         protected DataBroker createInstance(final ClassToInstanceMap<DOMService<?, ?>> delegates) {
 109             return new BindingDOMDataBrokerAdapter(adapterContext(), delegates.getInstance(DOMDataBroker.class));
 110         }
 111     }
 112 }