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.opendaylight.mdsal.binding.api.BindingTransactionChain;
  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.WriteTransaction;
  20 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
  21 import org.opendaylight.mdsal.common.api.TransactionChainListener;
  22 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  23 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  24 import org.opendaylight.mdsal.dom.api.DOMService;
  25 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  26 import org.opendaylight.yangtools.yang.binding.DataObject;
  27
  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  */
  39 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker implements
  40         DataBroker, DataTreeChangeService {
  41
  42
  43     static final Factory<DataBroker> BUILDER_FACTORY = new BindingDOMAdapterBuilder.Factory<DataBroker>() {
  44
  45         @Override
  46         public BindingDOMAdapterBuilder<DataBroker> newBuilder() {
  47             return new Builder();
  48         }
  49
  50     };
  51     private final DataTreeChangeService treeChangeService;
  52
  53     public BindingDOMDataBrokerAdapter(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
  54         super(domDataBroker, codec);
  55         final DOMDataTreeChangeService domTreeChange
  56             = (DOMDataTreeChangeService) domDataBroker.getSupportedExtensions().get(DOMDataTreeChangeService.class);
  57         if (domTreeChange != null) {
  58             treeChangeService = BindingDOMDataTreeChangeServiceAdapter.create(codec, domTreeChange);
  59         } else {
  60             treeChangeService = null;
  61         }
  62     }
  63
  64     @Override
  65     public ReadTransaction newReadOnlyTransaction() {
  66         return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(),getCodec());
  67     }
  68
  69     @Override
  70     public WriteTransaction newWriteOnlyTransaction() {
  71         return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(),getCodec());
  72     }
  73
  74     @Override
  75     public BindingTransactionChain createTransactionChain(final TransactionChainListener listener) {
  76         return new BindingDOMTransactionChainAdapter(getDelegate(), getCodec(), listener);
  77     }
  78
  79     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  80
  81         @Override
  82         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  83             return ImmutableSet.of(DOMDataBroker.class);
  84         }
  85
  86         @Override
  87         protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
  88                 final ClassToInstanceMap<DOMService> delegates) {
  89             final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
  90             return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
  91         }
  92
  93     }
  94
  95     @Override
  96     public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L>
  97             registerDataTreeChangeListener(
  98             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
 105 }