binding2/mdsal-binding2-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/adapter/impl/data/BindingDOMDataBrokerAdapter.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.javav2.dom.adapter.impl.data;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ClassToInstanceMap;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.Collection;
  14 import java.util.Set;
  15 import javax.annotation.Nonnull;
  16 import org.opendaylight.mdsal.binding.javav2.api.DataBroker;
  17 import org.opendaylight.mdsal.binding.javav2.api.DataTreeIdentifier;
  18 import org.opendaylight.mdsal.binding.javav2.api.DataTreeListener;
  19 import org.opendaylight.mdsal.binding.javav2.api.DataTreeLoopException;
  20 import org.opendaylight.mdsal.binding.javav2.api.DataTreeProducer;
  21 import org.opendaylight.mdsal.binding.javav2.api.DataTreeService;
  22 import org.opendaylight.mdsal.binding.javav2.api.ReadTransaction;
  23 import org.opendaylight.mdsal.binding.javav2.api.TransactionChain;
  24 import org.opendaylight.mdsal.binding.javav2.api.TransactionChainListener;
  25 import org.opendaylight.mdsal.binding.javav2.api.WriteTransaction;
  26 import org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.data.tree.BindingDOMDataTreeServiceAdapter;
  27 import org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.transaction.BindingDOMReadTransactionAdapter;
  28 import org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.transaction.BindingDOMTransactionChainAdapter;
  29 import org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.transaction.BindingDOMWriteTransactionAdapter;
  30 import org.opendaylight.mdsal.binding.javav2.dom.adapter.spi.AbstractForwardedDataBroker;
  31 import org.opendaylight.mdsal.binding.javav2.dom.adapter.spi.builder.BindingDOMAdapterBuilder;
  32 import org.opendaylight.mdsal.binding.javav2.dom.adapter.spi.builder.BindingDOMAdapterBuilder.Factory;
  33 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingToNormalizedNodeCodec;
  34 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  35 import org.opendaylight.mdsal.dom.api.DOMDataTreeService;
  36 import org.opendaylight.mdsal.dom.api.DOMService;
  37 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  38
  39 /**
  40  * The DataBrokerImpl simply defers to the DOMDataBroker for all its operations. All transactions and listener
  41  * registrations are wrapped by the DataBrokerImpl to allow binding aware components to use the DataBroker
  42  * transparently.
  43  *
  44  * <p>
  45  * Besides this the DataBrokerImpl and it's collaborators also cache data that is already transformed from the
  46  * binding independent to binding aware format
  47  *
  48  */
  49 @Beta
  50 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker implements DataBroker, DataTreeService {
  51
  52     public static final Factory<DataBroker> BUILDER_FACTORY = Builder::new;
  53
  54     private final DataTreeService treeService;
  55
  56     public BindingDOMDataBrokerAdapter(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
  57         super(domDataBroker, codec);
  58         // FIXME: this is an invalid lookup
  59         final DOMDataTreeService domTreeChange =
  60                 (DOMDataTreeService) domDataBroker.getExtensions().get(DOMDataTreeService.class);
  61         if (domTreeChange != null) {
  62             treeService = BindingDOMDataTreeServiceAdapter.create(domTreeChange, codec);
  63         } else {
  64             treeService = null;
  65         }
  66     }
  67
  68     @Override
  69     public ReadTransaction newReadOnlyTransaction() {
  70         return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(), getCodec());
  71     }
  72
  73     @Override
  74     public WriteTransaction newWriteOnlyTransaction() {
  75         return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(), getCodec());
  76     }
  77
  78     @Override
  79     public TransactionChain createTransactionChain(final TransactionChainListener listener) {
  80         return new BindingDOMTransactionChainAdapter(getDelegate(), getCodec(), listener);
  81     }
  82
  83     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  84
  85         @Override
  86         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  87             return ImmutableSet.of(DOMDataBroker.class);
  88         }
  89
  90         @Override
  91         protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
  92                 final ClassToInstanceMap<DOMService> delegates) {
  93             final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
  94             return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
  95         }
  96
  97     }
  98
  99     @Nonnull
 100     @Override
 101     public <T extends DataTreeListener> ListenerRegistration<T> registerListener(@Nonnull final T listener,
 102             @Nonnull final Collection<DataTreeIdentifier<?>> subtrees, final boolean allowRxMerges,
 103             @Nonnull final Collection<DataTreeProducer> producers) throws DataTreeLoopException {
 104         if (treeService == null) {
 105             throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
 106         }
 107         return treeService.registerListener(listener, subtrees, allowRxMerges, producers);
 108     }
 109
 110     @Override
 111     public DataTreeProducer createProducer(final Collection<DataTreeIdentifier<?>> subtrees) {
 112         return treeService.createProducer(subtrees);
 113     }
 114 }