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.opendaylight.yangtools.yang.model.api.SchemaServiceListener;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker, SchemaContextListener, AutoCloseable {
50 private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
51 // The Broker to whom we do all forwarding
52 private final DOMDataBroker domDataBroker;
54 // Mapper to convert from Binding Independent objects to Binding Aware
56 private final BindingIndependentMappingService mappingService;
58 private final BindingToNormalizedNodeCodec codec;
59 private BindingIndependentConnector connector;
60 private ProviderSession context;
61 private final ListenerRegistration<SchemaServiceListener> schemaListenerRegistration;
63 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker,
64 final BindingIndependentMappingService mappingService,final SchemaService schemaService) {
65 this.domDataBroker = domDataBroker;
66 this.mappingService = mappingService;
67 this.codec = new BindingToNormalizedNodeCodec(mappingService);
68 this.schemaListenerRegistration = schemaService.registerSchemaServiceListener(this);
71 protected BindingToNormalizedNodeCodec getCodec() {
75 protected BindingIndependentMappingService getMappingService() {
76 return mappingService;
80 public DOMDataBroker getDelegate() {
85 public void onGlobalContextUpdated(final SchemaContext ctx) {
86 codec.onGlobalContextUpdated(ctx);
89 public ListenerRegistration<DataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
90 final InstanceIdentifier<?> path, final DataChangeListener listener,
91 final DataChangeScope triggeringScope) {
92 DOMDataChangeListener domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
94 YangInstanceIdentifier domPath = codec.toNormalized(path);
95 ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
96 domPath, domDataChangeListener, triggeringScope);
97 return new ListenerRegistrationImpl(listener, domRegistration);
100 protected Map<InstanceIdentifier<?>, DataObject> toBinding(
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());
112 } catch (DeserializationException e) {
113 LOG.warn("Failed to transform {}, omitting it", entry, e);
119 private static final Comparator<Entry<YangInstanceIdentifier, ?>> MAP_ENTRY_COMPARATOR = new Comparator<Entry<YangInstanceIdentifier, ?>>() {
121 public int compare(final Entry<YangInstanceIdentifier, ?> left,
122 final Entry<YangInstanceIdentifier, ?> right) {
123 final Iterator<?> li = left.getKey().getPathArguments().iterator();
124 final Iterator<?> ri = right.getKey().getPathArguments().iterator();
126 // Iterate until left is exhausted...
127 while (li.hasNext()) {
137 // Check if right is exhausted
138 return ri.hasNext() ? -1 : 0;
142 private static <T> Iterable<Entry<YangInstanceIdentifier,T>> sortedEntries(final Map<YangInstanceIdentifier, T> map) {
143 if (!map.isEmpty()) {
144 ArrayList<Entry<YangInstanceIdentifier, T>> entries = new ArrayList<>(map.entrySet());
145 Collections.sort(entries, MAP_ENTRY_COMPARATOR);
148 return Collections.emptySet();
152 protected Set<InstanceIdentifier<?>> toBinding(
153 final Set<YangInstanceIdentifier> normalized) {
154 Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
155 for (YangInstanceIdentifier normalizedPath : normalized) {
157 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
158 if (potential.isPresent()) {
159 InstanceIdentifier<? extends DataObject> binding = potential.get();
160 hashSet.add(binding);
162 } catch (DeserializationException e) {
163 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
169 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
170 if (path.isWildcarded()) {
171 return Optional.absent();
175 return Optional.fromNullable(getCodec().toBinding(path, data));
176 } catch (DeserializationException e) {
177 return Optional.absent();
181 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
182 private final DataChangeListener bindingDataChangeListener;
183 private final LogicalDatastoreType store;
184 private final InstanceIdentifier<?> path;
185 private final DataChangeScope triggeringScope;
187 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
188 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
191 this.bindingDataChangeListener = bindingDataChangeListener;
192 this.triggeringScope = triggeringScope;
196 public void onDataChanged(
197 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
198 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
202 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
203 private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
204 private final InstanceIdentifier<?> path;
206 private Map<InstanceIdentifier<?>, DataObject> createdCache;
207 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
208 private Map<InstanceIdentifier<?>, DataObject> originalCache;
209 private Set<InstanceIdentifier<?>> removedCache;
210 private Optional<DataObject> originalDataCache;
211 private Optional<DataObject> updatedDataCache;
213 public TranslatedDataChangeEvent(
214 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
215 final InstanceIdentifier<?> path) {
216 this.domEvent = change;
221 public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
222 if (createdCache == null) {
223 createdCache = Collections.unmodifiableMap(toBinding(domEvent.getCreatedData()));
229 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
230 if (updatedCache == null) {
231 updatedCache = Collections.unmodifiableMap(toBinding(domEvent.getUpdatedData()));
238 public Set<InstanceIdentifier<?>> getRemovedPaths() {
239 if (removedCache == null) {
240 removedCache = Collections.unmodifiableSet(toBinding(domEvent.getRemovedPaths()));
246 public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
247 if (originalCache == null) {
248 originalCache = Collections.unmodifiableMap(toBinding(domEvent.getOriginalData()));
250 return originalCache;
255 public DataObject getOriginalSubtree() {
256 if (originalDataCache == null) {
257 if(domEvent.getOriginalSubtree() != null) {
258 originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
260 originalDataCache = Optional.absent();
263 return originalDataCache.orNull();
267 public DataObject getUpdatedSubtree() {
268 if (updatedDataCache == null) {
269 if(domEvent.getUpdatedSubtree() != null) {
270 updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
272 updatedDataCache = Optional.absent();
275 return updatedDataCache.orNull();
279 public String toString() {
280 return Objects.toStringHelper(TranslatedDataChangeEvent.class) //
281 .add("created", getCreatedData()) //
282 .add("updated", getUpdatedData()) //
283 .add("removed", getRemovedPaths()) //
284 .add("dom", domEvent) //
289 private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
290 private final ListenerRegistration<DOMDataChangeListener> registration;
292 public ListenerRegistrationImpl(final DataChangeListener listener,
293 final ListenerRegistration<DOMDataChangeListener> registration) {
295 this.registration = registration;
299 protected void removeRegistration() {
300 registration.close();
305 public BindingIndependentConnector getConnector() {
306 return this.connector;
310 public ProviderSession getDomProviderContext() {
315 public void setConnector(final BindingIndependentConnector connector) {
316 this.connector = connector;
320 public void setDomProviderContext(final ProviderSession domProviderContext) {
321 this.context = domProviderContext;
325 public void startForwarding() {
330 public void close() throws Exception {
331 this.schemaListenerRegistration.close();