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 java.util.Collections;
11 import java.util.HashMap;
12 import java.util.HashSet;
14 import java.util.Map.Entry;
17 import org.opendaylight.controller.md.sal.binding.api.BindingDataChangeListener;
18 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
19 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
22 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
23 import org.opendaylight.controller.sal.binding.impl.connect.dom.BindingIndependentConnector;
24 import org.opendaylight.controller.sal.binding.impl.forward.DomForwardedBroker;
25 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
26 import org.opendaylight.controller.sal.core.api.model.SchemaService;
27 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
28 import org.opendaylight.yangtools.concepts.Delegator;
29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
30 import org.opendaylight.yangtools.yang.binding.DataObject;
31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
33 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
34 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
37 import org.opendaylight.yangtools.yang.model.api.SchemaServiceListener;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 import com.google.common.base.Objects;
42 import com.google.common.base.Optional;
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 // Mapper to convert from Binding Independent objects to Binding Aware
53 private final BindingIndependentMappingService mappingService;
55 private final BindingToNormalizedNodeCodec codec;
56 private BindingIndependentConnector connector;
57 private ProviderSession context;
58 private final ListenerRegistration<SchemaServiceListener> schemaListenerRegistration;
60 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker,
61 final BindingIndependentMappingService mappingService,final SchemaService schemaService) {
62 this.domDataBroker = domDataBroker;
63 this.mappingService = mappingService;
64 this.codec = new BindingToNormalizedNodeCodec(mappingService);
65 this.schemaListenerRegistration = schemaService.registerSchemaServiceListener(this);
68 protected BindingToNormalizedNodeCodec getCodec() {
72 protected BindingIndependentMappingService getMappingService() {
73 return mappingService;
77 public DOMDataBroker getDelegate() {
82 public void onGlobalContextUpdated(final SchemaContext ctx) {
83 codec.onGlobalContextUpdated(ctx);
86 public ListenerRegistration<BindingDataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
87 final InstanceIdentifier<?> path, final BindingDataChangeListener listener,
88 final DataChangeScope triggeringScope) {
89 DOMDataChangeListener domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
91 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier domPath = codec.toNormalized(path);
92 ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
93 domPath, domDataChangeListener, triggeringScope);
94 return new ListenerRegistrationImpl(listener, domRegistration);
97 protected Map<InstanceIdentifier<?>, DataObject> toBinding(
98 final Map<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
99 Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
100 for (Map.Entry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : normalized
103 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
105 if (potential.isPresent()) {
106 Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
107 newMap.put(binding.getKey(), binding.getValue());
109 } catch (DeserializationException e) {
110 LOG.warn("Failed to transform {}, omitting it", entry, e);
116 protected Set<InstanceIdentifier<?>> toBinding(
117 final Set<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier> normalized) {
118 Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
119 for (org.opendaylight.yangtools.yang.data.api.InstanceIdentifier normalizedPath : normalized) {
121 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
122 if (potential.isPresent()) {
123 InstanceIdentifier<? extends DataObject> binding = potential.get();
124 hashSet.add(binding);
126 } catch (DeserializationException e) {
127 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
133 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
134 if (path.isWildcarded()) {
135 return Optional.absent();
139 return Optional.fromNullable(getCodec().toBinding(path, data));
140 } catch (DeserializationException e) {
141 return Optional.absent();
145 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
146 private final BindingDataChangeListener bindingDataChangeListener;
147 private final LogicalDatastoreType store;
148 private final InstanceIdentifier<?> path;
149 private final DataChangeScope triggeringScope;
151 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
152 final BindingDataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
155 this.bindingDataChangeListener = bindingDataChangeListener;
156 this.triggeringScope = triggeringScope;
160 public void onDataChanged(
161 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> change) {
162 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
166 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
167 private final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> domEvent;
168 private final InstanceIdentifier<?> path;
170 private Map<InstanceIdentifier<?>, DataObject> createdCache;
171 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
172 private Map<InstanceIdentifier<?>, ? extends DataObject> originalCache;
173 private Set<InstanceIdentifier<?>> removedCache;
174 private Optional<DataObject> originalDataCache;
175 private Optional<DataObject> updatedDataCache;
177 public TranslatedDataChangeEvent(
178 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, 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(domEvent.getCreatedData()));
193 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
194 if (updatedCache == null) {
195 updatedCache = Collections.unmodifiableMap(toBinding(domEvent.getUpdatedData()));
202 public Set<InstanceIdentifier<?>> getRemovedPaths() {
203 if (removedCache == null) {
204 removedCache = Collections.unmodifiableSet(toBinding(domEvent.getRemovedPaths()));
210 public Map<InstanceIdentifier<?>, ? extends DataObject> getOriginalData() {
211 if (originalCache == null) {
212 originalCache = Collections.unmodifiableMap(toBinding(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 Objects.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<BindingDataChangeListener> {
254 private final ListenerRegistration<DOMDataChangeListener> registration;
256 public ListenerRegistrationImpl(final BindingDataChangeListener listener,
257 final ListenerRegistration<DOMDataChangeListener> registration) {
259 this.registration = registration;
263 protected void removeRegistration() {
264 registration.close();
269 public BindingIndependentConnector getConnector() {
270 return this.connector;
274 public ProviderSession getDomProviderContext() {
279 public void setConnector(final BindingIndependentConnector connector) {
280 this.connector = connector;
284 public void setDomProviderContext(final ProviderSession domProviderContext) {
285 this.context = domProviderContext;
289 public void startForwarding() {
294 public void close() throws Exception {
295 this.schemaListenerRegistration.close();