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
  11 import com.google.common.collect.ClassToInstanceMap;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.Set;
  14 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  16 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  17 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeService;
  18 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  19 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  20 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  22 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMAdapterBuilder.Factory;
  23 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  26 import org.opendaylight.controller.md.sal.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.
  32  * All transactions and listener registrations are wrapped by the DataBrokerImpl
  33  * to allow binding aware components to use the DataBroker transparently.
  34  *
  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  */
  40 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker implements 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 = (DOMDataTreeChangeService) domDataBroker.getSupportedExtensions().get(DOMDataTreeChangeService.class);
  56         if(domTreeChange != null) {
  57             treeChangeService = BindingDOMDataTreeChangeServiceAdapter.create(codec, domTreeChange);
  58         } else {
  59             treeChangeService = null;
  60         }
  61     }
  62
  63     @Override
  64
  65     public ReadOnlyTransaction newReadOnlyTransaction() {
  66         return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(),getCodec());
  67     }
  68
  69     @Override
  70     public ReadWriteTransaction newReadWriteTransaction() {
  71         return new BindingDOMReadWriteTransactionAdapter(getDelegate().newReadWriteTransaction(),getCodec());
  72     }
  73
  74     @Override
  75     public WriteTransaction newWriteOnlyTransaction() {
  76         return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(),getCodec());
  77     }
  78
  79     @Override
  80     public BindingTransactionChain createTransactionChain(final TransactionChainListener listener) {
  81         return new BindingDOMTransactionChainAdapter(getDelegate(), getCodec(), listener);
  82     }
  83
  84     private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
  85
  86         @Override
  87         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  88             return ImmutableSet.of(DOMDataBroker.class);
  89         }
  90
  91         @Override
  92         protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
  93                 final ClassToInstanceMap<DOMService> delegates) {
  94             final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
  95             return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
  96         }
  97
  98     }
  99
 100     @Override
 101     public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L> registerDataTreeChangeListener(
 102             final DataTreeIdentifier<T> treeId, final L listener) {
 103         if(treeChangeService == null) {
 104             throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
 105         }
 106         return treeChangeService.registerDataTreeChangeListener(treeId, listener);
 107     }
 108
 109 }