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.MoreObjects;
  11 import com.google.common.base.Optional;
  12 import java.util.Collections;
  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 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataChangeListener;
  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.ClusteredDOMDataChangeListener;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  26 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  27 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
  28 import org.opendaylight.yangtools.concepts.Delegator;
  29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  30 import org.opendaylight.yangtools.yang.binding.DataObject;
  31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  34 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 public abstract class AbstractForwardedDataBroker implements Delegator<DOMDataBroker>, AutoCloseable {
  39
  40     private static final Logger LOG = LoggerFactory.getLogger(AbstractForwardedDataBroker.class);
  41     // The Broker to whom we do all forwarding
  42     private final DOMDataBroker domDataBroker;
  43
  44     private final BindingToNormalizedNodeCodec codec;
  45
  46     protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec,
  47             final DOMSchemaService schemaService) {
  48         this.domDataBroker = domDataBroker;
  49         this.codec = codec;
  50     }
  51
  52     protected AbstractForwardedDataBroker(final DOMDataBroker domDataBroker, final BindingToNormalizedNodeCodec codec) {
  53         this.domDataBroker = domDataBroker;
  54         this.codec = codec;
  55     }
  56
  57     protected BindingToNormalizedNodeCodec getCodec() {
  58         return codec;
  59     }
  60
  61     @Override
  62     public DOMDataBroker getDelegate() {
  63         return domDataBroker;
  64     }
  65
  66     public ListenerRegistration<DataChangeListener> registerDataChangeListener(final LogicalDatastoreType store,
  67             final InstanceIdentifier<?> path, final DataChangeListener listener,
  68             final DataChangeScope triggeringScope) {
  69         final DOMDataChangeListener domDataChangeListener;
  70
  71         if (listener instanceof ClusteredDataChangeListener) {
  72             domDataChangeListener = new TranslatingClusteredDataChangeInvoker(store, path, listener, triggeringScope);
  73         } else {
  74             domDataChangeListener = new TranslatingDataChangeInvoker(store, path, listener,
  75                 triggeringScope);
  76         }
  77         final YangInstanceIdentifier domPath = codec.toYangInstanceIdentifierBlocking(path);
  78         final ListenerRegistration<DOMDataChangeListener> domRegistration =
  79                 domDataBroker.registerDataChangeListener(store, domPath, domDataChangeListener, triggeringScope);
  80         return new ListenerRegistrationImpl(listener, domRegistration);
  81     }
  82
  83     protected Map<InstanceIdentifier<?>, DataObject> toBinding(final InstanceIdentifier<?> path,
  84             final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
  85         final Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
  86
  87         for (final Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : normalized.entrySet()) {
  88             try {
  89                 final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential =
  90                         getCodec().toBinding(entry);
  91                 if (potential.isPresent()) {
  92                     final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
  93                     newMap.put(binding.getKey(), binding.getValue());
  94                 }
  95             } catch (final DeserializationException e) {
  96                 LOG.warn("Failed to transform {}, omitting it", entry, e);
  97             }
  98         }
  99         return newMap;
 100     }
 101
 102     protected Set<InstanceIdentifier<?>> toBinding(final InstanceIdentifier<?> path,
 103             final Set<YangInstanceIdentifier> normalized) {
 104         final Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
 105         for (final YangInstanceIdentifier normalizedPath : normalized) {
 106             try {
 107                 final Optional<InstanceIdentifier<? extends DataObject>> potential =
 108                         getCodec().toBinding(normalizedPath);
 109                 if (potential.isPresent()) {
 110                     final InstanceIdentifier<? extends DataObject> binding = potential.get();
 111                     hashSet.add(binding);
 112                 } else if (normalizedPath.getLastPathArgument()
 113                         instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 114                     hashSet.add(path);
 115                 }
 116             } catch (final DeserializationException e) {
 117                 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
 118             }
 119         }
 120         return hashSet;
 121     }
 122
 123     protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
 124         if (path.isWildcarded()) {
 125             return Optional.absent();
 126         }
 127         return (Optional<DataObject>) getCodec().deserializeFunction(path)
 128                 .apply(Optional.<NormalizedNode<?, ?>>of(data));
 129     }
 130
 131     private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
 132         private final DataChangeListener bindingDataChangeListener;
 133         private final LogicalDatastoreType store;
 134         private final InstanceIdentifier<?> path;
 135         private final DataChangeScope triggeringScope;
 136
 137         TranslatingDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 138                 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 139             this.store = store;
 140             this.path = path;
 141             this.bindingDataChangeListener = bindingDataChangeListener;
 142             this.triggeringScope = triggeringScope;
 143         }
 144
 145         @Override
 146         public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
 147             bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
 148         }
 149
 150         @Override
 151         public String toString() {
 152             return bindingDataChangeListener.getClass().getName();
 153         }
 154     }
 155
 156     /**
 157      * Translator for ClusteredDataChangeListener.
 158      */
 159     private class TranslatingClusteredDataChangeInvoker extends TranslatingDataChangeInvoker implements
 160         ClusteredDOMDataChangeListener {
 161
 162         TranslatingClusteredDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 163                 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 164             super(store, path, bindingDataChangeListener, triggeringScope);
 165         }
 166     }
 167
 168     private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
 169         private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
 170         private final InstanceIdentifier<?> path;
 171
 172         private Map<InstanceIdentifier<?>, DataObject> createdCache;
 173         private Map<InstanceIdentifier<?>, DataObject> updatedCache;
 174         private Map<InstanceIdentifier<?>, DataObject> originalCache;
 175         private Set<InstanceIdentifier<?>> removedCache;
 176         private Optional<DataObject> originalDataCache;
 177         private Optional<DataObject> updatedDataCache;
 178
 179         TranslatedDataChangeEvent(
 180                 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 181                 final InstanceIdentifier<?> path) {
 182             this.domEvent = change;
 183             this.path = path;
 184         }
 185
 186         @Override
 187         public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
 188             if (createdCache == null) {
 189                 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
 190             }
 191             return createdCache;
 192         }
 193
 194         @Override
 195         public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
 196             if (updatedCache == null) {
 197                 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
 198             }
 199             return updatedCache;
 200
 201         }
 202
 203         @Override
 204         public Set<InstanceIdentifier<?>> getRemovedPaths() {
 205             if (removedCache == null) {
 206                 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
 207             }
 208             return removedCache;
 209         }
 210
 211         @Override
 212         public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
 213             if (originalCache == null) {
 214                 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
 215             }
 216             return originalCache;
 217
 218         }
 219
 220         @Override
 221         public DataObject getOriginalSubtree() {
 222             if (originalDataCache == null) {
 223                 if (domEvent.getOriginalSubtree() != null) {
 224                     originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
 225                 } else {
 226                     originalDataCache = Optional.absent();
 227                 }
 228             }
 229             return originalDataCache.orNull();
 230         }
 231
 232         @Override
 233         public DataObject getUpdatedSubtree() {
 234             if (updatedDataCache == null) {
 235                 if (domEvent.getUpdatedSubtree() != null) {
 236                     updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
 237                 } else {
 238                     updatedDataCache = Optional.absent();
 239                 }
 240             }
 241             return updatedDataCache.orNull();
 242         }
 243
 244         @Override
 245         public String toString() {
 246             return MoreObjects.toStringHelper(TranslatedDataChangeEvent.class) //
 247                     .add("created", getCreatedData()) //
 248                     .add("updated", getUpdatedData()) //
 249                     .add("removed", getRemovedPaths()) //
 250                     .add("dom", domEvent) //
 251                     .toString();
 252         }
 253     }
 254
 255     private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
 256         private final ListenerRegistration<DOMDataChangeListener> registration;
 257
 258         ListenerRegistrationImpl(final DataChangeListener listener,
 259                 final ListenerRegistration<DOMDataChangeListener> registration) {
 260             super(listener);
 261             this.registration = registration;
 262         }
 263
 264         @Override
 265         protected void removeRegistration() {
 266             registration.close();
 267         }
 268     }
 269
 270     @Override
 271     public void close() {
 272     }
 273 }