2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.adapter;
10 import com.google.common.collect.ClassToInstanceMap;
11 import com.google.common.collect.ImmutableSet;
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.ReadWriteTransaction;
20 import org.opendaylight.mdsal.binding.api.WriteTransaction;
21 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
22 import org.opendaylight.mdsal.common.api.TransactionChainListener;
23 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
24 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
25 import org.opendaylight.mdsal.dom.api.DOMService;
26 import org.opendaylight.yangtools.concepts.ListenerRegistration;
27 import org.opendaylight.yangtools.yang.binding.DataObject;
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.
36 * Besides this the DataBrokerImpl and it's collaborators also cache data that
37 * is already transformed from the binding independent to binding aware format
40 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker implements
41 DataBroker, DataTreeChangeService {
44 static final Factory<DataBroker> BUILDER_FACTORY = Builder::new;
45 private final DataTreeChangeService treeChangeService;
47 public BindingDOMDataBrokerAdapter(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
48 super(domDataBroker, codec);
49 final DOMDataTreeChangeService domTreeChange = domDataBroker.getExtensions()
50 .getInstance(DOMDataTreeChangeService.class);
51 if (domTreeChange != null) {
52 treeChangeService = BindingDOMDataTreeChangeServiceAdapter.create(codec, domTreeChange);
54 treeChangeService = null;
59 public ReadTransaction newReadOnlyTransaction() {
60 return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(), getCodec());
64 public WriteTransaction newWriteOnlyTransaction() {
65 return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(), getCodec());
69 public ReadWriteTransaction newReadWriteTransaction() {
70 return new BindingDOMReadWriteTransactionAdapter(getDelegate().newReadWriteTransaction(), getCodec());
74 public BindingTransactionChain createTransactionChain(final TransactionChainListener listener) {
75 return new BindingDOMTransactionChainAdapter(getDelegate(), getCodec(), listener);
78 private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
81 public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
82 return ImmutableSet.of(DOMDataBroker.class);
86 protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
87 final ClassToInstanceMap<DOMService> delegates) {
88 final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
89 return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
95 public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L>
96 registerDataTreeChangeListener(
97 final DataTreeIdentifier<T> treeId, final L listener) {
98 if (treeChangeService == null) {
99 throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
101 return treeChangeService.registerDataTreeChangeListener(treeId, listener);