git.opendaylight Code Review - mdsal.git/blob

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