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