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