Deprecate Clustered(DOM)DataTreeChangeListener
[mdsal.git] / binding / mdsal-binding-dom-adapter / src / main / java / org / opendaylight / mdsal / binding / dom / adapter / BindingDOMDataTreeChangeServiceAdapter.java
1 /*
2  * Copyright (c) 2015 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 org.eclipse.jdt.annotation.NonNull;
11 import org.opendaylight.mdsal.binding.api.DataChangeListener;
12 import org.opendaylight.mdsal.binding.api.DataListener;
13 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
14 import org.opendaylight.mdsal.binding.api.DataTreeChangeService;
15 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
16 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
17 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
18 import org.opendaylight.yangtools.concepts.Registration;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20
21 /**
22  * Adapter exposing Binding {@link DataTreeChangeService} and wrapping a {@link DataTreeChangeExtension} and is
23  * responsible for translation and instantiation of {@link BindingDOMDataTreeChangeListenerAdapter} adapters.
24  *
25  * <p>
26  * Each registered {@link DataTreeChangeListener} is wrapped using adapter and registered directly to DOM service.
27  */
28 final class BindingDOMDataTreeChangeServiceAdapter extends AbstractBindingAdapter<DataTreeChangeExtension>
29         implements DataTreeChangeService {
30     BindingDOMDataTreeChangeServiceAdapter(final AdapterContext adapterContext,
31             final DataTreeChangeExtension dataTreeChangeExtension) {
32         super(adapterContext, dataTreeChangeExtension);
33     }
34
35     @Override
36     public <T extends DataObject> Registration registerTreeChangeListener(final DataTreeIdentifier<T> treeId,
37             final DataTreeChangeListener<T> listener) {
38         return getDelegate().registerTreeChangeListener(toDomTreeIdentifier(treeId),
39             new BindingDOMDataTreeChangeListenerAdapter<>(adapterContext(), treeId, listener));
40     }
41
42     @Override
43     @Deprecated(since = "13.0.0", forRemoval = true)
44     public <T extends DataObject> Registration registerLegacyTreeChangeListener(final DataTreeIdentifier<T> treeId,
45             final DataTreeChangeListener<T> listener) {
46         return getDelegate().registerLegacyTreeChangeListener(toDomTreeIdentifier(treeId),
47             new BindingDOMDataTreeChangeListenerAdapter<>(adapterContext(), treeId, listener));
48     }
49
50     @Override
51     public <T extends DataObject> Registration registerDataListener(final DataTreeIdentifier<T> treeId,
52             final DataListener<T> listener) {
53         return getDelegate().registerTreeChangeListener(toDomTreeInstance(treeId),
54             new BindingDOMDataListenerAdapter<>(adapterContext(), listener));
55     }
56
57     @Override
58     public <T extends DataObject> Registration registerDataChangeListener(final DataTreeIdentifier<T> treeId,
59             final DataChangeListener<T> listener) {
60         return getDelegate().registerTreeChangeListener(toDomTreeInstance(treeId),
61             new BindingDOMDataChangeListenerAdapter<>(adapterContext(), listener));
62     }
63
64     private @NonNull DOMDataTreeIdentifier toDomTreeIdentifier(final DataTreeIdentifier<?> treeId) {
65         return DOMDataTreeIdentifier.of(treeId.datastore(),
66             currentSerializer().toYangInstanceIdentifier(treeId.path()));
67     }
68
69     private @NonNull DOMDataTreeIdentifier toDomTreeInstance(final DataTreeIdentifier<?> treeId) {
70         final var instanceIdentifier = treeId.path();
71         if (instanceIdentifier.isWildcarded()) {
72             throw new IllegalArgumentException("Cannot register listener for wildcard " + instanceIdentifier);
73         }
74         return toDomTreeIdentifier(treeId);
75     }
76 }