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.common.api.TransactionChainListener;
13 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
14 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
15 import org.opendaylight.mdsal.dom.api.DOMService;
16 import org.opendaylight.mdsal.binding.api.BindingTransactionChain;
17 import org.opendaylight.mdsal.binding.api.DataBroker;
18 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
19 import org.opendaylight.mdsal.binding.api.DataTreeChangeService;
20 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
21 import org.opendaylight.mdsal.binding.api.ReadOnlyTransaction;
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.yangtools.concepts.ListenerRegistration;
28 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.
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
40 public class BindingDOMDataBrokerAdapter extends AbstractForwardedDataBroker implements DataBroker, DataTreeChangeService {
43 static final Factory<DataBroker> BUILDER_FACTORY = new BindingDOMAdapterBuilder.Factory<DataBroker>() {
46 public BindingDOMAdapterBuilder<DataBroker> newBuilder() {
51 private final DataTreeChangeService treeChangeService;
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);
59 treeChangeService = null;
64 public ReadOnlyTransaction newReadOnlyTransaction() {
65 return new BindingDOMReadTransactionAdapter(getDelegate().newReadOnlyTransaction(),getCodec());
69 public WriteTransaction newWriteOnlyTransaction() {
70 return new BindingDOMWriteTransactionAdapter<>(getDelegate().newWriteOnlyTransaction(),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> registerDataTreeChangeListener(
96 final DataTreeIdentifier<T> treeId, final L listener) {
97 if(treeChangeService == null) {
98 throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
100 return treeChangeService.registerDataTreeChangeListener(treeId, listener);