opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/SchemaAwareApplyOperation.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.dom.store.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import java.util.HashSet;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16 import java.util.concurrent.ExecutionException;
  17
  18 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ModificationType;
  19 import org.opendaylight.controller.md.sal.dom.store.impl.tree.NodeModification;
  20 import org.opendaylight.controller.md.sal.dom.store.impl.tree.StoreMetadataNode;
  21 import org.opendaylight.controller.md.sal.dom.store.impl.tree.StoreNodeCompositeBuilder;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.AugmentationIdentifier;
  25 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates;
  27 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeWithValue;
  28 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  29 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  38 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.AugmentationSchemaProxy;
  53 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  54 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  55 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  56 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  57 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  58 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  59 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  60 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  61 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  63
  64 import com.google.common.base.Function;
  65 import com.google.common.base.Optional;
  66 import com.google.common.base.Preconditions;
  67 import com.google.common.cache.CacheBuilder;
  68 import com.google.common.cache.CacheLoader;
  69 import com.google.common.cache.LoadingCache;
  70 import com.google.common.collect.ImmutableMap;
  71 import com.google.common.primitives.UnsignedLong;
  72
  73 public abstract class SchemaAwareApplyOperation implements ModificationApplyOperation {
  74
  75     public static SchemaAwareApplyOperation from(final DataSchemaNode schemaNode) {
  76         if (schemaNode instanceof ContainerSchemaNode) {
  77             return new ContainerModificationStrategy((ContainerSchemaNode) schemaNode);
  78         } else if (schemaNode instanceof ListSchemaNode) {
  79             return fromListSchemaNode((ListSchemaNode) schemaNode);
  80         } else if (schemaNode instanceof ChoiceNode) {
  81             return new ChoiceModificationStrategy((ChoiceNode) schemaNode);
  82         } else if (schemaNode instanceof LeafListSchemaNode) {
  83             return fromLeafListSchemaNode((LeafListSchemaNode) schemaNode);
  84         } else if (schemaNode instanceof LeafSchemaNode) {
  85             return new LeafModificationStrategy((LeafSchemaNode) schemaNode);
  86         }
  87         throw new IllegalArgumentException("Not supported schema node type for " + schemaNode.getClass());
  88     }
  89
  90     private static SchemaAwareApplyOperation fromListSchemaNode(final ListSchemaNode schemaNode) {
  91         List<QName> keyDefinition = schemaNode.getKeyDefinition();
  92         if (keyDefinition == null || keyDefinition.isEmpty()) {
  93             return new UnkeyedListModificationStrategy(schemaNode);
  94         }
  95         if (schemaNode.isUserOrdered()) {
  96             return new OrderedMapModificationStrategy(schemaNode);
  97         }
  98
  99         return new UnorderedMapModificationStrategy(schemaNode);
 100     }
 101
 102     private static SchemaAwareApplyOperation fromLeafListSchemaNode(final LeafListSchemaNode schemaNode) {
 103         if(schemaNode.isUserOrdered()) {
 104             return new OrderedLeafSetModificationStrategy(schemaNode);
 105         } else {
 106             return new UnorderedLeafSetModificationStrategy(schemaNode);
 107         }
 108     }
 109
 110
 111     public static SchemaAwareApplyOperation from(final DataNodeContainer resolvedTree,
 112             final AugmentationTarget augSchemas, final AugmentationIdentifier identifier) {
 113         AugmentationSchema augSchema = null;
 114         allAugments: for (AugmentationSchema potential : augSchemas.getAvailableAugmentations()) {
 115             boolean containsAll = true;
 116             for (DataSchemaNode child : potential.getChildNodes()) {
 117                 if (identifier.getPossibleChildNames().contains(child.getQName())) {
 118                     augSchema = potential;
 119                     break allAugments;
 120                 }
 121             }
 122         }
 123         if (augSchema != null) {
 124             return new AugmentationModificationStrategy(augSchema, resolvedTree);
 125         }
 126         return null;
 127     }
 128
 129     protected final ModificationApplyOperation resolveChildOperation(final PathArgument child) {
 130         Optional<ModificationApplyOperation> potential = getChild(child);
 131         checkArgument(potential.isPresent(), "Operation for child %s is not defined.", child);
 132         return potential.get();
 133     }
 134
 135     @Override
 136     public void verifyStructure(final NodeModification modification) throws IllegalArgumentException {
 137         if (modification.getModificationType() == ModificationType.WRITE) {
 138             verifyWritenStructure(modification.getWritenValue());
 139         }
 140     }
 141
 142     protected abstract void verifyWritenStructure(NormalizedNode<?, ?> writenValue);
 143
 144     @Override
 145     public void checkApplicable(final InstanceIdentifier path,final NodeModification modification, final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 146         switch (modification.getModificationType()) {
 147         case DELETE:
 148             checkDeleteApplicable(modification, current);
 149         case SUBTREE_MODIFIED:
 150             checkSubtreeModificationApplicable(path,modification, current);
 151             return;
 152         case WRITE:
 153             checkWriteApplicable(path,modification, current);
 154             return;
 155         case MERGE:
 156             checkMergeApplicable(path,modification,current);
 157             return;
 158         case UNMODIFIED:
 159             return;
 160         default:
 161             throw new UnsupportedOperationException("Suplied modification type "+modification.getModificationType()+ "is not supported.");
 162         }
 163
 164     }
 165
 166     protected void checkMergeApplicable(final InstanceIdentifier path,final NodeModification modification, final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 167         Optional<StoreMetadataNode> original = modification.getOriginal();
 168         if (original.isPresent() && current.isPresent()) {
 169             checkNotConflicting(path,original.get(), current.get());
 170         }
 171     }
 172
 173     protected void checkWriteApplicable(final InstanceIdentifier path,final NodeModification modification, final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 174         Optional<StoreMetadataNode> original = modification.getOriginal();
 175         if (original.isPresent() && current.isPresent()) {
 176             checkNotConflicting(path,original.get(), current.get());
 177         } else if(original.isPresent()) {
 178             throw new DataPreconditionFailedException(path,"Node was deleted by other transaction.");
 179         }
 180     }
 181
 182     protected static final void checkNotConflicting(final InstanceIdentifier path,final StoreMetadataNode original, final StoreMetadataNode current) throws DataPreconditionFailedException {
 183         checkDataPrecondition(path, original.getNodeVersion().equals(current.getNodeVersion()),"Node was replaced by other transaction.");
 184         checkDataPrecondition(path,original.getSubtreeVersion().equals(current.getSubtreeVersion()), "Node children was modified by other transaction");
 185     }
 186
 187     protected abstract void checkSubtreeModificationApplicable(InstanceIdentifier path,final NodeModification modification,
 188             final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException;
 189
 190     private void checkDeleteApplicable(final NodeModification modification, final Optional<StoreMetadataNode> current) {
 191     }
 192
 193     @Override
 194     public final Optional<StoreMetadataNode> apply(final NodeModification modification,
 195             final Optional<StoreMetadataNode> currentMeta, final UnsignedLong subtreeVersion) {
 196
 197         switch (modification.getModificationType()) {
 198         case DELETE:
 199             return modification.storeSnapshot(Optional.<StoreMetadataNode> absent());
 200         case SUBTREE_MODIFIED:
 201             Preconditions.checkArgument(currentMeta.isPresent(), "Metadata not available for modification",
 202                     modification);
 203             return modification.storeSnapshot(Optional.of(applySubtreeChange(modification, currentMeta.get(),
 204                     subtreeVersion)));
 205         case MERGE:
 206             if(currentMeta.isPresent()) {
 207                 return modification.storeSnapshot(Optional.of(applyMerge(modification,currentMeta.get(),subtreeVersion)));
 208             } // Fallback to write is intentional - if node is not preexisting merge is same as write
 209         case WRITE:
 210             return modification.storeSnapshot(Optional.of(applyWrite(modification, currentMeta, subtreeVersion)));
 211         case UNMODIFIED:
 212             return currentMeta;
 213         default:
 214             throw new IllegalArgumentException("Provided modification type is not supported.");
 215         }
 216     }
 217
 218     protected abstract StoreMetadataNode applyMerge(NodeModification modification,
 219             StoreMetadataNode currentMeta, UnsignedLong subtreeVersion);
 220
 221     protected abstract StoreMetadataNode applyWrite(NodeModification modification,
 222             Optional<StoreMetadataNode> currentMeta, UnsignedLong subtreeVersion);
 223
 224     protected abstract StoreMetadataNode applySubtreeChange(NodeModification modification,
 225             StoreMetadataNode currentMeta, UnsignedLong subtreeVersion);
 226
 227     public static abstract class ValueNodeModificationStrategy<T extends DataSchemaNode> extends
 228             SchemaAwareApplyOperation {
 229
 230         private final T schema;
 231         private final Class<? extends NormalizedNode<?, ?>> nodeClass;
 232
 233         protected ValueNodeModificationStrategy(final T schema, final Class<? extends NormalizedNode<?, ?>> nodeClass) {
 234             super();
 235             this.schema = schema;
 236             this.nodeClass = nodeClass;
 237         }
 238
 239         @Override
 240         protected void verifyWritenStructure(final NormalizedNode<?, ?> writenValue) {
 241             checkArgument(nodeClass.isInstance(writenValue), "Node should must be of type %s", nodeClass);
 242         }
 243
 244         @Override
 245         public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
 246             throw new UnsupportedOperationException("Node " + schema.getPath()
 247                     + "is leaf type node. Child nodes not allowed");
 248         }
 249
 250         @Override
 251         protected StoreMetadataNode applySubtreeChange(final NodeModification modification,
 252                 final StoreMetadataNode currentMeta, final UnsignedLong subtreeVersion) {
 253             throw new UnsupportedOperationException("Node " + schema.getPath()
 254                     + "is leaf type node. Subtree change is not allowed.");
 255         }
 256
 257         @Override
 258         protected StoreMetadataNode applyMerge(final NodeModification modification, final StoreMetadataNode currentMeta,
 259                 final UnsignedLong subtreeVersion) {
 260             return applyWrite(modification, Optional.of(currentMeta), subtreeVersion);
 261         }
 262
 263         @Override
 264         protected StoreMetadataNode applyWrite(final NodeModification modification,
 265                 final Optional<StoreMetadataNode> currentMeta, final UnsignedLong subtreeVersion) {
 266             UnsignedLong nodeVersion = subtreeVersion;
 267             return StoreMetadataNode.builder().setNodeVersion(nodeVersion).setSubtreeVersion(subtreeVersion)
 268                     .setData(modification.getWritenValue()).build();
 269         }
 270
 271         @Override
 272         protected void checkSubtreeModificationApplicable(final InstanceIdentifier path,final NodeModification modification,
 273                 final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 274             throw new DataPreconditionFailedException(path, "Subtree modification is not allowed.");
 275         }
 276
 277     }
 278
 279     public static class LeafSetEntryModificationStrategy extends ValueNodeModificationStrategy<LeafListSchemaNode> {
 280
 281         @SuppressWarnings({ "unchecked", "rawtypes" })
 282         protected LeafSetEntryModificationStrategy(final LeafListSchemaNode schema) {
 283             super(schema, (Class) LeafSetEntryNode.class);
 284         }
 285     }
 286
 287     public static class LeafModificationStrategy extends ValueNodeModificationStrategy<LeafSchemaNode> {
 288
 289         @SuppressWarnings({ "unchecked", "rawtypes" })
 290         protected LeafModificationStrategy(final LeafSchemaNode schema) {
 291             super(schema, (Class) LeafNode.class);
 292         }
 293     }
 294
 295     public static abstract class NormalizedNodeContainerModificationStrategy extends SchemaAwareApplyOperation {
 296
 297         private final Class<? extends NormalizedNode<?, ?>> nodeClass;
 298
 299         protected NormalizedNodeContainerModificationStrategy(final Class<? extends NormalizedNode<?, ?>> nodeClass) {
 300             this.nodeClass = nodeClass;
 301         }
 302
 303         @Override
 304         public void verifyStructure(final NodeModification modification) throws IllegalArgumentException {
 305             if (modification.getModificationType() == ModificationType.WRITE) {
 306
 307             }
 308             for (NodeModification childModification : modification.getModifications()) {
 309                 resolveChildOperation(childModification.getIdentifier()).verifyStructure(childModification);
 310             }
 311         }
 312
 313         @Override
 314         protected void checkWriteApplicable(final InstanceIdentifier path, final NodeModification modification,
 315                 final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 316             // FIXME: Implement proper write check for replacement of node container
 317             //        prerequisite is to have transaction chain available for clients
 318             //        otherwise this will break chained writes to same node.
 319         }
 320
 321         @SuppressWarnings("rawtypes")
 322         @Override
 323         protected void verifyWritenStructure(final NormalizedNode<?, ?> writenValue) {
 324             checkArgument(nodeClass.isInstance(writenValue), "Node should must be of type %s", nodeClass);
 325             checkArgument(writenValue instanceof NormalizedNodeContainer);
 326             NormalizedNodeContainer writenCont = (NormalizedNodeContainer) writenValue;
 327             for (Object child : writenCont.getValue()) {
 328                 checkArgument(child instanceof NormalizedNode);
 329                 NormalizedNode childNode = (NormalizedNode) child;
 330             }
 331         }
 332
 333         @Override
 334         protected StoreMetadataNode applyWrite(final NodeModification modification,
 335                 final Optional<StoreMetadataNode> currentMeta, final UnsignedLong subtreeVersion) {
 336
 337             NormalizedNode<?, ?> newValue = modification.getWritenValue();
 338
 339             final UnsignedLong nodeVersion;
 340             if (currentMeta.isPresent()) {
 341                 nodeVersion = StoreUtils.increase(currentMeta.get().getNodeVersion());
 342             } else {
 343                 nodeVersion = subtreeVersion;
 344             }
 345
 346             final StoreMetadataNode newValueMeta = StoreMetadataNode.createRecursively(newValue, nodeVersion, nodeVersion);
 347             if (!modification.hasAdditionalModifications()) {
 348                 return newValueMeta;
 349             }
 350
 351             @SuppressWarnings("rawtypes")
 352             NormalizedNodeContainerBuilder dataBuilder = createBuilder(newValue);
 353             StoreNodeCompositeBuilder builder = StoreNodeCompositeBuilder.from(dataBuilder) //
 354                     .setNodeVersion(nodeVersion) //
 355                     .setSubtreeVersion(subtreeVersion);
 356
 357             return mutateChildren(modification.getModifications(), newValueMeta, builder, nodeVersion);
 358         }
 359
 360         @Override
 361         protected StoreMetadataNode applyMerge(final NodeModification modification, final StoreMetadataNode currentMeta,
 362                 final UnsignedLong subtreeVersion) {
 363             // For Node Containers - merge is same as subtree change - we only replace children.
 364             return applySubtreeChange(modification, currentMeta, subtreeVersion);
 365         }
 366
 367         @Override
 368         public StoreMetadataNode applySubtreeChange(final NodeModification modification,
 369                 final StoreMetadataNode currentMeta, final UnsignedLong subtreeVersion) {
 370             // Bump subtree version to its new target
 371             final UnsignedLong updatedSubtreeVersion = StoreUtils.increase(currentMeta.getSubtreeVersion());
 372
 373             @SuppressWarnings("rawtypes")
 374             NormalizedNodeContainerBuilder dataBuilder = createBuilder(currentMeta.getData());
 375             StoreNodeCompositeBuilder builder = StoreNodeCompositeBuilder.from(dataBuilder, currentMeta)
 376                     .setIdentifier(modification.getIdentifier()).setNodeVersion(currentMeta.getNodeVersion())
 377                     .setSubtreeVersion(updatedSubtreeVersion);
 378
 379             return mutateChildren(modification.getModifications(), currentMeta, builder, updatedSubtreeVersion);
 380         }
 381
 382         private StoreMetadataNode mutateChildren(final Iterable<NodeModification> modifications, final StoreMetadataNode meta,
 383                 final StoreNodeCompositeBuilder builder, final UnsignedLong nodeVersion) {
 384
 385             for (NodeModification mod : modifications) {
 386                 final PathArgument id = mod.getIdentifier();
 387                 final Optional<StoreMetadataNode> cm = meta.getChild(id);
 388
 389                 Optional<StoreMetadataNode> result = resolveChildOperation(id).apply(mod, cm, nodeVersion);
 390                 if (result.isPresent()) {
 391                     builder.add(result.get());
 392                 } else {
 393                     builder.remove(id);
 394                 }
 395             }
 396
 397             return builder.build();
 398         }
 399
 400         @Override
 401         protected void checkSubtreeModificationApplicable(final InstanceIdentifier path,final NodeModification modification,
 402                 final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 403             checkDataPrecondition(path, current.isPresent(), "Node was deleted by other transaction.");
 404             checkChildPreconditions(path,modification,current);
 405
 406         }
 407
 408         private void checkChildPreconditions(final InstanceIdentifier path, final NodeModification modification, final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 409             StoreMetadataNode currentMeta = current.get();
 410             for (NodeModification childMod : modification.getModifications()) {
 411                 PathArgument childId = childMod.getIdentifier();
 412                 Optional<StoreMetadataNode> childMeta = currentMeta.getChild(childId);
 413                 InstanceIdentifier childPath = StoreUtils.append(path, childId);
 414                 resolveChildOperation(childId).checkApplicable(childPath,childMod, childMeta);
 415             }
 416         }
 417
 418         @Override
 419         protected void checkMergeApplicable(final InstanceIdentifier path, final NodeModification modification,
 420                 final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 421             if(current.isPresent()) {
 422                 checkChildPreconditions(path,modification,current);
 423             }
 424         }
 425
 426         @SuppressWarnings("rawtypes")
 427         protected abstract NormalizedNodeContainerBuilder createBuilder(NormalizedNode<?, ?> original);
 428     }
 429
 430     public static abstract class DataNodeContainerModificationStrategy<T extends DataNodeContainer> extends
 431             NormalizedNodeContainerModificationStrategy {
 432
 433         private final T schema;
 434         private final LoadingCache<PathArgument, ModificationApplyOperation> childCache = CacheBuilder.newBuilder()
 435                 .build(CacheLoader.from(new Function<PathArgument, ModificationApplyOperation>() {
 436
 437                     @Override
 438                     public ModificationApplyOperation apply(final PathArgument identifier) {
 439                         if (identifier instanceof AugmentationIdentifier && schema instanceof AugmentationTarget) {
 440                             return from(schema, (AugmentationTarget) schema, (AugmentationIdentifier) identifier);
 441                         }
 442
 443                         DataSchemaNode child = schema.getDataChildByName(identifier.getNodeType());
 444                         if (child == null) {
 445                             return null;
 446                         }
 447                         return from(child);
 448                     }
 449                 }));
 450
 451         protected DataNodeContainerModificationStrategy(final T schema,
 452                 final Class<? extends NormalizedNode<?, ?>> nodeClass) {
 453             super(nodeClass);
 454             this.schema = schema;
 455         }
 456
 457         protected T getSchema() {
 458             return schema;
 459         }
 460
 461         @Override
 462         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 463             try {
 464                 return Optional.<ModificationApplyOperation> fromNullable(childCache.get(identifier));
 465             } catch (ExecutionException e) {
 466                 return Optional.absent();
 467             }
 468         }
 469
 470         @Override
 471         @SuppressWarnings("rawtypes")
 472         protected abstract DataContainerNodeBuilder createBuilder(NormalizedNode<?, ?> original);
 473
 474         @Override
 475         public String toString() {
 476             return getClass().getSimpleName() + " [" + schema + "]";
 477         }
 478
 479     }
 480
 481     public static class ContainerModificationStrategy extends
 482             DataNodeContainerModificationStrategy<ContainerSchemaNode> {
 483
 484         public ContainerModificationStrategy(final ContainerSchemaNode schemaNode) {
 485             super(schemaNode, ContainerNode.class);
 486         }
 487
 488         @Override
 489         @SuppressWarnings("rawtypes")
 490         protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
 491             checkArgument(original instanceof ContainerNode);
 492             return ImmutableContainerNodeBuilder.create((ContainerNode) original);
 493         }
 494     }
 495
 496     public static class UnkeyedListItemModificationStrategy extends
 497             DataNodeContainerModificationStrategy<ListSchemaNode> {
 498
 499         public UnkeyedListItemModificationStrategy(final ListSchemaNode schemaNode) {
 500             super(schemaNode, UnkeyedListEntryNode.class);
 501         }
 502
 503         @Override
 504         @SuppressWarnings("rawtypes")
 505         protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
 506             checkArgument(original instanceof UnkeyedListEntryNode);
 507             return ImmutableUnkeyedListEntryNodeBuilder.create((UnkeyedListEntryNode) original);
 508         }
 509     }
 510
 511     public static class AugmentationModificationStrategy extends
 512             DataNodeContainerModificationStrategy<AugmentationSchema> {
 513
 514         protected AugmentationModificationStrategy(final AugmentationSchema schema, final DataNodeContainer resolved) {
 515             super(createAugmentProxy(schema,resolved), AugmentationNode.class);
 516         }
 517
 518         @Override
 519         @SuppressWarnings("rawtypes")
 520         protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
 521             checkArgument(original instanceof AugmentationNode);
 522             return ImmutableAugmentationNodeBuilder.create((AugmentationNode) original);
 523         }
 524     }
 525
 526     public static class ChoiceModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 527
 528         private final ChoiceNode schema;
 529         private final Map<PathArgument, ModificationApplyOperation> childNodes;
 530
 531         public ChoiceModificationStrategy(final ChoiceNode schemaNode) {
 532             super(org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode.class);
 533             this.schema = schemaNode;
 534             ImmutableMap.Builder<PathArgument, ModificationApplyOperation> child = ImmutableMap.builder();
 535
 536             for (ChoiceCaseNode caze : schemaNode.getCases()) {
 537                 for (DataSchemaNode cazeChild : caze.getChildNodes()) {
 538                     SchemaAwareApplyOperation childNode = from(cazeChild);
 539                     child.put(new NodeIdentifier(cazeChild.getQName()), childNode);
 540                 }
 541             }
 542             childNodes = child.build();
 543         }
 544
 545         @Override
 546         public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
 547             return Optional.fromNullable(childNodes.get(child));
 548         }
 549
 550         @Override
 551         @SuppressWarnings("rawtypes")
 552         protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
 553             checkArgument(original instanceof org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode);
 554             return ImmutableChoiceNodeBuilder.create((org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode) original);
 555         }
 556     }
 557
 558     public static class ListEntryModificationStrategy extends DataNodeContainerModificationStrategy<ListSchemaNode> {
 559
 560         protected ListEntryModificationStrategy(final ListSchemaNode schema) {
 561             super(schema, MapEntryNode.class);
 562         }
 563
 564         @Override
 565         @SuppressWarnings("rawtypes")
 566         protected final DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
 567             checkArgument(original instanceof MapEntryNode);
 568             return ImmutableMapEntryNodeBuilder.create((MapEntryNode) original);
 569         }
 570     }
 571
 572     public static class UnorderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 573
 574         private final Optional<ModificationApplyOperation> entryStrategy;
 575
 576         @SuppressWarnings({ "unchecked", "rawtypes" })
 577         protected UnorderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
 578             super((Class) LeafSetNode.class);
 579             entryStrategy = Optional.<ModificationApplyOperation> of(new LeafSetEntryModificationStrategy(schema));
 580         }
 581
 582         @SuppressWarnings("rawtypes")
 583         @Override
 584         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 585             checkArgument(original instanceof LeafSetNode<?>);
 586             return ImmutableLeafSetNodeBuilder.create((LeafSetNode<?>) original);
 587         }
 588
 589         @Override
 590         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 591             if (identifier instanceof NodeWithValue) {
 592                 return entryStrategy;
 593             }
 594             return Optional.absent();
 595         }
 596     }
 597
 598     public static class OrderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 599
 600         private final Optional<ModificationApplyOperation> entryStrategy;
 601
 602         @SuppressWarnings({ "unchecked", "rawtypes" })
 603         protected OrderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
 604             super((Class) LeafSetNode.class);
 605             entryStrategy = Optional.<ModificationApplyOperation> of(new LeafSetEntryModificationStrategy(schema));
 606         }
 607
 608         @SuppressWarnings("rawtypes")
 609         @Override
 610         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 611             checkArgument(original instanceof OrderedLeafSetNode<?>);
 612             return ImmutableOrderedLeafSetNodeBuilder.create((OrderedLeafSetNode<?>) original);
 613         }
 614
 615         @Override
 616         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 617             if (identifier instanceof NodeWithValue) {
 618                 return entryStrategy;
 619             }
 620             return Optional.absent();
 621         }
 622     }
 623
 624     public static class UnkeyedListModificationStrategy extends SchemaAwareApplyOperation {
 625
 626         private final Optional<ModificationApplyOperation> entryStrategy;
 627
 628         protected UnkeyedListModificationStrategy(final ListSchemaNode schema) {
 629             entryStrategy = Optional.<ModificationApplyOperation> of(new UnkeyedListItemModificationStrategy(schema));
 630         }
 631
 632         @Override
 633         protected StoreMetadataNode applyMerge(final NodeModification modification, final StoreMetadataNode currentMeta,
 634                 final UnsignedLong subtreeVersion) {
 635             return applyWrite(modification, Optional.of(currentMeta), subtreeVersion);
 636         }
 637
 638         @Override
 639         protected StoreMetadataNode applySubtreeChange(final NodeModification modification,
 640                 final StoreMetadataNode currentMeta, final UnsignedLong subtreeVersion) {
 641             throw new UnsupportedOperationException("UnkeyedList does not support subtree change.");
 642         }
 643
 644         @Override
 645         protected StoreMetadataNode applyWrite(final NodeModification modification,
 646                 final Optional<StoreMetadataNode> currentMeta, final UnsignedLong subtreeVersion) {
 647             return StoreMetadataNode.createRecursively(modification.getWritenValue(), subtreeVersion);
 648         }
 649
 650         @Override
 651         public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
 652             if (child instanceof NodeIdentifier) {
 653                 return entryStrategy;
 654             }
 655             return Optional.absent();
 656         }
 657
 658         @Override
 659         protected void verifyWritenStructure(final NormalizedNode<?, ?> writenValue) {
 660
 661         }
 662
 663         @Override
 664         protected void checkSubtreeModificationApplicable(final InstanceIdentifier path,final NodeModification modification,
 665                 final Optional<StoreMetadataNode> current) throws DataPreconditionFailedException {
 666             throw new DataPreconditionFailedException(path, "Subtree modification is not allowed.");
 667         }
 668
 669     }
 670
 671     public static class UnorderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 672
 673         private final Optional<ModificationApplyOperation> entryStrategy;
 674
 675         protected UnorderedMapModificationStrategy(final ListSchemaNode schema) {
 676             super(MapNode.class);
 677             entryStrategy = Optional.<ModificationApplyOperation> of(new ListEntryModificationStrategy(schema));
 678         }
 679
 680         @SuppressWarnings("rawtypes")
 681         @Override
 682         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 683             checkArgument(original instanceof MapNode);
 684             return ImmutableMapNodeBuilder.create((MapNode) original);
 685         }
 686
 687         @Override
 688         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 689             if (identifier instanceof NodeIdentifierWithPredicates) {
 690                 return entryStrategy;
 691             }
 692             return Optional.absent();
 693         }
 694
 695         @Override
 696         public String toString() {
 697             return "UnorderedMapModificationStrategy [entry=" + entryStrategy + "]";
 698         }
 699     }
 700
 701     public static class OrderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
 702
 703         private final Optional<ModificationApplyOperation> entryStrategy;
 704
 705         protected OrderedMapModificationStrategy(final ListSchemaNode schema) {
 706             super(OrderedMapNode.class);
 707             entryStrategy = Optional.<ModificationApplyOperation> of(new ListEntryModificationStrategy(schema));
 708         }
 709
 710         @SuppressWarnings("rawtypes")
 711         @Override
 712         protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
 713             checkArgument(original instanceof OrderedMapNode);
 714             return ImmutableOrderedMapNodeBuilder.create((OrderedMapNode) original);
 715         }
 716
 717         @Override
 718         public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
 719             if (identifier instanceof NodeIdentifierWithPredicates) {
 720                 return entryStrategy;
 721             }
 722             return Optional.absent();
 723         }
 724
 725         @Override
 726         public String toString() {
 727             return "OrderedMapModificationStrategy [entry=" + entryStrategy + "]";
 728         }
 729     }
 730
 731     public void verifyIdentifier(final PathArgument identifier) {
 732
 733     }
 734
 735     public static AugmentationSchema createAugmentProxy(final AugmentationSchema schema, final DataNodeContainer resolved) {
 736         Set<DataSchemaNode> realChildSchemas = new HashSet<>();
 737         for(DataSchemaNode augChild : schema.getChildNodes()) {
 738             realChildSchemas.add(resolved.getDataChildByName(augChild.getQName()));
 739         }
 740         return new AugmentationSchemaProxy(schema, realChildSchemas);
 741     }
 742
 743     public static boolean checkDataPrecondition(final InstanceIdentifier path, final boolean condition, final String message) throws DataPreconditionFailedException {
 744         if(!condition) {
 745             throw new DataPreconditionFailedException(path, message);
 746         }
 747         return condition;
 748     }
 749
 750 }