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 java.util.ArrayList;
  11 import java.util.Collections;
  12 import java.util.Comparator;
  13 import java.util.HashMap;
  14 import java.util.HashSet;
  15 import java.util.Map;
  16 import java.util.Map.Entry;
  17 import java.util.Set;
  18
  19 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  21 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  25 import org.opendaylight.controller.sal.binding.impl.connect.dom.BindingIndependentConnector;
  26 import org.opendaylight.controller.sal.binding.impl.forward.DomForwardedBroker;
  27 import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
  28 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  29 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
  30 import org.opendaylight.yangtools.concepts.Delegator;
  31 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  32 import org.opendaylight.yangtools.yang.binding.DataObject;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  35 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
  36 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  37 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  38 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 import com.google.common.base.Objects;
  43 import com.google.common.base.Optional;
  44 import com.google.common.collect.Iterables;
  45
  46 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker,
  47         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         org.opendaylight.yangtools.yang.data.api.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             final Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
 101         Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
 102
 103         for (Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : sortedEntries(normalized)) {
 104             try {
 105                 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
 106                         entry);
 107                 if (potential.isPresent()) {
 108                     Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
 109                     newMap.put(binding.getKey(), binding.getValue());
 110                 }
 111             } catch (DeserializationException e) {
 112                 LOG.warn("Failed to transform {}, omitting it", entry, e);
 113             }
 114         }
 115         return newMap;
 116     }
 117
 118     private static <T> Iterable<Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,T>> sortedEntries(final Map<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, T> map) {
 119         ArrayList<Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, T>> entries = new ArrayList<>(map.entrySet());
 120         Collections.sort(entries, new Comparator<Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, T>>() {
 121
 122             @Override
 123             public int compare(final Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, T> left,
 124                     final Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, T> right) {
 125                 int leftSize = Iterables.size(left.getKey().getPathArguments());
 126                 int rightSize = Iterables.size(right.getKey().getPathArguments());
 127                 return Integer.compare(leftSize, rightSize);
 128             }
 129         });
 130         return entries;
 131     }
 132
 133     protected Set<InstanceIdentifier<?>> toBinding(
 134             final Set<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> normalized) {
 135         Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
 136         for (org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier normalizedPath : normalized) {
 137             try {
 138                 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
 139                 if (potential.isPresent()) {
 140                     InstanceIdentifier<? extends DataObject> binding = potential.get();
 141                     hashSet.add(binding);
 142                 }
 143             } catch (DeserializationException e) {
 144                 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
 145             }
 146         }
 147         return hashSet;
 148     }
 149
 150     protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
 151         if (path.isWildcarded()) {
 152             return Optional.absent();
 153         }
 154
 155         try {
 156             return Optional.fromNullable(getCodec().toBinding(path, data));
 157         } catch (DeserializationException e) {
 158             return Optional.absent();
 159         }
 160     }
 161
 162     private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
 163         private final DataChangeListener bindingDataChangeListener;
 164         private final LogicalDatastoreType store;
 165         private final InstanceIdentifier<?> path;
 166         private final DataChangeScope triggeringScope;
 167
 168         public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 169                 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 170             this.store = store;
 171             this.path = path;
 172             this.bindingDataChangeListener = bindingDataChangeListener;
 173             this.triggeringScope = triggeringScope;
 174         }
 175
 176         @Override
 177         public void onDataChanged(
 178                 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.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<org.opendaylight.yangtools.yang.data.api.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<org.opendaylight.yangtools.yang.data.api.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(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(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(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(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 }