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