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.Collections;
  11 import java.util.HashMap;
  12 import java.util.HashSet;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15 import java.util.Set;
  16
  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;
  38
  39 import com.google.common.base.Objects;
  40 import com.google.common.base.Optional;
  41
  42 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, DomForwardedBroker,
  43         SchemaContextListener {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
  46     // The Broker to whom we do all forwarding
  47     private final DOMDataBroker domDataBroker;
  48
  49     // Mapper to convert from Binding Independent objects to Binding Aware
  50     // objects
  51     private final BindingIndependentMappingService mappingService;
  52
  53     private final BindingToNormalizedNodeCodec codec;
  54     private BindingIndependentConnector connector;
  55     private ProviderSession context;
  56
  57     protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker,
  58             final BindingIndependentMappingService mappingService) {
  59         this.domDataBroker = domDataBroker;
  60         this.mappingService = mappingService;
  61         this.codec = new BindingToNormalizedNodeCodec(mappingService);
  62     }
  63
  64     protected BindingToNormalizedNodeCodec getCodec() {
  65         return codec;
  66     }
  67
  68     protected BindingIndependentMappingService getMappingService() {
  69         return mappingService;
  70     }
  71
  72     @Override
  73     public DOMDataBroker getDelegate() {
  74         return domDataBroker;
  75     }
  76
  77     @Override
  78     public void onGlobalContextUpdated(final SchemaContext ctx) {
  79         codec.onGlobalContextUpdated(ctx);
  80     }
  81
  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,
  86                 triggeringScope);
  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);
  91     }
  92
  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
  97                 .entrySet()) {
  98             try {
  99                 Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential = getCodec().toBinding(
 100                         entry);
 101                 if (potential.isPresent()) {
 102                     Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
 103                     newMap.put(binding.getKey(), binding.getValue());
 104                 }
 105             } catch (DeserializationException e) {
 106                 LOG.warn("Failed to transform {}, omitting it", entry, e);
 107             }
 108         }
 109         return newMap;
 110     }
 111
 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) {
 116             try {
 117                 Optional<InstanceIdentifier<? extends DataObject>> potential = getCodec().toBinding(normalizedPath);
 118                 if (potential.isPresent()) {
 119                     InstanceIdentifier<? extends DataObject> binding = potential.get();
 120                     hashSet.add(binding);
 121                 }
 122             } catch (DeserializationException e) {
 123                 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
 124             }
 125         }
 126         return hashSet;
 127     }
 128
 129     protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
 130         if (path.isWildcarded()) {
 131             return Optional.absent();
 132         }
 133
 134         try {
 135             return Optional.fromNullable(getCodec().toBinding(path, data));
 136         } catch (DeserializationException e) {
 137             return Optional.absent();
 138         }
 139     }
 140
 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;
 146
 147         public TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 148                 final BindingDataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 149             this.store = store;
 150             this.path = path;
 151             this.bindingDataChangeListener = bindingDataChangeListener;
 152             this.triggeringScope = triggeringScope;
 153         }
 154
 155         @Override
 156         public void onDataChanged(
 157                 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> change) {
 158             bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
 159         }
 160     }
 161
 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;
 165
 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;
 172
 173         public TranslatedDataChangeEvent(
 174                 final AsyncDataChangeEvent<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>> change,
 175                 final InstanceIdentifier<?> path) {
 176             this.domEvent = change;
 177             this.path = path;
 178         }
 179
 180         @Override
 181         public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
 182             if (createdCache == null) {
 183                 createdCache = Collections.unmodifiableMap(toBinding(domEvent.getCreatedData()));
 184             }
 185             return createdCache;
 186         }
 187
 188         @Override
 189         public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
 190             if (updatedCache == null) {
 191                 updatedCache = Collections.unmodifiableMap(toBinding(domEvent.getUpdatedData()));
 192             }
 193             return updatedCache;
 194
 195         }
 196
 197         @Override
 198         public Set<InstanceIdentifier<?>> getRemovedPaths() {
 199             if (removedCache == null) {
 200                 removedCache = Collections.unmodifiableSet(toBinding(domEvent.getRemovedPaths()));
 201             }
 202             return removedCache;
 203         }
 204
 205         @Override
 206         public Map<InstanceIdentifier<?>, ? extends DataObject> getOriginalData() {
 207             if (originalCache == null) {
 208                 originalCache = Collections.unmodifiableMap(toBinding(domEvent.getOriginalData()));
 209             }
 210             return originalCache;
 211
 212         }
 213
 214         @Override
 215         public DataObject getOriginalSubtree() {
 216             if (originalDataCache == null) {
 217                 if(domEvent.getOriginalSubtree() != null) {
 218                     originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
 219                 } else {
 220                     originalDataCache = Optional.absent();
 221                 }
 222             }
 223             return originalDataCache.orNull();
 224         }
 225
 226         @Override
 227         public DataObject getUpdatedSubtree() {
 228             if (updatedDataCache == null) {
 229                 if(domEvent.getUpdatedSubtree() != null) {
 230                     updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
 231                 } else {
 232                     updatedDataCache = Optional.absent();
 233                 }
 234             }
 235             return updatedDataCache.orNull();
 236         }
 237
 238         @Override
 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) //
 245                     .toString();
 246         }
 247     }
 248
 249     private static class ListenerRegistrationImpl extends AbstractListenerRegistration<BindingDataChangeListener> {
 250         private final ListenerRegistration<DOMDataChangeListener> registration;
 251
 252         public ListenerRegistrationImpl(final BindingDataChangeListener listener,
 253                 final ListenerRegistration<DOMDataChangeListener> registration) {
 254             super(listener);
 255             this.registration = registration;
 256         }
 257
 258         @Override
 259         protected void removeRegistration() {
 260             registration.close();
 261         }
 262     }
 263
 264     @Override
 265     public BindingIndependentConnector getConnector() {
 266         return this.connector;
 267     }
 268
 269     @Override
 270     public ProviderSession getDomProviderContext() {
 271         return this.context;
 272     }
 273
 274     @Override
 275     public void setConnector(final BindingIndependentConnector connector) {
 276         this.connector = connector;
 277     }
 278
 279     @Override
 280     public void setDomProviderContext(final ProviderSession domProviderContext) {
 281         this.context = domProviderContext;
 282     }
 283
 284     @Override
 285     public void startForwarding() {
 286         // NOOP
 287     }
 288
 289 }