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.yangtools.concepts.AbstractListenerRegistration;
27 import org.opendaylight.yangtools.concepts.Delegator;
28 import org.opendaylight.yangtools.concepts.ListenerRegistration;
29 import org.opendaylight.yangtools.yang.binding.DataObject;
30 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
33 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
35 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 import com.google.common.base.Objects;
40 import com.google.common.base.Optional;
42 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker,
43 SchemaContextListener {
45 private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
46 // The Broker to whom we do all forwarding
47 private final DOMDataBroker domDataBroker;
49 // Mapper to convert from Binding Independent objects to Binding Aware
51 private final BindingIndependentMappingService mappingService;
53 private final BindingToNormalizedNodeCodec codec;
54 private BindingIndependentConnector connector;
55 private ProviderSession context;
57 protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker,
58 final BindingIndependentMappingService mappingService) {
59 this.domDataBroker = domDataBroker;
60 this.mappingService = mappingService;
61 this.codec = new BindingToNormalizedNodeCodec(mappingService);
64 protected BindingToNormalizedNodeCodec getCodec() {
68 protected BindingIndependentMappingService getMappingService() {
69 return mappingService;
73 public DOMDataBroker getDelegate() {
78 public void onGlobalContextUpdated(final SchemaContext ctx) {
79 codec.onGlobalContextUpdated(ctx);
82 public ListenerRegistration<BindingDataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
83 final InstanceIdentifier<?> path, final BindingDataChangeListener listener,
84 final DataChangeScope triggeringScope) {
85 DOMDataChangeListener domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
87 org.opendaylight.yangtools.yang.data.api.InstanceIdentifier domPath = codec.toNormalized(path);
88 ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
89 domPath, domDataChangeListener, triggeringScope);
90 return new ListenerRegistrationImpl(listener, domRegistration);
93 protected Map<InstanceIdentifier<?>, DataObject> toBinding(
94 final Map<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
95 Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
96 for (Map.Entry<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : normalized
99 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
101 if (potential.isPresent()) {
102 Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
103 newMap.put(binding.getKey(), binding.getValue());
105 } catch (DeserializationException e) {
106 LOG.warn("Failed to transform {}, omitting it", entry, e);
112 protected Set<InstanceIdentifier<?>> toBinding(
113 final Set<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier> normalized) {
114 Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
115 for (org.opendaylight.yangtools.yang.data.api.InstanceIdentifier normalizedPath : normalized) {
117 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
118 if (potential.isPresent()) {
119 InstanceIdentifier<? extends DataObject> binding = potential.get();
120 hashSet.add(binding);
122 } catch (DeserializationException e) {
123 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
129 protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
130 if (path.isWildcarded()) {
131 return Optional.absent();
135 return Optional.fromNullable(getCodec().toBinding(path, data));
136 } catch (DeserializationException e) {
137 return Optional.absent();
141 private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
142 private final BindingDataChangeListener bindingDataChangeListener;
143 private final LogicalDatastoreType store;
144 private final InstanceIdentifier<?> path;
145 private final DataChangeScope triggeringScope;
147 public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
148 final BindingDataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
151 this.bindingDataChangeListener = bindingDataChangeListener;
152 this.triggeringScope = triggeringScope;
156 public void onDataChanged(
157 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> change) {
158 bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
162 private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
163 private final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> domEvent;
164 private final InstanceIdentifier<?> path;
166 private Map<InstanceIdentifier<?>, DataObject> createdCache;
167 private Map<InstanceIdentifier<?>, DataObject> updatedCache;
168 private Map<InstanceIdentifier<?>, ? extends DataObject> originalCache;
169 private Set<InstanceIdentifier<?>> removedCache;
170 private Optional<DataObject> originalDataCache;
171 private Optional<DataObject> updatedDataCache;
173 public TranslatedDataChangeEvent(
174 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> change,
175 final InstanceIdentifier<?> path) {
176 this.domEvent = change;
181 public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
182 if (createdCache == null) {
183 createdCache = Collections.unmodifiableMap(toBinding(domEvent.getCreatedData()));
189 public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
190 if (updatedCache == null) {
191 updatedCache = Collections.unmodifiableMap(toBinding(domEvent.getUpdatedData()));
198 public Set<InstanceIdentifier<?>> getRemovedPaths() {
199 if (removedCache == null) {
200 removedCache = Collections.unmodifiableSet(toBinding(domEvent.getRemovedPaths()));
206 public Map<InstanceIdentifier<?>, ? extends DataObject> getOriginalData() {
207 if (originalCache == null) {
208 originalCache = Collections.unmodifiableMap(toBinding(domEvent.getOriginalData()));
210 return originalCache;
215 public DataObject getOriginalSubtree() {
216 if (originalDataCache == null) {
217 if(domEvent.getOriginalSubtree() != null) {
218 originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
220 originalDataCache = Optional.absent();
223 return originalDataCache.orNull();
227 public DataObject getUpdatedSubtree() {
228 if (updatedDataCache == null) {
229 if(domEvent.getUpdatedSubtree() != null) {
230 updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
232 updatedDataCache = Optional.absent();
235 return updatedDataCache.orNull();
239 public String toString() {
240 return Objects.toStringHelper(TranslatedDataChangeEvent.class) //
241 .add("created", getCreatedData()) //
242 .add("updated", getUpdatedData()) //
243 .add("removed", getRemovedPaths()) //
244 .add("dom", domEvent) //
249 private static class ListenerRegistrationImpl extends AbstractListenerRegistration<BindingDataChangeListener> {
250 private final ListenerRegistration<DOMDataChangeListener> registration;
252 public ListenerRegistrationImpl(final BindingDataChangeListener listener,
253 final ListenerRegistration<DOMDataChangeListener> registration) {
255 this.registration = registration;
259 protected void removeRegistration() {
260 registration.close();
265 public BindingIndependentConnector getConnector() {
266 return this.connector;
270 public ProviderSession getDomProviderContext() {
275 public void setConnector(final BindingIndependentConnector connector) {
276 this.connector = connector;
280 public void setDomProviderContext(final ProviderSession domProviderContext) {
281 this.context = domProviderContext;
285 public void startForwarding() {