X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-data-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fdata%2Fimpl%2Fschema%2Ftree%2FSchemaAwareApplyOperation.java;h=e78c444fe60479f082e9e4563b0162e16e89883a;hb=3c02bfbc4a1849409d32dc9b5116088878b7c489;hp=aaee9c30d8fb96c27c9ca216d87a09da2861fe16;hpb=b5c32f072f61abfe730a386f8ffe3862491785cd;p=yangtools.git diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/SchemaAwareApplyOperation.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/SchemaAwareApplyOperation.java index aaee9c30d8..e78c444fe6 100644 --- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/SchemaAwareApplyOperation.java +++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/SchemaAwareApplyOperation.java @@ -7,97 +7,106 @@ */ package org.opendaylight.yangtools.yang.data.impl.schema.tree; -import com.google.common.base.Optional; import com.google.common.base.Preconditions; import java.util.List; +import java.util.Optional; +import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; +import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode; +import org.opendaylight.yangtools.yang.data.api.schema.LeafNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.api.schema.tree.ConflictingModificationAppliedException; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration; import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; -import org.opendaylight.yangtools.yang.data.api.schema.tree.IncorrectDataStructureException; +import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType; +import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType; import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode; import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version; -import org.opendaylight.yangtools.yang.model.api.AugmentationSchema; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder; +import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode; import org.opendaylight.yangtools.yang.model.api.AugmentationTarget; import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; +import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus; import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode; import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode; import org.opendaylight.yangtools.yang.model.api.ListSchemaNode; +import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -abstract class SchemaAwareApplyOperation implements ModificationApplyOperation { +abstract class SchemaAwareApplyOperation extends ModificationApplyOperation { private static final Logger LOG = LoggerFactory.getLogger(SchemaAwareApplyOperation.class); + private static final NormalizedNodeContainerSupport AUGMENTATION_SUPPORT = + new NormalizedNodeContainerSupport<>(AugmentationNode.class, ImmutableAugmentationNodeBuilder::create, + ImmutableAugmentationNodeBuilder::create); - public static SchemaAwareApplyOperation from(final DataSchemaNode schemaNode) { + public static ModificationApplyOperation from(final DataSchemaNode schemaNode, + final DataTreeConfiguration treeConfig) { + if (treeConfig.getTreeType() == TreeType.CONFIGURATION) { + Preconditions.checkArgument(schemaNode.isConfiguration(), + "Supplied %s does not belongs to configuration tree.", schemaNode.getPath()); + } if (schemaNode instanceof ContainerSchemaNode) { - return new DataNodeContainerModificationStrategy.ContainerModificationStrategy((ContainerSchemaNode) schemaNode); + return ContainerModificationStrategy.of((ContainerSchemaNode) schemaNode, treeConfig); } else if (schemaNode instanceof ListSchemaNode) { - return fromListSchemaNode((ListSchemaNode) schemaNode); + return fromListSchemaNode((ListSchemaNode) schemaNode, treeConfig); } else if (schemaNode instanceof ChoiceSchemaNode) { - return new NormalizedNodeContainerModificationStrategy.ChoiceModificationStrategy((ChoiceSchemaNode) schemaNode); + return new ChoiceModificationStrategy((ChoiceSchemaNode) schemaNode, treeConfig); } else if (schemaNode instanceof LeafListSchemaNode) { - return fromLeafListSchemaNode((LeafListSchemaNode) schemaNode); + return MinMaxElementsValidation.from(new LeafSetModificationStrategy((LeafListSchemaNode) schemaNode, + treeConfig)); } else if (schemaNode instanceof LeafSchemaNode) { - return new ValueNodeModificationStrategy.LeafModificationStrategy((LeafSchemaNode) schemaNode); + return new ValueNodeModificationStrategy<>(LeafNode.class, (LeafSchemaNode) schemaNode); } throw new IllegalArgumentException("Not supported schema node type for " + schemaNode.getClass()); } - public static SchemaAwareApplyOperation from(final DataNodeContainer resolvedTree, - final AugmentationTarget augSchemas, final AugmentationIdentifier identifier) { - AugmentationSchema augSchema = null; - - allAugments: - for (AugmentationSchema potential : augSchemas.getAvailableAugmentations()) { - for (DataSchemaNode child : potential.getChildNodes()) { - if (identifier.getPossibleChildNames().contains(child.getQName())) { - augSchema = potential; - break allAugments; - } + public static DataNodeContainerModificationStrategy from( + final DataNodeContainer resolvedTree, final AugmentationTarget augSchemas, + final AugmentationIdentifier identifier, final DataTreeConfiguration treeConfig) { + for (final AugmentationSchemaNode potential : augSchemas.getAvailableAugmentations()) { + for (final DataSchemaNode child : potential.getChildNodes()) { + if (identifier.getPossibleChildNames().contains(child.getQName())) { + return from(potential, resolvedTree, treeConfig); } } - - if (augSchema != null) { - return new DataNodeContainerModificationStrategy.AugmentationModificationStrategy(augSchema, resolvedTree); } + return null; } - public static boolean checkConflicting(final YangInstanceIdentifier path, final boolean condition, final String message) throws ConflictingModificationAppliedException { - if(!condition) { - throw new ConflictingModificationAppliedException(path, message); - } - return condition; + static DataNodeContainerModificationStrategy from(final AugmentationSchemaNode schema, + final DataNodeContainer resolved, final DataTreeConfiguration treeConfig) { + return new DataNodeContainerModificationStrategy<>(AUGMENTATION_SUPPORT, + EffectiveAugmentationSchema.create(schema, resolved), treeConfig); } - private static SchemaAwareApplyOperation fromListSchemaNode(final ListSchemaNode schemaNode) { - List keyDefinition = schemaNode.getKeyDefinition(); - if (keyDefinition == null || keyDefinition.isEmpty()) { - return new UnkeyedListModificationStrategy(schemaNode); + static void checkConflicting(final ModificationPath path, final boolean condition, final String message) + throws ConflictingModificationAppliedException { + if (!condition) { + throw new ConflictingModificationAppliedException(path.toInstanceIdentifier(), message); } - if (schemaNode.isUserOrdered()) { - return new NormalizedNodeContainerModificationStrategy.OrderedMapModificationStrategy(schemaNode); - } - - return new NormalizedNodeContainerModificationStrategy.UnorderedMapModificationStrategy(schemaNode); } - private static SchemaAwareApplyOperation fromLeafListSchemaNode(final LeafListSchemaNode schemaNode) { - if(schemaNode.isUserOrdered()) { - return new NormalizedNodeContainerModificationStrategy.OrderedLeafSetModificationStrategy(schemaNode); + private static ModificationApplyOperation fromListSchemaNode(final ListSchemaNode schemaNode, + final DataTreeConfiguration treeConfig) { + final List keyDefinition = schemaNode.getKeyDefinition(); + final SchemaAwareApplyOperation op; + if (keyDefinition == null || keyDefinition.isEmpty()) { + op = new UnkeyedListModificationStrategy(schemaNode, treeConfig); } else { - return new NormalizedNodeContainerModificationStrategy.UnorderedLeafSetModificationStrategy(schemaNode); + op = MapModificationStrategy.of(schemaNode, treeConfig); } + return MinMaxElementsValidation.from(op); } - private static final void checkNotConflicting(final YangInstanceIdentifier path, final TreeNode original, final TreeNode current) throws ConflictingModificationAppliedException { + protected static void checkNotConflicting(final ModificationPath path, final TreeNode original, + final TreeNode current) throws ConflictingModificationAppliedException { checkConflicting(path, original.getVersion().equals(current.getVersion()), "Node was replaced by other transaction."); checkConflicting(path, original.getSubtreeVersion().equals(current.getSubtreeVersion()), @@ -105,42 +114,66 @@ abstract class SchemaAwareApplyOperation implements ModificationApplyOperation { } protected final ModificationApplyOperation resolveChildOperation(final PathArgument child) { - Optional potential = getChild(child); + final Optional potential = getChild(child); Preconditions.checkArgument(potential.isPresent(), "Operation for child %s is not defined.", child); return potential.get(); } @Override - public void verifyStructure(final ModifiedNode modification) throws IllegalArgumentException { - if (modification.getOperation() == LogicalOperation.WRITE) { - verifyWrittenStructure(modification.getWrittenValue()); + final void checkApplicable(final ModificationPath path, final NodeModification modification, + final Optional current, final Version version) throws DataValidationFailedException { + switch (modification.getOperation()) { + case DELETE: + checkDeleteApplicable(modification, current); + break; + case TOUCH: + checkTouchApplicable(path, modification, current, version); + break; + case WRITE: + checkWriteApplicable(path, modification, current, version); + break; + case MERGE: + checkMergeApplicable(path, modification, current, version); + break; + case NONE: + break; + default: + throw new UnsupportedOperationException( + "Suplied modification type " + modification.getOperation() + " is not supported."); } } @Override - public final void checkApplicable(final YangInstanceIdentifier path,final NodeModification modification, final Optional current) throws DataValidationFailedException { - switch (modification.getOperation()) { - case DELETE: - checkDeleteApplicable(modification, current); - case TOUCH: - checkSubtreeModificationApplicable(path, modification, current); - return; - case WRITE: - checkWriteApplicable(path, modification, current); - return; - case MERGE: - checkMergeApplicable(path, modification, current); - return; - case NONE: - return; - default: - throw new UnsupportedOperationException("Suplied modification type "+ modification.getOperation()+ "is not supported."); - } + final void quickVerifyStructure(final NormalizedNode writtenValue) { + verifyValue(writtenValue); + } + + @Override + final void fullVerifyStructure(final NormalizedNode writtenValue) { + verifyValue(writtenValue); + verifyValueChildren(writtenValue); + } + /** + * Verify the a written value, without performing deeper tree validation. + * + * @param writtenValue Written value + */ + abstract void verifyValue(NormalizedNode writtenValue); + + /** + * Verify the children implied by a written value after the value itself has been verified by + * {@link #verifyValue(NormalizedNode)}. Default implementation does nothing. + * + * @param writtenValue Written value + */ + void verifyValueChildren(final NormalizedNode writtenValue) { + // Defaults to no-op } - protected void checkMergeApplicable(final YangInstanceIdentifier path, final NodeModification modification, final Optional current) throws DataValidationFailedException { - Optional original = modification.getOriginal(); + protected void checkMergeApplicable(final ModificationPath path, final NodeModification modification, + final Optional current, final Version version) throws DataValidationFailedException { + final Optional original = modification.getOriginal(); if (original.isPresent() && current.isPresent()) { /* * We need to do conflict detection only and only if the value of leaf changed @@ -148,8 +181,10 @@ abstract class SchemaAwareApplyOperation implements ModificationApplyOperation { * it should not cause transaction to fail, since result of this merge * leads to same data. */ - if(!original.get().getData().equals(current.get().getData())) { - checkNotConflicting(path, original.get(), current.get()); + final TreeNode orig = original.get(); + final TreeNode cur = current.get(); + if (!orig.getData().equals(cur.getData())) { + checkNotConflicting(path, orig, cur); } } } @@ -162,84 +197,122 @@ abstract class SchemaAwareApplyOperation implements ModificationApplyOperation { * @param path Path from current node in TreeNode * @param modification modification to apply * @param current current node in TreeNode for modification to apply - * @throws DataValidationFailedException + * @throws DataValidationFailedException when a data dependency conflict is detected */ - protected void checkWriteApplicable(final YangInstanceIdentifier path, final NodeModification modification, - final Optional current) throws DataValidationFailedException { - Optional original = modification.getOriginal(); + private static void checkWriteApplicable(final ModificationPath path, final NodeModification modification, + final Optional current, final Version version) throws DataValidationFailedException { + final Optional original = modification.getOriginal(); if (original.isPresent() && current.isPresent()) { checkNotConflicting(path, original.get(), current.get()); - } else if(original.isPresent()) { - throw new ConflictingModificationAppliedException(path,"Node was deleted by other transaction."); - } else if(current.isPresent()) { - throw new ConflictingModificationAppliedException(path,"Node was created by other transaction."); + } else { + checkConflicting(path, !original.isPresent(), "Node was deleted by other transaction."); + checkConflicting(path, !current.isPresent(), "Node was created by other transaction."); } } - private void checkDeleteApplicable(final NodeModification modification, final Optional current) { + private static void checkDeleteApplicable(final NodeModification modification, final Optional current) { // Delete is always applicable, we do not expose it to subclasses - if (current.isPresent()) { + if (!current.isPresent()) { LOG.trace("Delete operation turned to no-op on missing node {}", modification); } } - boolean isOrdered() { - return false; - } - @Override - public final Optional apply(final ModifiedNode modification, - final Optional currentMeta, final Version version) { - + final Optional apply(final ModifiedNode modification, final Optional currentMeta, + final Version version) { switch (modification.getOperation()) { - case DELETE: - return modification.setSnapshot(Optional. absent()); - case TOUCH: - Preconditions.checkArgument(currentMeta.isPresent(), "Metadata not available for modification", + case DELETE: + // Deletion of a non-existing node is a no-op, report it as such + modification.resolveModificationType(currentMeta.isPresent() ? ModificationType.DELETE + : ModificationType.UNMODIFIED); + return modification.setSnapshot(Optional.empty()); + case TOUCH: + Preconditions.checkArgument(currentMeta.isPresent(), "Metadata not available for modification %s", modification); - return modification.setSnapshot(Optional.of(applySubtreeChange(modification, currentMeta.get(), + return modification.setSnapshot(Optional.of(applyTouch(modification, currentMeta.get(), version))); - case MERGE: - final TreeNode result; - - // This is a slight optimization: a merge on a non-existing node equals to a write - if (currentMeta.isPresent()) { - result = applyMerge(modification,currentMeta.get(), version); - } else { - result = applyWrite(modification, currentMeta, version); - } + case MERGE: + final TreeNode result; - return modification.setSnapshot(Optional.of(result)); - case WRITE: - return modification.setSnapshot(Optional.of(applyWrite(modification, currentMeta, version))); - case NONE: - return currentMeta; - default: - throw new IllegalArgumentException("Provided modification type is not supported."); + if (!currentMeta.isPresent()) { + // This is a slight optimization: a merge on a non-existing node equals to a write. Written data + // structure is usually verified when the transaction is sealed. To preserve correctness, we have + // to run that validation here. + modification.resolveModificationType(ModificationType.WRITE); + result = applyWrite(modification, modification.getWrittenValue(), currentMeta, version); + fullVerifyStructure(result.getData()); + } else { + result = applyMerge(modification, currentMeta.get(), version); + } + + return modification.setSnapshot(Optional.of(result)); + case WRITE: + modification.resolveModificationType(ModificationType.WRITE); + return modification.setSnapshot(Optional.of(applyWrite(modification, modification.getWrittenValue(), + currentMeta, version))); + case NONE: + modification.resolveModificationType(ModificationType.UNMODIFIED); + return currentMeta; + default: + throw new IllegalArgumentException("Provided modification type is not supported."); } } - protected abstract TreeNode applyMerge(ModifiedNode modification, - TreeNode currentMeta, Version version); + /** + * Apply a merge operation. Since the result of merge differs based on the data type + * being modified, implementations of this method are responsible for calling + * {@link ModifiedNode#resolveModificationType(ModificationType)} as appropriate. + * + * @param modification Modified node + * @param currentMeta Store Metadata Node on which NodeModification should be applied + * @param version New subtree version of parent node + * @return A sealed TreeNode representing applied operation. + */ + protected abstract TreeNode applyMerge(ModifiedNode modification, TreeNode currentMeta, Version version); - protected abstract TreeNode applyWrite(ModifiedNode modification, + protected abstract TreeNode applyWrite(ModifiedNode modification, NormalizedNode newValue, Optional currentMeta, Version version); - protected abstract TreeNode applySubtreeChange(ModifiedNode modification, - TreeNode currentMeta, Version version); - /** + * Apply a nested operation. Since there may not actually be a nested operation + * to be applied, implementations of this method are responsible for calling + * {@link ModifiedNode#resolveModificationType(ModificationType)} as appropriate. * + * @param modification Modified node + * @param currentMeta Store Metadata Node on which NodeModification should be applied + * @param version New subtree version of parent node + * @return A sealed TreeNode representing applied operation. + */ + protected abstract TreeNode applyTouch(ModifiedNode modification, TreeNode currentMeta, Version version); + + /** * Checks is supplied {@link NodeModification} is applicable for Subtree Modification. * * @param path Path to current node * @param modification Node modification which should be applied. * @param current Current state of data tree * @throws ConflictingModificationAppliedException If subtree was changed in conflicting way - * @throws IncorrectDataStructureException If subtree modification is not applicable (e.g. leaf node). + * @throws org.opendaylight.yangtools.yang.data.api.schema.tree.IncorrectDataStructureException If subtree + * modification is not applicable (e.g. leaf node). */ - protected abstract void checkSubtreeModificationApplicable(YangInstanceIdentifier path, final NodeModification modification, - final Optional current) throws DataValidationFailedException; + protected abstract void checkTouchApplicable(ModificationPath path, NodeModification modification, + Optional current, Version version) throws DataValidationFailedException; - protected abstract void verifyWrittenStructure(NormalizedNode writtenValue); + /** + * Return the {@link WithStatus}-subclass schema associated with this operation. + * @return A model node + */ + abstract @NonNull T getSchema(); + + /** + * Checks if supplied schema node belong to specified Data Tree type. All nodes belong to the operational tree, + * nodes in configuration tree are marked as such. + * + * @param treeType Tree Type + * @param node Schema node + * @return {@code true} if the node matches the tree type, {@code false} otherwise. + */ + static boolean belongsToTree(final TreeType treeType, final DataSchemaNode node) { + return treeType == TreeType.OPERATIONAL || node.isConfiguration(); + } }