opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/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.controller.md.sal.binding.impl;
   9
  10 import com.google.common.collect.ClassToInstanceMap;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.Set;
  13 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  16 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeService;
  17 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  18 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  19 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  21 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMAdapterBuilder.Factory;
  22 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMService;
  26 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  27 import org.opendaylight.yangtools.yang.binding.DataObject;
  28
  29 /**
  30  * The DataBrokerImpl simply defers to the DOMDataBroker for all its operations.
  31  * All transactions and listener registrations are wrapped by the DataBrokerImpl
  32  * to allow binding aware components to use the DataBroker transparently.
  33  *
  34  * <p>
  35  * Besides this the DataBrokerImpl and it's collaborators also cache data that
  36  * is already transformed from the binding independent to binding aware format
  37  */
  38 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker
  39         implements DataBroker, DataTreeChangeService {
  40     static final Factory<DataBroker> BUILDER_FACTORY = Builder::new;
  41     private final DataTreeChangeService treeChangeService;
  42
  43     public BindingDOMDataBrokerAdapter(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
  44         super(domDataBroker, codec);
  45         final DOMDataTreeChangeService domTreeChange = (DOMDataTreeChangeService) domDataBroker
  46                 .getSupportedExtensions().get(DOMDataTreeChangeService.class);
  47         if (domTreeChange != null) {
  48             treeChangeService = BindingDOMDataTreeChangeServiceAdapter.create(codec, domTreeChange);
  49         } else {
  50             treeChangeService = null;
  51         }
  52     }
  53
  54     @Override
  55
  56     public ReadOnlyTransaction newReadOnlyTransaction() {
  57         return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(),getCodec());
  58     }
  59
  60     @Override
  61     public ReadWriteTransaction newReadWriteTransaction() {
  62         return new BindingDOMReadWriteTransactionAdapter(getDelegate().newReadWriteTransaction(),getCodec());
  63     }
  64
  65     @Override
  66     public WriteTransaction newWriteOnlyTransaction() {
  67         return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(),getCodec());
  68     }
  69
  70     @Override
  71     public BindingTransactionChain createTransactionChain(final TransactionChainListener listener) {
  72         return new BindingDOMTransactionChainAdapter(getDelegate(), getCodec(), listener);
  73     }
  74
  75     @Override
  76     public String toString() {
  77         return "BindingDOMDataBrokerAdapter for " + getDelegate();
  78     }
  79
  80     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  81
  82         @Override
  83         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  84             return ImmutableSet.of(DOMDataBroker.class);
  85         }
  86
  87         @Override
  88         protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
  89                 final ClassToInstanceMap<DOMService> delegates) {
  90             final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
  91             return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
  92         }
  93
  94     }
  95
  96     @Override
  97     public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L>
  98             registerDataTreeChangeListener(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 }