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;
12 import java.util.ArrayList;
13 import java.util.Collections;
14 import java.util.Comparator;
15 import java.util.HashMap;
16 import java.util.HashSet;
17 import java.util.Iterator;
19 import java.util.Map.Entry;
21 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
22 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
23 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
26 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
27 import org.opendaylight.controller.sal.binding.impl.connect.dom.BindingIndependentConnector;
28 import org.opendaylight.controller.sal.binding.impl.forward.DomForwardedBroker;
29 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
30 import org.opendaylight.controller.sal.core.api.model.SchemaService;
31 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
32 import org.opendaylight.yangtools.concepts.Delegator;
33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
34 import org.opendaylight.yangtools.yang.binding.DataObject;
35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
40 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
44 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker,
45 SchemaContextListener, AutoCloseable {
47 private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
48 // The Broker to whom we do all forwarding
49 private final DOMDataBroker domDataBroker;
51 private final BindingToNormalizedNodeCodec codec;
52 private BindingIndependentConnector connector;
53 private ProviderSession context;
54 private final ListenerRegistration<SchemaContextListener> schemaListenerRegistration;
56 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec,
57 final SchemaService schemaService) {
58 this.domDataBroker = domDataBroker;
60 this.schemaListenerRegistration = schemaService.registerSchemaContextListener(this);
63 protected BindingToNormalizedNodeCodec getCodec() {
68 public DOMDataBroker getDelegate() {
73 public void onGlobalContextUpdated(final SchemaContext ctx) {
77 public ListenerRegistration<DataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
78 final InstanceIdentifier<?> path, final DataChangeListener listener, final DataChangeScope triggeringScope) {
79 DOMDataChangeListener domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
81 YangInstanceIdentifier domPath = codec.toNormalized(path);
82 ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
83 domPath, domDataChangeListener, triggeringScope);
84 return new ListenerRegistrationImpl(listener, domRegistration);
87 protected Map<InstanceIdentifier<?>, DataObject> toBinding(final InstanceIdentifier<?> path,
88 final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
89 Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
91 for (Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : sortedEntries(normalized)) {
93 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(entry);
94 if (potential.isPresent()) {
95 Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
96 newMap.put(binding.getKey(), binding.getValue());
98 } catch (DeserializationException e) {
99 LOG.warn("Failed to transform {}, omitting it", entry, e);
105 private static final Comparator<Entry<YangInstanceIdentifier, ?>> MAP_ENTRY_COMPARATOR = new Comparator<Entry<YangInstanceIdentifier, ?>>() {
107 public int compare(final Entry<YangInstanceIdentifier, ?> left, final Entry<YangInstanceIdentifier, ?> right) {
108 final Iterator<?> li = left.getKey().getPathArguments().iterator();
109 final Iterator<?> ri = right.getKey().getPathArguments().iterator();
111 // Iterate until left is exhausted...
112 while (li.hasNext()) {
122 // Check if right is exhausted
123 return ri.hasNext() ? -1 : 0;
127 private static <T> Iterable<Entry<YangInstanceIdentifier, T>> sortedEntries(final Map<YangInstanceIdentifier, T> map) {
128 if (!map.isEmpty()) {
129 ArrayList<Entry<YangInstanceIdentifier, T>> entries = new ArrayList<>(map.entrySet());
130 Collections.sort(entries, MAP_ENTRY_COMPARATOR);
133 return Collections.emptySet();
137 protected Set<InstanceIdentifier<?>> toBinding(final InstanceIdentifier<?> path,
138 final Set<YangInstanceIdentifier> normalized) {
139 Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
140 for (YangInstanceIdentifier normalizedPath : normalized) {
142 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
143 if (potential.isPresent()) {
144 InstanceIdentifier<? extends DataObject> binding = potential.get();
145 hashSet.add(binding);
146 } else if (normalizedPath.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
149 } catch (DeserializationException e) {
150 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
156 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
157 if (path.isWildcarded()) {
158 return Optional.absent();
160 return (Optional) getCodec().deserializeFunction(path).apply(Optional.<NormalizedNode<?, ?>> of(data));
163 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
164 private final DataChangeListener bindingDataChangeListener;
165 private final LogicalDatastoreType store;
166 private final InstanceIdentifier<?> path;
167 private final DataChangeScope triggeringScope;
169 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
170 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
173 this.bindingDataChangeListener = bindingDataChangeListener;
174 this.triggeringScope = triggeringScope;
178 public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
179 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
183 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
184 private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
185 private final InstanceIdentifier<?> path;
187 private Map<InstanceIdentifier<?>, DataObject> createdCache;
188 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
189 private Map<InstanceIdentifier<?>, DataObject> originalCache;
190 private Set<InstanceIdentifier<?>> removedCache;
191 private Optional<DataObject> originalDataCache;
192 private Optional<DataObject> updatedDataCache;
194 public TranslatedDataChangeEvent(
195 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
196 final InstanceIdentifier<?> path) {
197 this.domEvent = change;
202 public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
203 if (createdCache == null) {
204 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
210 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
211 if (updatedCache == null) {
212 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
219 public Set<InstanceIdentifier<?>> getRemovedPaths() {
220 if (removedCache == null) {
221 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
227 public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
228 if (originalCache == null) {
229 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
231 return originalCache;
236 public DataObject getOriginalSubtree() {
237 if (originalDataCache == null) {
238 if (domEvent.getOriginalSubtree() != null) {
239 originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
241 originalDataCache = Optional.absent();
244 return originalDataCache.orNull();
248 public DataObject getUpdatedSubtree() {
249 if (updatedDataCache == null) {
250 if (domEvent.getUpdatedSubtree() != null) {
251 updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
253 updatedDataCache = Optional.absent();
256 return updatedDataCache.orNull();
260 public String toString() {
261 return Objects.toStringHelper(TranslatedDataChangeEvent.class) //
262 .add("created", getCreatedData()) //
263 .add("updated", getUpdatedData()) //
264 .add("removed", getRemovedPaths()) //
265 .add("dom", domEvent) //
270 private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
271 private final ListenerRegistration<DOMDataChangeListener> registration;
273 public ListenerRegistrationImpl(final DataChangeListener listener,
274 final ListenerRegistration<DOMDataChangeListener> registration) {
276 this.registration = registration;
280 protected void removeRegistration() {
281 registration.close();
286 public BindingIndependentConnector getConnector() {
287 return this.connector;
291 public ProviderSession getDomProviderContext() {
296 public void setConnector(final BindingIndependentConnector connector) {
297 this.connector = connector;
301 public void setDomProviderContext(final ProviderSession domProviderContext) {
302 this.context = domProviderContext;
306 public void startForwarding() {
311 public void close() throws Exception {
312 this.schemaListenerRegistration.close();