data/yang-data-tree-ri/src/main/java/org/opendaylight/yangtools/yang/data/tree/impl/MandatoryLeafEnforcer.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.tree.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.data.tree.impl.MandatoryDescendant.getAugIdentifierOfChild;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableList.Builder;
  15 import org.eclipse.jdt.annotation.Nullable;
  16 import org.opendaylight.yangtools.concepts.Immutable;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
  21 import org.opendaylight.yangtools.yang.data.tree.api.TreeType;
  22 import org.opendaylight.yangtools.yang.data.tree.impl.node.TreeNode;
  23 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
  24 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
  27 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  28 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraintAware;
  30 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 // TODO: would making this Serializable be useful (for Functions and similar?)
  35 final class MandatoryLeafEnforcer implements Immutable {
  36     private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
  37
  38     private final ImmutableList<MandatoryDescendant> mandatoryNodes;
  39
  40     private MandatoryLeafEnforcer(final ImmutableList<MandatoryDescendant> mandatoryNodes) {
  41         this.mandatoryNodes = requireNonNull(mandatoryNodes);
  42     }
  43
  44     static @Nullable MandatoryLeafEnforcer forContainer(final DataNodeContainer schema,
  45             final DataTreeConfiguration treeConfig) {
  46         if (!treeConfig.isMandatoryNodesValidationEnabled()) {
  47             return null;
  48         }
  49
  50         final var builder = ImmutableList.<MandatoryDescendant>builder();
  51         final var isAugmentingNode = schema instanceof CopyableNode && ((CopyableNode) schema).isAugmenting();
  52         findMandatoryNodes(builder, YangInstanceIdentifier.empty(), schema, treeConfig.getTreeType(), isAugmentingNode);
  53         final var mandatoryNodes = builder.build();
  54         return mandatoryNodes.isEmpty() ? null : new MandatoryLeafEnforcer(mandatoryNodes);
  55     }
  56
  57     void enforceOnData(final NormalizedNode data) {
  58         mandatoryNodes.forEach(node -> node.enforceOnData(data));
  59     }
  60
  61     void enforceOnTreeNode(final TreeNode tree) {
  62         enforceOnData(tree.getData());
  63     }
  64
  65     private static void findMandatoryNodes(final Builder<MandatoryDescendant> builder,
  66         final YangInstanceIdentifier id, final DataNodeContainer schema, final TreeType type,
  67         final boolean augmentedSubtree) {
  68         for (final DataSchemaNode child : schema.getChildNodes()) {
  69             if (SchemaAwareApplyOperation.belongsToTree(type, child)) {
  70                 if (child instanceof ContainerSchemaNode container) {
  71                     if (!container.isPresenceContainer()) {
  72                         if (!augmentedSubtree) {
  73                             // this container is not part of augmented subtree.
  74                             final boolean parentSchemaAugmenting = schema instanceof CopyableNode copyable
  75                                 && copyable.isAugmenting();
  76                             if (container.isAugmenting() && !parentSchemaAugmenting) {
  77                                 // the container is augmenting, but the parent schema is not. Meaning this is the root
  78                                 // of the augmentation (the augmented subtree starts here). The container has to be
  79                                 // represented by AugmentationID and the whole subtree needs to be based on it.
  80                                 final AugmentationSchemaNode aug = getAugIdentifierOfChild(schema, child);
  81                                 findMandatoryNodes(builder, id.node(DataSchemaContextNode
  82                                     .augmentationIdentifierFrom(aug)).node(NodeIdentifier.create(container.getQName())),
  83                                     container, type, true);
  84                                 continue;
  85                             }
  86                         }
  87                         // the container is either:
  88                         //    - not in an augmented subtree and not augmenting
  89                         //    - in an augmented subtree
  90                         // in both cases just append the NodeID to the ongoing ID and continue the search.
  91                         findMandatoryNodes(builder, id.node(NodeIdentifier.create(container.getQName())),
  92                             container, type, augmentedSubtree);
  93                     }
  94                 } else {
  95                     boolean needEnforce = child instanceof MandatoryAware aware && aware.isMandatory();
  96                     if (!needEnforce && child instanceof ElementCountConstraintAware aware) {
  97                         needEnforce = aware.getElementCountConstraint()
  98                             .map(constraint -> {
  99                                 final Integer min = constraint.getMinElements();
 100                                 return min != null && min > 0;
 101                             })
 102                             .orElse(Boolean.FALSE);
 103                     }
 104                     if (needEnforce) {
 105                         final MandatoryDescendant desc = MandatoryDescendant.create(id, schema, child,
 106                             augmentedSubtree);
 107                         LOG.debug("Adding mandatory child {}", desc);
 108                         builder.add(desc);
 109                     }
 110                 }
 111             }
 112         }
 113     }
 114 }