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 org.opendaylight.mdsal.dom.api.ClusteredDOMDataChangeListener;
11 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
12 import org.opendaylight.mdsal.dom.api.DOMDataChangeListener;
14 import org.opendaylight.mdsal.binding.api.ClusteredDataChangeListener;
15 import org.opendaylight.mdsal.binding.api.DataChangeListener;
16 import com.google.common.base.MoreObjects;
17 import com.google.common.base.Optional;
18 import java.util.Collections;
19 import java.util.HashMap;
20 import java.util.HashSet;
22 import java.util.Map.Entry;
24 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
25 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.controller.sal.core.api.model.SchemaService;
28 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
29 import org.opendaylight.yangtools.concepts.Delegator;
30 import org.opendaylight.yangtools.concepts.ListenerRegistration;
31 import org.opendaylight.yangtools.yang.binding.DataObject;
32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, AutoCloseable {
41 private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
42 // The Broker to whom we do all forwarding
43 private final DOMDataBroker domDataBroker;
45 private final BindingToNormalizedNodeCodec codec;
47 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec,
48 final SchemaService schemaService) {
49 this.domDataBroker = domDataBroker;
53 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
54 this.domDataBroker = domDataBroker;
58 protected BindingToNormalizedNodeCodec getCodec() {
63 public DOMDataBroker getDelegate() {
67 public ListenerRegistration<DataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
68 final InstanceIdentifier<?> path, final DataChangeListener listener, final DataChangeScope triggeringScope) {
69 final DOMDataChangeListener domDataChangeListener;
71 if(listener instanceof ClusteredDataChangeListener) {
72 domDataChangeListener = new TranslatingClusteredDataChangeInvoker(store, path, listener, triggeringScope);
74 domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
77 final YangInstanceIdentifier domPath = codec.toYangInstanceIdentifierBlocking(path);
78 final ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
79 domPath, domDataChangeListener, triggeringScope);
80 return new ListenerRegistrationImpl(listener, domRegistration);
83 protected Map<InstanceIdentifier<?>, DataObject> toBinding(final InstanceIdentifier<?> path,
84 final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
85 final Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
87 for (final Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : normalized.entrySet()) {
89 final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(entry);
90 if (potential.isPresent()) {
91 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
92 newMap.put(binding.getKey(), binding.getValue());
94 } catch (final DeserializationException e) {
95 LOG.warn("Failed to transform {}, omitting it", entry, e);
101 protected Set<InstanceIdentifier<?>> toBinding(final InstanceIdentifier<?> path,
102 final Set<YangInstanceIdentifier> normalized) {
103 final Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
104 for (final YangInstanceIdentifier normalizedPath : normalized) {
106 final Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
107 if (potential.isPresent()) {
108 final InstanceIdentifier<? extends DataObject> binding = potential.get();
109 hashSet.add(binding);
110 } else if (normalizedPath.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
113 } catch (final DeserializationException e) {
114 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
120 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
121 if (path.isWildcarded()) {
122 return Optional.absent();
124 return (Optional<DataObject>) getCodec().deserializeFunction(path).apply(Optional.<NormalizedNode<?, ?>> of(data));
127 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
128 private final DataChangeListener bindingDataChangeListener;
129 private final LogicalDatastoreType store;
130 private final InstanceIdentifier<?> path;
131 private final DataChangeScope triggeringScope;
133 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
134 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
137 this.bindingDataChangeListener = bindingDataChangeListener;
138 this.triggeringScope = triggeringScope;
142 public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
143 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
147 public String toString() {
148 return bindingDataChangeListener.getClass().getName();
153 * Translator for ClusteredDataChangeListener
156 private class TranslatingClusteredDataChangeInvoker extends TranslatingDataChangeInvoker implements
157 ClusteredDOMDataChangeListener {
159 public TranslatingClusteredDataChangeInvoker(LogicalDatastoreType store, InstanceIdentifier<?> path,
160 DataChangeListener bindingDataChangeListener,
161 DataChangeScope triggeringScope) {
162 super(store, path, bindingDataChangeListener, triggeringScope);
166 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
167 private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
168 private final InstanceIdentifier<?> path;
170 private Map<InstanceIdentifier<?>, DataObject> createdCache;
171 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
172 private Map<InstanceIdentifier<?>, DataObject> originalCache;
173 private Set<InstanceIdentifier<?>> removedCache;
174 private Optional<DataObject> originalDataCache;
175 private Optional<DataObject> updatedDataCache;
177 public TranslatedDataChangeEvent(
178 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
179 final InstanceIdentifier<?> path) {
180 this.domEvent = change;
185 public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
186 if (createdCache == null) {
187 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
193 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
194 if (updatedCache == null) {
195 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
202 public Set<InstanceIdentifier<?>> getRemovedPaths() {
203 if (removedCache == null) {
204 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
210 public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
211 if (originalCache == null) {
212 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
214 return originalCache;
219 public DataObject getOriginalSubtree() {
220 if (originalDataCache == null) {
221 if (domEvent.getOriginalSubtree() != null) {
222 originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
224 originalDataCache = Optional.absent();
227 return originalDataCache.orNull();
231 public DataObject getUpdatedSubtree() {
232 if (updatedDataCache == null) {
233 if (domEvent.getUpdatedSubtree() != null) {
234 updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
236 updatedDataCache = Optional.absent();
239 return updatedDataCache.orNull();
243 public String toString() {
244 return MoreObjects.toStringHelper(TranslatedDataChangeEvent.class) //
245 .add("created", getCreatedData()) //
246 .add("updated", getUpdatedData()) //
247 .add("removed", getRemovedPaths()) //
248 .add("dom", domEvent) //
253 private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
254 private final ListenerRegistration<DOMDataChangeListener> registration;
256 public ListenerRegistrationImpl(final DataChangeListener listener,
257 final ListenerRegistration<DOMDataChangeListener> registration) {
259 this.registration = registration;
263 protected void removeRegistration() {
264 registration.close();
269 public void close() {