yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/NormalizedNodeContainerModificationStrategy.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.yangtools.yang.data.impl.schema.tree;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import java.util.Map;
  13
  14 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  15 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeWithValue;
  18 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  19 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  23 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  27 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
  28 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.MutableTreeNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
  31 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  39 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  40 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  41 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  44
  45 import com.google.common.base.Optional;
  46 import com.google.common.collect.ImmutableMap;
  47 import com.google.common.collect.Iterables;
  48
  49 abstract class NormalizedNodeContainerModificationStrategy extends SchemaAwareApplyOperation {
  50
  51     private final Class<? extends NormalizedNode<?, ?>> nodeClass;
  52
  53     protected NormalizedNodeContainerModificationStrategy(final Class<? extends NormalizedNode<?, ?>> nodeClass) {
  54         this.nodeClass = nodeClass;
  55     }
  56
  57     @Override
  58     public void verifyStructure(final ModifiedNode modification) throws IllegalArgumentException {
  59         if (modification.getType() == ModificationType.WRITE) {
  60
  61         }
  62         for (ModifiedNode childModification : modification.getChildren()) {
  63             resolveChildOperation(childModification.getIdentifier()).verifyStructure(childModification);
  64         }
  65     }
  66
  67     @Override
  68     protected void checkWriteApplicable(final InstanceIdentifier path, final NodeModification modification,
  69             final Optional<TreeNode> current) throws DataValidationFailedException {
  70         // FIXME: Implement proper write check for replacement of node container
  71         //        prerequisite is to have transaction chain available for clients
  72         //        otherwise this will break chained writes to same node.
  73     }
  74
  75     @SuppressWarnings("rawtypes")
  76     @Override
  77     protected void verifyWrittenStructure(final NormalizedNode<?, ?> writtenValue) {
  78         checkArgument(nodeClass.isInstance(writtenValue), "Node should must be of type %s", nodeClass);
  79         checkArgument(writtenValue instanceof NormalizedNodeContainer);
  80
  81         NormalizedNodeContainer container = (NormalizedNodeContainer) writtenValue;
  82         for (Object child : container.getValue()) {
  83             checkArgument(child instanceof NormalizedNode);
  84
  85             /*
  86              * FIXME: fail-fast semantics:
  87              *
  88              * We can validate the data structure here, aborting the commit
  89              * before it ever progresses to being committed.
  90              */
  91         }
  92     }
  93
  94     @Override
  95     protected TreeNode applyWrite(final ModifiedNode modification,
  96             final Optional<TreeNode> currentMeta, final Version version) {
  97         final NormalizedNode<?, ?> newValue = modification.getWrittenValue();
  98         final TreeNode newValueMeta = TreeNodeFactory.createTreeNode(newValue, version);
  99
 100         if (Iterables.isEmpty(modification.getChildren())) {
 101             return newValueMeta;
 102         }
 103
 104         /*
 105          * This is where things get interesting. The user has performed a write and
 106          * then she applied some more modifications to it. So we need to make sense
 107          * of that an apply the operations on top of the written value. We could have
 108          * done it during the write, but this operation is potentially expensive, so
 109          * we have left it out of the fast path.
 110          *
 111          * As it turns out, once we materialize the written data, we can share the
 112          * code path with the subtree change. So let's create an unsealed TreeNode
 113          * and run the common parts on it -- which end with the node being sealed.
 114          */
 115         final MutableTreeNode mutable = newValueMeta.mutable();
 116         mutable.setSubtreeVersion(version);
 117
 118         @SuppressWarnings("rawtypes")
 119         final NormalizedNodeContainerBuilder dataBuilder = createBuilder(newValue);
 120
 121         return mutateChildren(mutable, dataBuilder, version, modification.getChildren());
 122     }
 123
 124     @SuppressWarnings({ "rawtypes", "unchecked" })
 125     private TreeNode mutateChildren(final MutableTreeNode meta, final NormalizedNodeContainerBuilder data,
 126             final Version nodeVersion, final Iterable<ModifiedNode> modifications) {
 127
 128         for (ModifiedNode mod : modifications) {
 129             final PathArgument id = mod.getIdentifier();
 130             final Optional<TreeNode> cm = meta.getChild(id);
 131
 132             Optional<TreeNode> result = resolveChildOperation(id).apply(mod, cm, nodeVersion);
 133             if (result.isPresent()) {
 134                 final TreeNode tn = result.get();
 135                 meta.addChild(tn);
 136                 data.addChild(tn.getData());
 137             } else {
 138                 meta.removeChild(id);
 139                 data.removeChild(id);
 140             }
 141         }
 142
 143         meta.setData(data.build());
 144         return meta.seal();
 145     }
 146
 147     @Override
 148     protected TreeNode applyMerge(final ModifiedNode modification, final TreeNode currentMeta,
 149             final Version version) {
 150         // For Node Containers - merge is same as subtree change - we only replace children.
 151         return applySubtreeChange(modification, currentMeta, version);
 152     }
 153
 154     @Override
 155     public TreeNode applySubtreeChange(final ModifiedNode modification,
 156             final TreeNode currentMeta, final Version version) {
 157         final MutableTreeNode newMeta = currentMeta.mutable();
 158         newMeta.setSubtreeVersion(version);
 159
 160         @SuppressWarnings("rawtypes")
 161         NormalizedNodeContainerBuilder dataBuilder = createBuilder(currentMeta.getData());
 162
 163         return mutateChildren(newMeta, dataBuilder, version, modification.getChildren());
 164     }
 165
 166     @Override
 167     protected void checkSubtreeModificationApplicable(final InstanceIdentifier path, final NodeModification modification,
 168             final Optional<TreeNode> current) throws DataValidationFailedException {
 169         checkDoesNotExists(path, modification.getOriginal().isPresent() || current.isPresent(), "Node does not exist. Could not modify its children.");
 170         SchemaAwareApplyOperation.checkConflicting(path, current.isPresent(), "Node was deleted by other transaction.");
 171         checkChildPreconditions(path, modification, current);
 172     }
 173
 174     private static void checkDoesNotExists(final InstanceIdentifier path, final boolean condition, final String message) throws DataValidationFailedException {
 175         if(!condition) {
 176             throw new ModifiedNodeDoesNotExistException(path,message);
 177         }
 178     }
 179
 180     private void checkChildPreconditions(final InstanceIdentifier path, final NodeModification modification, final Optional<TreeNode> current) throws DataValidationFailedException {
 181         final TreeNode currentMeta = current.get();
 182         for (NodeModification childMod : modification.getChildren()) {
 183             final PathArgument childId = childMod.getIdentifier();
 184             final Optional<TreeNode> childMeta = currentMeta.getChild(childId);
 185
 186             InstanceIdentifier childPath = path.node(childId);
 187             resolveChildOperation(childId).checkApplicable(childPath, childMod, childMeta);
 188         }
 189     }
 190
 191     @Override
 192     protected void checkMergeApplicable(final InstanceIdentifier path, final NodeModification modification,
 193             final Optional<TreeNode> current) throws DataValidationFailedException {
 194         if(current.isPresent()) {
 195             checkChildPreconditions(path, modification,current);
 196         }
 197     }
 198
 199     @SuppressWarnings("rawtypes")
 200     protected abstract NormalizedNodeContainerBuilder createBuilder(NormalizedNode<?, ?> original);
 201
 202     public static class ChoiceModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 203
 204         private final Map<PathArgument, ModificationApplyOperation> childNodes;
 205
 206         public ChoiceModificationStrategy(final ChoiceNode schemaNode) {
 207             super(org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode.class);
 208             ImmutableMap.Builder<PathArgument, ModificationApplyOperation> child = ImmutableMap.builder();
 209
 210             for (ChoiceCaseNode caze : schemaNode.getCases()) {
 211                 for (DataSchemaNode cazeChild : caze.getChildNodes()) {
 212                     SchemaAwareApplyOperation childNode = SchemaAwareApplyOperation.from(cazeChild);
 213                     child.put(new NodeIdentifier(cazeChild.getQName()), childNode);
 214                 }
 215             }
 216             childNodes = child.build();
 217         }
 218
 219         @Override
 220         public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
 221             return Optional.fromNullable(childNodes.get(child));
 222         }
 223
 224         @Override
 225         @SuppressWarnings("rawtypes")
 226         protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
 227             checkArgument(original instanceof org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode);
 228             return ImmutableChoiceNodeBuilder.create((org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode) original);
 229         }
 230     }
 231
 232     public static class OrderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 233
 234         private final Optional<ModificationApplyOperation> entryStrategy;
 235
 236         @SuppressWarnings({ "unchecked", "rawtypes" })
 237         protected OrderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
 238             super((Class) LeafSetNode.class);
 239             entryStrategy = Optional.<ModificationApplyOperation> of(new ValueNodeModificationStrategy.LeafSetEntryModificationStrategy(schema));
 240         }
 241
 242         @SuppressWarnings("rawtypes")
 243         @Override
 244         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 245             checkArgument(original instanceof OrderedLeafSetNode<?>);
 246             return ImmutableOrderedLeafSetNodeBuilder.create((OrderedLeafSetNode<?>) original);
 247         }
 248
 249         @Override
 250         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 251             if (identifier instanceof NodeWithValue) {
 252                 return entryStrategy;
 253             }
 254             return Optional.absent();
 255         }
 256     }
 257
 258     public static class OrderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 259
 260         private final Optional<ModificationApplyOperation> entryStrategy;
 261
 262         protected OrderedMapModificationStrategy(final ListSchemaNode schema) {
 263             super(OrderedMapNode.class);
 264             entryStrategy = Optional.<ModificationApplyOperation> of(new DataNodeContainerModificationStrategy.ListEntryModificationStrategy(schema));
 265         }
 266
 267         @SuppressWarnings("rawtypes")
 268         @Override
 269         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 270             checkArgument(original instanceof OrderedMapNode);
 271             return ImmutableOrderedMapNodeBuilder.create((OrderedMapNode) original);
 272         }
 273
 274         @Override
 275         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 276             if (identifier instanceof NodeIdentifierWithPredicates) {
 277                 return entryStrategy;
 278             }
 279             return Optional.absent();
 280         }
 281
 282         @Override
 283         public String toString() {
 284             return "OrderedMapModificationStrategy [entry=" + entryStrategy + "]";
 285         }
 286     }
 287
 288     public static class UnorderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 289
 290         private final Optional<ModificationApplyOperation> entryStrategy;
 291
 292         @SuppressWarnings({ "unchecked", "rawtypes" })
 293         protected UnorderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
 294             super((Class) LeafSetNode.class);
 295             entryStrategy = Optional.<ModificationApplyOperation> of(new ValueNodeModificationStrategy.LeafSetEntryModificationStrategy(schema));
 296         }
 297
 298         @SuppressWarnings("rawtypes")
 299         @Override
 300         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 301             checkArgument(original instanceof LeafSetNode<?>);
 302             return ImmutableLeafSetNodeBuilder.create((LeafSetNode<?>) original);
 303         }
 304
 305         @Override
 306         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 307             if (identifier instanceof NodeWithValue) {
 308                 return entryStrategy;
 309             }
 310             return Optional.absent();
 311         }
 312     }
 313
 314     public static class UnorderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 315
 316         private final Optional<ModificationApplyOperation> entryStrategy;
 317
 318         protected UnorderedMapModificationStrategy(final ListSchemaNode schema) {
 319             super(MapNode.class);
 320             entryStrategy = Optional.<ModificationApplyOperation> of(new DataNodeContainerModificationStrategy.ListEntryModificationStrategy(schema));
 321         }
 322
 323         @SuppressWarnings("rawtypes")
 324         @Override
 325         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 326             checkArgument(original instanceof MapNode);
 327             return ImmutableMapNodeBuilder.create((MapNode) original);
 328         }
 329
 330         @Override
 331         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 332             if (identifier instanceof NodeIdentifierWithPredicates) {
 333                 return entryStrategy;
 334             }
 335             return Optional.absent();
 336         }
 337
 338         @Override
 339         public String toString() {
 340             return "UnorderedMapModificationStrategy [entry=" + entryStrategy + "]";
 341         }
 342     }
 343 }