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 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;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20 import java.util.Set;
  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;
  43
  44 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker,
  45         SchemaContextListener, AutoCloseable {
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
  48     // The Broker to whom we do all forwarding
  49     private final DOMDataBroker domDataBroker;
  50
  51     private final BindingToNormalizedNodeCodec codec;
  52     private BindingIndependentConnector connector;
  53     private ProviderSession context;
  54     private final ListenerRegistration<SchemaContextListener> schemaListenerRegistration;
  55
  56     protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec,
  57             final SchemaService schemaService) {
  58         this.domDataBroker = domDataBroker;
  59         this.codec = codec;
  60         this.schemaListenerRegistration = schemaService.registerSchemaContextListener(this);
  61     }
  62
  63     protected BindingToNormalizedNodeCodec getCodec() {
  64         return codec;
  65     }
  66
  67     @Override
  68     public DOMDataBroker getDelegate() {
  69         return domDataBroker;
  70     }
  71
  72     @Override
  73     public void onGlobalContextUpdated(final SchemaContext ctx) {
  74         // NOOP
  75     }
  76
  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,
  80                 triggeringScope);
  81         YangInstanceIdentifier domPath = codec.toNormalized(path);
  82         ListenerRegistration<DOMDataChangeListener> domRegistration = domDataBroker.registerDataChangeListener(store,
  83                 domPath, domDataChangeListener, triggeringScope);
  84         return new ListenerRegistrationImpl(listener, domRegistration);
  85     }
  86
  87     protected Map<InstanceIdentifier<?>, DataObject> toBinding(final InstanceIdentifier<?> path,
  88             final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
  89         Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
  90
  91         for (Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : sortedEntries(normalized)) {
  92             try {
  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());
  97                 }
  98             } catch (DeserializationException e) {
  99                 LOG.warn("Failed to transform {}, omitting it", entry, e);
 100             }
 101         }
 102         return newMap;
 103     }
 104
 105     private static final Comparator<Entry<YangInstanceIdentifier, ?>> MAP_ENTRY_COMPARATOR = new Comparator<Entry<YangInstanceIdentifier, ?>>() {
 106         @Override
 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();
 110
 111             // Iterate until left is exhausted...
 112             while (li.hasNext()) {
 113                 if (!ri.hasNext()) {
 114                     // Left is deeper
 115                     return 1;
 116                 }
 117
 118                 li.next();
 119                 ri.next();
 120             }
 121
 122             // Check if right is exhausted
 123             return ri.hasNext() ? -1 : 0;
 124         }
 125     };
 126
 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);
 131             return entries;
 132         } else {
 133             return Collections.emptySet();
 134         }
 135     }
 136
 137     protected Set<InstanceIdentifier<?>> toBinding(final InstanceIdentifier<?> path,
 138             final Set<YangInstanceIdentifier> normalized) {
 139         Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
 140         for (YangInstanceIdentifier normalizedPath : normalized) {
 141             try {
 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) {
 147                     hashSet.add(path);
 148                 }
 149             } catch (DeserializationException e) {
 150                 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
 151             }
 152         }
 153         return hashSet;
 154     }
 155
 156     protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
 157         if (path.isWildcarded()) {
 158             return Optional.absent();
 159         }
 160         return (Optional) getCodec().deserializeFunction(path).apply(Optional.<NormalizedNode<?, ?>> of(data));
 161     }
 162
 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;
 168
 169         public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 170                 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 171             this.store = store;
 172             this.path = path;
 173             this.bindingDataChangeListener = bindingDataChangeListener;
 174             this.triggeringScope = triggeringScope;
 175         }
 176
 177         @Override
 178         public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
 179             bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
 180         }
 181     }
 182
 183     private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
 184         private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
 185         private final InstanceIdentifier<?> path;
 186
 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;
 193
 194         public TranslatedDataChangeEvent(
 195                 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 196                 final InstanceIdentifier<?> path) {
 197             this.domEvent = change;
 198             this.path = path;
 199         }
 200
 201         @Override
 202         public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
 203             if (createdCache == null) {
 204                 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
 205             }
 206             return createdCache;
 207         }
 208
 209         @Override
 210         public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
 211             if (updatedCache == null) {
 212                 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
 213             }
 214             return updatedCache;
 215
 216         }
 217
 218         @Override
 219         public Set<InstanceIdentifier<?>> getRemovedPaths() {
 220             if (removedCache == null) {
 221                 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
 222             }
 223             return removedCache;
 224         }
 225
 226         @Override
 227         public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
 228             if (originalCache == null) {
 229                 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
 230             }
 231             return originalCache;
 232
 233         }
 234
 235         @Override
 236         public DataObject getOriginalSubtree() {
 237             if (originalDataCache == null) {
 238                 if (domEvent.getOriginalSubtree() != null) {
 239                     originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
 240                 } else {
 241                     originalDataCache = Optional.absent();
 242                 }
 243             }
 244             return originalDataCache.orNull();
 245         }
 246
 247         @Override
 248         public DataObject getUpdatedSubtree() {
 249             if (updatedDataCache == null) {
 250                 if (domEvent.getUpdatedSubtree() != null) {
 251                     updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
 252                 } else {
 253                     updatedDataCache = Optional.absent();
 254                 }
 255             }
 256             return updatedDataCache.orNull();
 257         }
 258
 259         @Override
 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) //
 266                     .toString();
 267         }
 268     }
 269
 270     private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
 271         private final ListenerRegistration<DOMDataChangeListener> registration;
 272
 273         public ListenerRegistrationImpl(final DataChangeListener listener,
 274                 final ListenerRegistration<DOMDataChangeListener> registration) {
 275             super(listener);
 276             this.registration = registration;
 277         }
 278
 279         @Override
 280         protected void removeRegistration() {
 281             registration.close();
 282         }
 283     }
 284
 285     @Override
 286     public BindingIndependentConnector getConnector() {
 287         return this.connector;
 288     }
 289
 290     @Override
 291     public ProviderSession getDomProviderContext() {
 292         return this.context;
 293     }
 294
 295     @Override
 296     public void setConnector(final BindingIndependentConnector connector) {
 297         this.connector = connector;
 298     }
 299
 300     @Override
 301     public void setDomProviderContext(final ProviderSession domProviderContext) {
 302         this.context = domProviderContext;
 303     }
 304
 305     @Override
 306     public void startForwarding() {
 307         // NOOP
 308     }
 309
 310     @Override
 311     public void close() throws Exception {
 312         this.schemaListenerRegistration.close();
 313     }
 314
 315 }