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;
11 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
12 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
13 import org.opendaylight.mdsal.dom.api.DOMService;
15 import org.opendaylight.mdsal.binding.api.BindingTransactionChain;
16 import org.opendaylight.mdsal.binding.api.DataBroker;
17 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
18 import org.opendaylight.mdsal.binding.api.DataTreeChangeService;
19 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
20 import org.opendaylight.mdsal.binding.api.ReadOnlyTransaction;
21 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
22 import org.opendaylight.mdsal.binding.api.WriteTransaction;
23 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
24 import com.google.common.collect.ClassToInstanceMap;
25 import com.google.common.collect.ImmutableSet;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
28 import org.opendaylight.yangtools.concepts.ListenerRegistration;
29 import org.opendaylight.yangtools.yang.binding.DataObject;
32 * The DataBrokerImpl simply defers to the DOMDataBroker for all its operations.
33 * All transactions and listener registrations are wrapped by the DataBrokerImpl
34 * 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
41 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker implements DataBroker, DataTreeChangeService {
44 static final Factory<DataBroker> BUILDER_FACTORY = new BindingDOMAdapterBuilder.Factory<DataBroker>() {
47 public BindingDOMAdapterBuilder<DataBroker> newBuilder() {
52 private final DataTreeChangeService treeChangeService;
54 public BindingDOMDataBrokerAdapter(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
55 super(domDataBroker, codec);
56 final DOMDataTreeChangeService domTreeChange = (DOMDataTreeChangeService) domDataBroker.getSupportedExtensions().get(DOMDataTreeChangeService.class);
57 if(domTreeChange != null) {
58 treeChangeService = BindingDOMDataTreeChangeServiceAdapter.create(codec, domTreeChange);
60 treeChangeService = null;
66 public ReadOnlyTransaction newReadOnlyTransaction() {
67 return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(),getCodec());
71 public ReadWriteTransaction newReadWriteTransaction() {
72 return new BindingDOMReadWriteTransactionAdapter(getDelegate().newReadWriteTransaction(),getCodec());
76 public WriteTransaction newWriteOnlyTransaction() {
77 return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(),getCodec());
81 public BindingTransactionChain createTransactionChain(final TransactionChainListener listener) {
82 return new BindingDOMTransactionChainAdapter(getDelegate(), getCodec(), listener);
85 private static class Builder extends BindingDOMAdapterBuilder<DataBroker> {
88 public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
89 return ImmutableSet.of(DOMDataBroker.class);
93 protected DataBroker createInstance(final BindingToNormalizedNodeCodec codec,
94 final ClassToInstanceMap<DOMService> delegates) {
95 final DOMDataBroker domDataBroker = delegates.getInstance(DOMDataBroker.class);
96 return new BindingDOMDataBrokerAdapter(domDataBroker, codec);
102 public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L> registerDataTreeChangeListener(
103 final DataTreeIdentifier<T> treeId, final L listener) {
104 if(treeChangeService == null) {
105 throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
107 return treeChangeService.registerDataTreeChangeListener(treeId, listener);