opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/AbstractForwardedDataBroker.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.md.sal.binding.impl;
   9
  10 import com.google.common.base.Objects;
  11 import com.google.common.base.Optional;
  12
  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;
  19 import java.util.Map;
  20 import java.util.Map.Entry;
  21 import java.util.Set;
  22
  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;
  46
  47 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker, SchemaContextListener, AutoCloseable {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
  50     // The Broker to whom we do all forwarding
  51     private final DOMDataBroker domDataBroker;
  52
  53     // Mapper to convert from Binding Independent objects to Binding Aware
  54     // objects
  55     private final BindingIndependentMappingService mappingService;
  56
  57     private final BindingToNormalizedNodeCodec codec;
  58     private BindingIndependentConnector connector;
  59     private ProviderSession context;
  60     private final ListenerRegistration<SchemaContextListener> schemaListenerRegistration;
  61
  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);
  68     }
  69
  70     protected BindingToNormalizedNodeCodec getCodec() {
  71         return codec;
  72     }
  73
  74     protected BindingIndependentMappingService getMappingService() {
  75         return mappingService;
  76     }
  77
  78     @Override
  79     public DOMDataBroker getDelegate() {
  80         return domDataBroker;
  81     }
  82
  83     @Override
  84     public void onGlobalContextUpdated(final SchemaContext ctx) {
  85         codec.onGlobalContextUpdated(ctx);
  86     }
  87
  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,
  92                 triggeringScope);
  93         YangInstanceIdentifier domPath = codec.toNormalized(path);
  94         ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
  95                 domPath, domDataChangeListener, triggeringScope);
  96         return new ListenerRegistrationImpl(listener, domRegistration);
  97     }
  98
  99     protected Map<InstanceIdentifier<?>, DataObject> toBinding(
 100             InstanceIdentifier<?> path,
 101             final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
 102         Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
 103
 104         for (Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : sortedEntries(normalized)) {
 105             try {
 106                 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
 107                         entry);
 108                 if (potential.isPresent()) {
 109                     Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
 110                     newMap.put(binding.getKey(), binding.getValue());
 111                 } else if (entry.getKey().getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 112                     DataObject bindingDataObject = getCodec().toBinding(path, entry.getValue());
 113                     if (bindingDataObject != null) {
 114                         newMap.put(path, bindingDataObject);
 115                     }
 116                 }
 117             } catch (DeserializationException e) {
 118                 LOG.warn("Failed to transform {}, omitting it", entry, e);
 119             }
 120         }
 121         return newMap;
 122     }
 123
 124     private static final Comparator<Entry<YangInstanceIdentifier, ?>> MAP_ENTRY_COMPARATOR = new Comparator<Entry<YangInstanceIdentifier, ?>>() {
 125         @Override
 126         public int compare(final Entry<YangInstanceIdentifier, ?> left,
 127                 final Entry<YangInstanceIdentifier, ?> right) {
 128             final Iterator<?> li = left.getKey().getPathArguments().iterator();
 129             final Iterator<?> ri = right.getKey().getPathArguments().iterator();
 130
 131             // Iterate until left is exhausted...
 132             while (li.hasNext()) {
 133                 if (!ri.hasNext()) {
 134                     // Left is deeper
 135                     return 1;
 136                 }
 137
 138                 li.next();
 139                 ri.next();
 140             }
 141
 142             // Check if right is exhausted
 143             return ri.hasNext() ? -1 : 0;
 144         }
 145     };
 146
 147     private static <T> Iterable<Entry<YangInstanceIdentifier,T>> sortedEntries(final Map<YangInstanceIdentifier, T> map) {
 148         if (!map.isEmpty()) {
 149             ArrayList<Entry<YangInstanceIdentifier, T>> entries = new ArrayList<>(map.entrySet());
 150             Collections.sort(entries, MAP_ENTRY_COMPARATOR);
 151             return entries;
 152         } else {
 153             return Collections.emptySet();
 154         }
 155     }
 156
 157     protected Set<InstanceIdentifier<?>> toBinding(InstanceIdentifier<?> path,
 158             final Set<YangInstanceIdentifier> normalized) {
 159         Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
 160         for (YangInstanceIdentifier normalizedPath : normalized) {
 161             try {
 162                 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
 163                 if (potential.isPresent()) {
 164                     InstanceIdentifier<? extends DataObject> binding = potential.get();
 165                     hashSet.add(binding);
 166                 } else if (normalizedPath.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 167                     hashSet.add(path);
 168                 }
 169             } catch (DeserializationException e) {
 170                 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
 171             }
 172         }
 173         return hashSet;
 174     }
 175
 176     protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
 177         if (path.isWildcarded()) {
 178             return Optional.absent();
 179         }
 180
 181         try {
 182             return Optional.fromNullable(getCodec().toBinding(path, data));
 183         } catch (DeserializationException e) {
 184             return Optional.absent();
 185         }
 186     }
 187
 188     private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
 189         private final DataChangeListener bindingDataChangeListener;
 190         private final LogicalDatastoreType store;
 191         private final InstanceIdentifier<?> path;
 192         private final DataChangeScope triggeringScope;
 193
 194         public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 195                 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 196             this.store = store;
 197             this.path = path;
 198             this.bindingDataChangeListener = bindingDataChangeListener;
 199             this.triggeringScope = triggeringScope;
 200         }
 201
 202         @Override
 203         public void onDataChanged(
 204                 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
 205             bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
 206         }
 207     }
 208
 209     private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
 210         private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
 211         private final InstanceIdentifier<?> path;
 212
 213         private Map<InstanceIdentifier<?>, DataObject> createdCache;
 214         private Map<InstanceIdentifier<?>, DataObject> updatedCache;
 215         private Map<InstanceIdentifier<?>, DataObject> originalCache;
 216         private Set<InstanceIdentifier<?>> removedCache;
 217         private Optional<DataObject> originalDataCache;
 218         private Optional<DataObject> updatedDataCache;
 219
 220         public TranslatedDataChangeEvent(
 221                 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 222                 final InstanceIdentifier<?> path) {
 223             this.domEvent = change;
 224             this.path = path;
 225         }
 226
 227         @Override
 228         public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
 229             if (createdCache == null) {
 230                 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
 231             }
 232             return createdCache;
 233         }
 234
 235         @Override
 236         public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
 237             if (updatedCache == null) {
 238                 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
 239             }
 240             return updatedCache;
 241
 242         }
 243
 244         @Override
 245         public Set<InstanceIdentifier<?>> getRemovedPaths() {
 246             if (removedCache == null) {
 247                 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
 248             }
 249             return removedCache;
 250         }
 251
 252         @Override
 253         public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
 254             if (originalCache == null) {
 255                 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
 256             }
 257             return originalCache;
 258
 259         }
 260
 261         @Override
 262         public DataObject getOriginalSubtree() {
 263             if (originalDataCache == null) {
 264                 if(domEvent.getOriginalSubtree() != null) {
 265                     originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
 266                 } else {
 267                     originalDataCache = Optional.absent();
 268                 }
 269             }
 270             return originalDataCache.orNull();
 271         }
 272
 273         @Override
 274         public DataObject getUpdatedSubtree() {
 275             if (updatedDataCache == null) {
 276                 if(domEvent.getUpdatedSubtree() != null) {
 277                     updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
 278                 } else {
 279                     updatedDataCache = Optional.absent();
 280                 }
 281             }
 282             return updatedDataCache.orNull();
 283         }
 284
 285         @Override
 286         public String toString() {
 287             return Objects.toStringHelper(TranslatedDataChangeEvent.class) //
 288                     .add("created", getCreatedData()) //
 289                     .add("updated", getUpdatedData()) //
 290                     .add("removed", getRemovedPaths()) //
 291                     .add("dom", domEvent) //
 292                     .toString();
 293         }
 294     }
 295
 296     private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
 297         private final ListenerRegistration<DOMDataChangeListener> registration;
 298
 299         public ListenerRegistrationImpl(final DataChangeListener listener,
 300                 final ListenerRegistration<DOMDataChangeListener> registration) {
 301             super(listener);
 302             this.registration = registration;
 303         }
 304
 305         @Override
 306         protected void removeRegistration() {
 307             registration.close();
 308         }
 309     }
 310
 311     @Override
 312     public BindingIndependentConnector getConnector() {
 313         return this.connector;
 314     }
 315
 316     @Override
 317     public ProviderSession getDomProviderContext() {
 318         return this.context;
 319     }
 320
 321     @Override
 322     public void setConnector(final BindingIndependentConnector connector) {
 323         this.connector = connector;
 324     }
 325
 326     @Override
 327     public void setDomProviderContext(final ProviderSession domProviderContext) {
 328         this.context = domProviderContext;
 329     }
 330
 331     @Override
 332     public void startForwarding() {
 333         // NOOP
 334     }
 335
 336     @Override
 337     public void close() throws Exception {
 338         this.schemaListenerRegistration.close();
 339     }
 340
 341 }