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.collect.ClassToInstanceMap;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.Set;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.mdsal.binding.api.DataBroker;
  15 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
  16 import org.opendaylight.mdsal.binding.api.DataTreeChangeService;
  17 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  18 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  19 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  20 import org.opendaylight.mdsal.binding.api.TransactionChain;
  21 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  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.DOMDataTreeChangeService;
  26 import org.opendaylight.mdsal.dom.api.DOMService;
  27 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  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 public class BindingDOMDataBrokerAdapter extends AbstractBindingAdapter<@NonNull DOMDataBroker> implements DataBroker,
  40         DataTreeChangeService {
  41
  42     static final Factory<DataBroker> BUILDER_FACTORY = Builder::new;
  43     private final DataTreeChangeService treeChangeService;
  44
  45     public BindingDOMDataBrokerAdapter(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
  46         super(codec, domDataBroker);
  47         final DOMDataTreeChangeService domTreeChange = domDataBroker.getExtensions()
  48                 .getInstance(DOMDataTreeChangeService.class);
  49         if (domTreeChange != null) {
  50             treeChangeService = BindingDOMDataTreeChangeServiceAdapter.create(codec, domTreeChange);
  51         } else {
  52             treeChangeService = null;
  53         }
  54     }
  55
  56     @Override
  57     public ReadTransaction newReadOnlyTransaction() {
  58         return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(), getCodec());
  59     }
  60
  61     @Override
  62     public WriteTransaction newWriteOnlyTransaction() {
  63         return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(), getCodec());
  64     }
  65
  66     @Override
  67     public ReadWriteTransaction newReadWriteTransaction() {
  68         return new BindingDOMReadWriteTransactionAdapter(getDelegate().newReadWriteTransaction(), getCodec());
  69     }
  70
  71     @Override
  72     public TransactionChain createTransactionChain(final TransactionChainListener listener) {
  73         return new BindingDOMTransactionChainAdapter(getDelegate()::createTransactionChain, getCodec(), listener);
  74     }
  75
  76     @Override
  77     public TransactionChain createMergingTransactionChain(final TransactionChainListener listener) {
  78         return new BindingDOMTransactionChainAdapter(getDelegate()::createMergingTransactionChain, getCodec(),
  79             listener);
  80     }
  81
  82     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  83         @Override
  84         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  85             return ImmutableSet.of(DOMDataBroker.class);
  86         }
  87
  88         @Override
  89         protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
  90                 final ClassToInstanceMap<DOMService> delegates) {
  91             final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
  92             return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
  93         }
  94     }
  95
  96     @Override
  97     public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L>
  98             registerDataTreeChangeListener(
  99             final DataTreeIdentifier<T> treeId, final L listener) {
 100         if (treeChangeService == null) {
 101             throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
 102         }
 103         return treeChangeService.registerDataTreeChangeListener(treeId, listener);
 104     }
 105 }