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     static final Factory<DataBroker> BUILDER_FACTORY = Builder::new;
  43     private final DataTreeChangeService treeChangeService;
  44
  45     public BindingDOMDataBrokerAdapter(final AdapterContext adapterContext, final DOMDataBroker domDataBroker) {
  46         super(adapterContext, domDataBroker);
  47         final DOMDataTreeChangeService domTreeChange = domDataBroker.getExtensions()
  48                 .getInstance(DOMDataTreeChangeService.class);
  49         treeChangeService = domTreeChange == null ? null
  50                 : new BindingDOMDataTreeChangeServiceAdapter(adapterContext, domTreeChange);
  51     }
  52
  53     @Override
  54     public ReadTransaction newReadOnlyTransaction() {
  55         return new BindingDOMReadTransactionAdapter(adapterContext(), getDelegate().newReadOnlyTransaction());
  56     }
  57
  58     @Override
  59     public WriteTransaction newWriteOnlyTransaction() {
  60         return new BindingDOMWriteTransactionAdapter<>(adapterContext(), getDelegate().newWriteOnlyTransaction());
  61     }
  62
  63     @Override
  64     public ReadWriteTransaction newReadWriteTransaction() {
  65         return new BindingDOMReadWriteTransactionAdapter(adapterContext(), getDelegate().newReadWriteTransaction());
  66     }
  67
  68     @Override
  69     public TransactionChain createTransactionChain(final TransactionChainListener listener) {
  70         return new BindingDOMTransactionChainAdapter(getDelegate()::createTransactionChain, adapterContext(), listener);
  71     }
  72
  73     @Override
  74     public TransactionChain createMergingTransactionChain(final TransactionChainListener listener) {
  75         return new BindingDOMTransactionChainAdapter(getDelegate()::createMergingTransactionChain, adapterContext(),
  76             listener);
  77     }
  78
  79     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  80         Builder(final AdapterContext adapterContext) {
  81             super(adapterContext);
  82         }
  83
  84         @Override
  85         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  86             return ImmutableSet.of(DOMDataBroker.class);
  87         }
  88
  89         @Override
  90         protected DataBroker createInstance(final ClassToInstanceMap<DOMService> delegates) {
  91             return new BindingDOMDataBrokerAdapter(adapterContext(), delegates.getInstance(DOMDataBroker.class));
  92         }
  93     }
  94
  95     @Override
  96     public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L>
  97             registerDataTreeChangeListener(
  98             final DataTreeIdentifier<T> treeId, final L listener) {
  99         if (treeChangeService == null) {
 100             throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
 101         }
 102         return treeChangeService.registerDataTreeChangeListener(treeId, listener);
 103     }
 104 }