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.controller.md.sal.binding.impl;
10 import com.google.common.base.Objects;
11 import com.google.common.base.Optional;
13 import java.util.ArrayList;
14 import java.util.Collections;
15 import java.util.Comparator;
16 import java.util.HashMap;
17 import java.util.HashSet;
18 import java.util.Iterator;
20 import java.util.Map.Entry;
23 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
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.md.sal.dom.api.DOMDataBroker;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
29 import org.opendaylight.controller.sal.binding.impl.connect.dom.BindingIndependentConnector;
30 import org.opendaylight.controller.sal.binding.impl.forward.DomForwardedBroker;
31 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
32 import org.opendaylight.controller.sal.core.api.model.SchemaService;
33 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
34 import org.opendaylight.yangtools.concepts.Delegator;
35 import org.opendaylight.yangtools.concepts.ListenerRegistration;
36 import org.opendaylight.yangtools.yang.binding.DataObject;
37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
40 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
41 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
42 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
43 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
47 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker, SchemaContextListener, AutoCloseable {
49 private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
50 // The Broker to whom we do all forwarding
51 private final DOMDataBroker domDataBroker;
53 // Mapper to convert from Binding Independent objects to Binding Aware
55 private final BindingIndependentMappingService mappingService;
57 private final BindingToNormalizedNodeCodec codec;
58 private BindingIndependentConnector connector;
59 private ProviderSession context;
60 private final ListenerRegistration<SchemaContextListener> schemaListenerRegistration;
62 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker,
63 final BindingIndependentMappingService mappingService,final SchemaService schemaService) {
64 this.domDataBroker = domDataBroker;
65 this.mappingService = mappingService;
66 this.codec = new BindingToNormalizedNodeCodec(mappingService);
67 this.schemaListenerRegistration = schemaService.registerSchemaContextListener(this);
70 protected BindingToNormalizedNodeCodec getCodec() {
74 protected BindingIndependentMappingService getMappingService() {
75 return mappingService;
79 public DOMDataBroker getDelegate() {
84 public void onGlobalContextUpdated(final SchemaContext ctx) {
85 codec.onGlobalContextUpdated(ctx);
88 public ListenerRegistration<DataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
89 final InstanceIdentifier<?> path, final DataChangeListener listener,
90 final DataChangeScope triggeringScope) {
91 DOMDataChangeListener domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
93 YangInstanceIdentifier domPath = codec.toNormalized(path);
94 ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
95 domPath, domDataChangeListener, triggeringScope);
96 return new ListenerRegistrationImpl(listener, domRegistration);
99 protected Map<InstanceIdentifier<?>, DataObject> toBinding(
100 InstanceIdentifier<?> path,
101 final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
102 Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
104 for (Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : sortedEntries(normalized)) {
106 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
108 if (potential.isPresent()) {
109 Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
110 newMap.put(binding.getKey(), binding.getValue());
111 } else if (entry.getKey().getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
112 DataObject bindingDataObject = getCodec().toBinding(path, entry.getValue());
113 if (bindingDataObject != null) {
114 newMap.put(path, bindingDataObject);
117 } catch (DeserializationException e) {
118 LOG.warn("Failed to transform {}, omitting it", entry, e);
124 private static final Comparator<Entry<YangInstanceIdentifier, ?>> MAP_ENTRY_COMPARATOR = new Comparator<Entry<YangInstanceIdentifier, ?>>() {
126 public int compare(final Entry<YangInstanceIdentifier, ?> left,
127 final Entry<YangInstanceIdentifier, ?> right) {
128 final Iterator<?> li = left.getKey().getPathArguments().iterator();
129 final Iterator<?> ri = right.getKey().getPathArguments().iterator();
131 // Iterate until left is exhausted...
132 while (li.hasNext()) {
142 // Check if right is exhausted
143 return ri.hasNext() ? -1 : 0;
147 private static <T> Iterable<Entry<YangInstanceIdentifier,T>> sortedEntries(final Map<YangInstanceIdentifier, T> map) {
148 if (!map.isEmpty()) {
149 ArrayList<Entry<YangInstanceIdentifier, T>> entries = new ArrayList<>(map.entrySet());
150 Collections.sort(entries, MAP_ENTRY_COMPARATOR);
153 return Collections.emptySet();
157 protected Set<InstanceIdentifier<?>> toBinding(InstanceIdentifier<?> path,
158 final Set<YangInstanceIdentifier> normalized) {
159 Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
160 for (YangInstanceIdentifier normalizedPath : normalized) {
162 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
163 if (potential.isPresent()) {
164 InstanceIdentifier<? extends DataObject> binding = potential.get();
165 hashSet.add(binding);
166 } else if (normalizedPath.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
169 } catch (DeserializationException e) {
170 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
176 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
177 if (path.isWildcarded()) {
178 return Optional.absent();
182 return Optional.fromNullable(getCodec().toBinding(path, data));
183 } catch (DeserializationException e) {
184 return Optional.absent();
188 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
189 private final DataChangeListener bindingDataChangeListener;
190 private final LogicalDatastoreType store;
191 private final InstanceIdentifier<?> path;
192 private final DataChangeScope triggeringScope;
194 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
195 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
198 this.bindingDataChangeListener = bindingDataChangeListener;
199 this.triggeringScope = triggeringScope;
203 public void onDataChanged(
204 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
205 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
209 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
210 private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
211 private final InstanceIdentifier<?> path;
213 private Map<InstanceIdentifier<?>, DataObject> createdCache;
214 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
215 private Map<InstanceIdentifier<?>, DataObject> originalCache;
216 private Set<InstanceIdentifier<?>> removedCache;
217 private Optional<DataObject> originalDataCache;
218 private Optional<DataObject> updatedDataCache;
220 public TranslatedDataChangeEvent(
221 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
222 final InstanceIdentifier<?> path) {
223 this.domEvent = change;
228 public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
229 if (createdCache == null) {
230 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
236 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
237 if (updatedCache == null) {
238 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
245 public Set<InstanceIdentifier<?>> getRemovedPaths() {
246 if (removedCache == null) {
247 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
253 public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
254 if (originalCache == null) {
255 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
257 return originalCache;
262 public DataObject getOriginalSubtree() {
263 if (originalDataCache == null) {
264 if(domEvent.getOriginalSubtree() != null) {
265 originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
267 originalDataCache = Optional.absent();
270 return originalDataCache.orNull();
274 public DataObject getUpdatedSubtree() {
275 if (updatedDataCache == null) {
276 if(domEvent.getUpdatedSubtree() != null) {
277 updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
279 updatedDataCache = Optional.absent();
282 return updatedDataCache.orNull();
286 public String toString() {
287 return Objects.toStringHelper(TranslatedDataChangeEvent.class) //
288 .add("created", getCreatedData()) //
289 .add("updated", getUpdatedData()) //
290 .add("removed", getRemovedPaths()) //
291 .add("dom", domEvent) //
296 private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
297 private final ListenerRegistration<DOMDataChangeListener> registration;
299 public ListenerRegistrationImpl(final DataChangeListener listener,
300 final ListenerRegistration<DOMDataChangeListener> registration) {
302 this.registration = registration;
306 protected void removeRegistration() {
307 registration.close();
312 public BindingIndependentConnector getConnector() {
313 return this.connector;
317 public ProviderSession getDomProviderContext() {
322 public void setConnector(final BindingIndependentConnector connector) {
323 this.connector = connector;
327 public void setDomProviderContext(final ProviderSession domProviderContext) {
328 this.context = domProviderContext;
332 public void startForwarding() {
337 public void close() throws Exception {
338 this.schemaListenerRegistration.close();