opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/LazyDataObjectModification.java

   1 /*
   2  * Copyright (c) 2015 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.Preconditions;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import java.util.Optional;
  16 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  17 import org.opendaylight.mdsal.binding.dom.adapter.BindingStructuralType;
  18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  19 import org.opendaylight.yangtools.yang.binding.Augmentation;
  20 import org.opendaylight.yangtools.yang.binding.ChildOf;
  21 import org.opendaylight.yangtools.yang.binding.DataObject;
  22 import org.opendaylight.yangtools.yang.binding.Identifiable;
  23 import org.opendaylight.yangtools.yang.binding.Identifier;
  24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  25 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  * Lazily translated {@link DataObjectModification} based on {@link DataTreeCandidateNode}.
  34  *
  35  * {@link LazyDataObjectModification} represents Data tree change event,
  36  * but whole tree is not translated or resolved eagerly, but only child nodes
  37  * which are directly accessed by user of data object modification.
  38  *
  39  * @param <T> Type of Binding Data Object
  40  */
  41 final class LazyDataObjectModification<T extends DataObject> implements DataObjectModification<T> {
  42
  43     private final static Logger LOG = LoggerFactory.getLogger(LazyDataObjectModification.class);
  44
  45     private final BindingCodecTreeNode<T> codec;
  46     private final DataTreeCandidateNode domData;
  47     private final PathArgument identifier;
  48
  49     private volatile Collection<DataObjectModification<? extends DataObject>> childNodesCache;
  50     private volatile ModificationType modificationType;
  51
  52     private LazyDataObjectModification(final BindingCodecTreeNode<T> codec, final DataTreeCandidateNode domData) {
  53         this.codec = Preconditions.checkNotNull(codec);
  54         this.domData = Preconditions.checkNotNull(domData);
  55         this.identifier = codec.deserializePathArgument(domData.getIdentifier());
  56     }
  57
  58     static <T extends DataObject> DataObjectModification<T> create(final BindingCodecTreeNode<T> codec,
  59             final DataTreeCandidateNode domData) {
  60         return new LazyDataObjectModification<>(codec,domData);
  61     }
  62
  63     private static Collection<DataObjectModification<? extends DataObject>> from(final BindingCodecTreeNode<?> parentCodec,
  64             final Collection<DataTreeCandidateNode> domChildNodes) {
  65         final List<DataObjectModification<? extends DataObject>> result = new ArrayList<>(domChildNodes.size());
  66         populateList(result, parentCodec, domChildNodes);
  67         return result;
  68     }
  69
  70     private static void populateList(final List<DataObjectModification<? extends DataObject>> result,
  71             final BindingCodecTreeNode<?> parentCodec, final Collection<DataTreeCandidateNode> domChildNodes) {
  72         for (final DataTreeCandidateNode domChildNode : domChildNodes) {
  73             final BindingStructuralType type = BindingStructuralType.from(domChildNode);
  74             if (type != BindingStructuralType.NOT_ADDRESSABLE) {
  75                 /*
  76                  *  Even if type is UNKNOWN, from perspective of BindingStructuralType
  77                  *  we try to load codec for it. We will use that type to further specify
  78                  *  debug log.
  79                  */
  80                 try {
  81                     final BindingCodecTreeNode<?> childCodec =
  82                             parentCodec.yangPathArgumentChild(domChildNode.getIdentifier());
  83                     populateList(result,type, childCodec, domChildNode);
  84                 } catch (final IllegalArgumentException e) {
  85                     if (type == BindingStructuralType.UNKNOWN) {
  86                         LOG.debug("Unable to deserialize unknown DOM node {}",domChildNode,e);
  87                     } else {
  88                         LOG.debug("Binding representation for DOM node {} was not found",domChildNode,e);
  89                     }
  90                 }
  91             }
  92         }
  93     }
  94
  95     private static void populateList(final List<DataObjectModification<? extends DataObject>> result,
  96             final BindingStructuralType type, final BindingCodecTreeNode<?> childCodec,
  97             final DataTreeCandidateNode domChildNode) {
  98         switch (type) {
  99             case INVISIBLE_LIST:
 100                 // We use parent codec intentionally.
 101                 populateListWithSingleCodec(result, childCodec, domChildNode.getChildNodes());
 102                 break;
 103             case INVISIBLE_CONTAINER:
 104                 populateList(result, childCodec, domChildNode.getChildNodes());
 105                 break;
 106             case UNKNOWN:
 107             case VISIBLE_CONTAINER:
 108                 result.add(create(childCodec, domChildNode));
 109             default:
 110                 break;
 111         }
 112     }
 113
 114     private static void populateListWithSingleCodec(final List<DataObjectModification<? extends DataObject>> result,
 115             final BindingCodecTreeNode<?> codec, final Collection<DataTreeCandidateNode> childNodes) {
 116         for (final DataTreeCandidateNode child : childNodes) {
 117             result.add(create(codec, child));
 118         }
 119     }
 120
 121     @Override
 122     public T getDataBefore() {
 123         return deserialize(domData.getDataBefore());
 124     }
 125
 126     @Override
 127     public T getDataAfter() {
 128         return deserialize(domData.getDataAfter());
 129     }
 130
 131     @Override
 132     public Class<T> getDataType() {
 133         return codec.getBindingClass();
 134     }
 135
 136     @Override
 137     public PathArgument getIdentifier() {
 138         return identifier;
 139     }
 140
 141     @Override
 142     public ModificationType getModificationType() {
 143         ModificationType localType = modificationType;
 144         if (localType != null) {
 145             return localType;
 146         }
 147
 148         switch (domData.getModificationType()) {
 149             case APPEARED:
 150             case WRITE:
 151                 localType = ModificationType.WRITE;
 152                 break;
 153             case DISAPPEARED:
 154             case DELETE:
 155                 localType = ModificationType.DELETE;
 156                 break;
 157             case SUBTREE_MODIFIED:
 158                 localType = resolveSubtreeModificationType();
 159                 break;
 160             default:
 161                 // TODO: Should we lie about modification type instead of exception?
 162                 throw new IllegalStateException("Unsupported DOM Modification type " + domData.getModificationType());
 163         }
 164
 165         modificationType = localType;
 166         return localType;
 167     }
 168
 169     private ModificationType resolveSubtreeModificationType() {
 170         switch (codec.getChildAddressabilitySummary()) {
 171             case ADDRESSABLE:
 172                 // All children are addressable, it is safe to report SUBTREE_MODIFIED
 173                 return ModificationType.SUBTREE_MODIFIED;
 174             case UNADDRESSABLE:
 175                 // All children are non-addressable, report WRITE
 176                 return ModificationType.WRITE;
 177             case MIXED:
 178                 // This case is not completely trivial, as we may have NOT_ADDRESSABLE nodes underneath us. If that
 179                 // is the case, we need to turn this modification into a WRITE operation, so that the user is able
 180                 // to observe those nodes being introduced. This is not efficient, but unfortunately unavoidable,
 181                 // as we cannot accurately represent such changes.
 182                 for (DataTreeCandidateNode child : domData.getChildNodes()) {
 183                     if (BindingStructuralType.recursiveFrom(child) == BindingStructuralType.NOT_ADDRESSABLE) {
 184                         // We have a non-addressable child, turn this modification into a write
 185                         return ModificationType.WRITE;
 186                     }
 187                 }
 188
 189                 // No unaddressable children found, proceed in addressed mode
 190                 return ModificationType.SUBTREE_MODIFIED;
 191             default:
 192                 throw new IllegalStateException("Unsupported child addressability summary "
 193                         + codec.getChildAddressabilitySummary());
 194         }
 195     }
 196
 197     @Override
 198     public Collection<DataObjectModification<? extends DataObject>> getModifiedChildren() {
 199         Collection<DataObjectModification<? extends DataObject>> local = childNodesCache;
 200         if (local == null) {
 201             childNodesCache = local = from(codec, domData.getChildNodes());
 202         }
 203         return local;
 204     }
 205
 206     @Override
 207     public DataObjectModification<? extends DataObject> getModifiedChild(final PathArgument arg) {
 208         final List<YangInstanceIdentifier.PathArgument> domArgumentList = new ArrayList<>();
 209         final BindingCodecTreeNode<?> childCodec = codec.bindingPathArgumentChild(arg, domArgumentList);
 210         final Iterator<YangInstanceIdentifier.PathArgument> toEnter = domArgumentList.iterator();
 211         DataTreeCandidateNode current = domData;
 212         while (toEnter.hasNext() && current != null) {
 213             current = current.getModifiedChild(toEnter.next());
 214         }
 215         if (current != null) {
 216             return create(childCodec, current);
 217         }
 218         return null;
 219     }
 220
 221     @Override
 222     @SuppressWarnings("unchecked")
 223     public <C extends Identifiable<K> & ChildOf<? super T>, K extends Identifier<C>> DataObjectModification<C> getModifiedChildListItem(
 224             final Class<C> listItem, final K listKey) {
 225         return (DataObjectModification<C>) getModifiedChild(new InstanceIdentifier.IdentifiableItem<>(listItem, listKey));
 226     }
 227
 228     @Override
 229     @SuppressWarnings("unchecked")
 230     public <C extends ChildOf<? super T>> DataObjectModification<C> getModifiedChildContainer(final Class<C> arg) {
 231         return (DataObjectModification<C>) getModifiedChild(new InstanceIdentifier.Item<>(arg));
 232     }
 233
 234     @Override
 235     @SuppressWarnings("unchecked")
 236     public <C extends Augmentation<T> & DataObject> DataObjectModification<C> getModifiedAugmentation(
 237             final Class<C> augmentation) {
 238         return (DataObjectModification<C>) getModifiedChild(new InstanceIdentifier.Item<>(augmentation));
 239     }
 240
 241     private T deserialize(final Optional<NormalizedNode<?, ?>> dataAfter) {
 242         if (dataAfter.isPresent()) {
 243             return codec.deserialize(dataAfter.get());
 244         }
 245         return null;
 246     }
 247
 248     @Override
 249     public String toString() {
 250         return getClass().getSimpleName() + "{identifier = " + identifier + ", domData = " + domData + "}";
 251     }
 252 }