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(path, listener);
  75         }
  76         final YangInstanceIdentifier domPath = codec.toYangInstanceIdentifierBlocking(path);
  77         final ListenerRegistration<DOMDataChangeListener> domRegistration =
  78                 domDataBroker.registerDataChangeListener(store, domPath, domDataChangeListener, triggeringScope);
  79         return new ListenerRegistrationImpl(listener, domRegistration);
  80     }
  81
  82     protected Map<InstanceIdentifier<?>, DataObject> toBinding(final InstanceIdentifier<?> path,
  83             final Map<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized) {
  84         final Map<InstanceIdentifier<?>, DataObject> newMap = new HashMap<>();
  85
  86         for (final Map.Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> entry : normalized.entrySet()) {
  87             try {
  88                 final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> potential =
  89                         getCodec().toBinding(entry);
  90                 if (potential.isPresent()) {
  91                     final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = potential.get();
  92                     newMap.put(binding.getKey(), binding.getValue());
  93                 }
  94             } catch (final DeserializationException e) {
  95                 LOG.warn("Failed to transform {}, omitting it", entry, e);
  96             }
  97         }
  98         return newMap;
  99     }
 100
 101     protected Set<InstanceIdentifier<?>> toBinding(final InstanceIdentifier<?> path,
 102             final Set<YangInstanceIdentifier> normalized) {
 103         final Set<InstanceIdentifier<?>> hashSet = new HashSet<>();
 104         for (final YangInstanceIdentifier normalizedPath : normalized) {
 105             try {
 106                 final Optional<InstanceIdentifier<? extends DataObject>> potential =
 107                         getCodec().toBinding(normalizedPath);
 108                 if (potential.isPresent()) {
 109                     final InstanceIdentifier<? extends DataObject> binding = potential.get();
 110                     hashSet.add(binding);
 111                 } else if (normalizedPath.getLastPathArgument()
 112                         instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 113                     hashSet.add(path);
 114                 }
 115             } catch (final DeserializationException e) {
 116                 LOG.warn("Failed to transform {}, omitting it", normalizedPath, e);
 117             }
 118         }
 119         return hashSet;
 120     }
 121
 122     protected Optional<DataObject> toBindingData(final InstanceIdentifier<?> path, final NormalizedNode<?, ?> data) {
 123         if (path.isWildcarded()) {
 124             return Optional.absent();
 125         }
 126         return (Optional<DataObject>) getCodec().deserializeFunction(path)
 127                 .apply(Optional.<NormalizedNode<?, ?>>of(data));
 128     }
 129
 130     private class TranslatingDataChangeInvoker implements DOMDataChangeListener {
 131         private final DataChangeListener bindingDataChangeListener;
 132         private final InstanceIdentifier<?> path;
 133
 134         TranslatingDataChangeInvoker(final InstanceIdentifier<?> path,
 135                 final DataChangeListener bindingDataChangeListener) {
 136             this.path = path;
 137             this.bindingDataChangeListener = bindingDataChangeListener;
 138         }
 139
 140         @Override
 141         public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
 142             bindingDataChangeListener.onDataChanged(new TranslatedDataChangeEvent(change, path));
 143         }
 144
 145         @Override
 146         public String toString() {
 147             return bindingDataChangeListener.getClass().getName();
 148         }
 149     }
 150
 151     /**
 152      * Translator for ClusteredDataChangeListener.
 153      */
 154     private class TranslatingClusteredDataChangeInvoker extends TranslatingDataChangeInvoker implements
 155         ClusteredDOMDataChangeListener {
 156
 157         TranslatingClusteredDataChangeInvoker(final LogicalDatastoreType store, final InstanceIdentifier<?> path,
 158                 final DataChangeListener bindingDataChangeListener, final DataChangeScope triggeringScope) {
 159             super(path, bindingDataChangeListener);
 160         }
 161     }
 162
 163     private class TranslatedDataChangeEvent implements AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> {
 164         private final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> domEvent;
 165         private final InstanceIdentifier<?> path;
 166
 167         private Map<InstanceIdentifier<?>, DataObject> createdCache;
 168         private Map<InstanceIdentifier<?>, DataObject> updatedCache;
 169         private Map<InstanceIdentifier<?>, DataObject> originalCache;
 170         private Set<InstanceIdentifier<?>> removedCache;
 171         private Optional<DataObject> originalDataCache;
 172         private Optional<DataObject> updatedDataCache;
 173
 174         TranslatedDataChangeEvent(
 175                 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 176                 final InstanceIdentifier<?> path) {
 177             this.domEvent = change;
 178             this.path = path;
 179         }
 180
 181         @Override
 182         public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
 183             if (createdCache == null) {
 184                 createdCache = Collections.unmodifiableMap(toBinding(path, domEvent.getCreatedData()));
 185             }
 186             return createdCache;
 187         }
 188
 189         @Override
 190         public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
 191             if (updatedCache == null) {
 192                 updatedCache = Collections.unmodifiableMap(toBinding(path, domEvent.getUpdatedData()));
 193             }
 194             return updatedCache;
 195
 196         }
 197
 198         @Override
 199         public Set<InstanceIdentifier<?>> getRemovedPaths() {
 200             if (removedCache == null) {
 201                 removedCache = Collections.unmodifiableSet(toBinding(path, domEvent.getRemovedPaths()));
 202             }
 203             return removedCache;
 204         }
 205
 206         @Override
 207         public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
 208             if (originalCache == null) {
 209                 originalCache = Collections.unmodifiableMap(toBinding(path, domEvent.getOriginalData()));
 210             }
 211             return originalCache;
 212
 213         }
 214
 215         @Override
 216         public DataObject getOriginalSubtree() {
 217             if (originalDataCache == null) {
 218                 if (domEvent.getOriginalSubtree() != null) {
 219                     originalDataCache = toBindingData(path, domEvent.getOriginalSubtree());
 220                 } else {
 221                     originalDataCache = Optional.absent();
 222                 }
 223             }
 224             return originalDataCache.orNull();
 225         }
 226
 227         @Override
 228         public DataObject getUpdatedSubtree() {
 229             if (updatedDataCache == null) {
 230                 if (domEvent.getUpdatedSubtree() != null) {
 231                     updatedDataCache = toBindingData(path, domEvent.getUpdatedSubtree());
 232                 } else {
 233                     updatedDataCache = Optional.absent();
 234                 }
 235             }
 236             return updatedDataCache.orNull();
 237         }
 238
 239         @Override
 240         public String toString() {
 241             return MoreObjects.toStringHelper(TranslatedDataChangeEvent.class) //
 242                     .add("created", getCreatedData()) //
 243                     .add("updated", getUpdatedData()) //
 244                     .add("removed", getRemovedPaths()) //
 245                     .add("dom", domEvent) //
 246                     .toString();
 247         }
 248     }
 249
 250     private static class ListenerRegistrationImpl extends AbstractListenerRegistration<DataChangeListener> {
 251         private final ListenerRegistration<DOMDataChangeListener> registration;
 252
 253         ListenerRegistrationImpl(final DataChangeListener listener,
 254                 final ListenerRegistration<DOMDataChangeListener> registration) {
 255             super(listener);
 256             this.registration = registration;
 257         }
 258
 259         @Override
 260         protected void removeRegistration() {
 261             registration.close();
 262         }
 263     }
 264
 265     @Override
 266     public void close() {
 267     }
 268 }