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 final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
101 Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
103 for (Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : sortedEntries(normalized)) {
105 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
107 if (potential.isPresent()) {
108 Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
109 newMap.put(binding.getKey(), binding.getValue());
111 } catch (DeserializationException e) {
112 LOG.warn("Failed to transform {}, omitting it", entry, e);
118 private static final Comparator<Entry<YangInstanceIdentifier, ?>> MAP_ENTRY_COMPARATOR = new Comparator<Entry<YangInstanceIdentifier, ?>>() {
120 public int compare(final Entry<YangInstanceIdentifier, ?> left,
121 final Entry<YangInstanceIdentifier, ?> right) {
122 final Iterator<?> li = left.getKey().getPathArguments().iterator();
123 final Iterator<?> ri = right.getKey().getPathArguments().iterator();
125 // Iterate until left is exhausted...
126 while (li.hasNext()) {
136 // Check if right is exhausted
137 return ri.hasNext() ? -1 : 0;
141 private static <T> Iterable<Entry<YangInstanceIdentifier,T>> sortedEntries(final Map<YangInstanceIdentifier, T> map) {
142 if (!map.isEmpty()) {
143 ArrayList<Entry<YangInstanceIdentifier, T>> entries = new ArrayList<>(map.entrySet());
144 Collections.sort(entries, MAP_ENTRY_COMPARATOR);
147 return Collections.emptySet();
151 protected Set<InstanceIdentifier<?>> toBinding(
152 final Set<YangInstanceIdentifier> normalized) {
153 Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
154 for (YangInstanceIdentifier normalizedPath : normalized) {
156 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
157 if (potential.isPresent()) {
158 InstanceIdentifier<? extends DataObject> binding = potential.get();
159 hashSet.add(binding);
161 } catch (DeserializationException e) {
162 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
168 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
169 if (path.isWildcarded()) {
170 return Optional.absent();
174 return Optional.fromNullable(getCodec().toBinding(path, data));
175 } catch (DeserializationException e) {
176 return Optional.absent();
180 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
181 private final DataChangeListener bindingDataChangeListener;
182 private final LogicalDatastoreType store;
183 private final InstanceIdentifier<?> path;
184 private final DataChangeScope triggeringScope;
186 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
187 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
190 this.bindingDataChangeListener = bindingDataChangeListener;
191 this.triggeringScope = triggeringScope;
195 public void onDataChanged(
196 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
197 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
201 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
202 private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
203 private final InstanceIdentifier<?> path;
205 private Map<InstanceIdentifier<?>, DataObject> createdCache;
206 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
207 private Map<InstanceIdentifier<?>, DataObject> originalCache;
208 private Set<InstanceIdentifier<?>> removedCache;
209 private Optional<DataObject> originalDataCache;
210 private Optional<DataObject> updatedDataCache;
212 public TranslatedDataChangeEvent(
213 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
214 final InstanceIdentifier<?> path) {
215 this.domEvent = change;
220 public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
221 if (createdCache == null) {
222 createdCache = Collections.unmodifiableMap(toBinding(domEvent.getCreatedData()));
228 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
229 if (updatedCache == null) {
230 updatedCache = Collections.unmodifiableMap(toBinding(domEvent.getUpdatedData()));
237 public Set<InstanceIdentifier<?>> getRemovedPaths() {
238 if (removedCache == null) {
239 removedCache = Collections.unmodifiableSet(toBinding(domEvent.getRemovedPaths()));
245 public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
246 if (originalCache == null) {
247 originalCache = Collections.unmodifiableMap(toBinding(domEvent.getOriginalData()));
249 return originalCache;
254 public DataObject getOriginalSubtree() {
255 if (originalDataCache == null) {
256 if(domEvent.getOriginalSubtree() != null) {
257 originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
259 originalDataCache = Optional.absent();
262 return originalDataCache.orNull();
266 public DataObject getUpdatedSubtree() {
267 if (updatedDataCache == null) {
268 if(domEvent.getUpdatedSubtree() != null) {
269 updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
271 updatedDataCache = Optional.absent();
274 return updatedDataCache.orNull();
278 public String toString() {
279 return Objects.toStringHelper(TranslatedDataChangeEvent.class) //
280 .add("created", getCreatedData()) //
281 .add("updated", getUpdatedData()) //
282 .add("removed", getRemovedPaths()) //
283 .add("dom", domEvent) //
288 private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
289 private final ListenerRegistration<DOMDataChangeListener> registration;
291 public ListenerRegistrationImpl(final DataChangeListener listener,
292 final ListenerRegistration<DOMDataChangeListener> registration) {
294 this.registration = registration;
298 protected void removeRegistration() {
299 registration.close();
304 public BindingIndependentConnector getConnector() {
305 return this.connector;
309 public ProviderSession getDomProviderContext() {
314 public void setConnector(final BindingIndependentConnector connector) {
315 this.connector = connector;
319 public void setDomProviderContext(final ProviderSession domProviderContext) {
320 this.context = domProviderContext;
324 public void startForwarding() {
329 public void close() throws Exception {
330 this.schemaListenerRegistration.close();