yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/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.impl.schema.tree;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableList.Builder;
  15 import java.util.Optional;
  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.api.schema.NormalizedNodes;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  22 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  24 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  26 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraintAware;
  28 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 // TODO: would making this Serializable be useful (for Functions and similar?)
  33 final class MandatoryLeafEnforcer implements Immutable {
  34     private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
  35
  36     private final ImmutableList<YangInstanceIdentifier> mandatoryNodes;
  37
  38     private MandatoryLeafEnforcer(final ImmutableList<YangInstanceIdentifier> mandatoryNodes) {
  39         this.mandatoryNodes = requireNonNull(mandatoryNodes);
  40     }
  41
  42
  43     static Optional<MandatoryLeafEnforcer> forContainer(final DataNodeContainer schema,
  44             final DataTreeConfiguration treeConfig) {
  45         if (!treeConfig.isMandatoryNodesValidationEnabled()) {
  46             return Optional.empty();
  47         }
  48
  49         final Builder<YangInstanceIdentifier> builder = ImmutableList.builder();
  50         findMandatoryNodes(builder, YangInstanceIdentifier.empty(), schema, treeConfig.getTreeType());
  51         final ImmutableList<YangInstanceIdentifier> mandatoryNodes = builder.build();
  52         return mandatoryNodes.isEmpty() ? Optional.empty() : Optional.of(new MandatoryLeafEnforcer(mandatoryNodes));
  53     }
  54
  55     void enforceOnData(final NormalizedNode<?, ?> data) {
  56         for (final YangInstanceIdentifier id : mandatoryNodes) {
  57             checkArgument(NormalizedNodes.findNode(data, id).isPresent(),
  58                 "Node %s is missing mandatory descendant %s", data.getIdentifier(), id);
  59         }
  60     }
  61
  62     void enforceOnTreeNode(final TreeNode tree) {
  63         enforceOnData(tree.getData());
  64     }
  65
  66     private static void findMandatoryNodes(final Builder<YangInstanceIdentifier> builder,
  67             final YangInstanceIdentifier id, final DataNodeContainer schema, final TreeType type) {
  68         for (final DataSchemaNode child : schema.getChildNodes()) {
  69             if (SchemaAwareApplyOperation.belongsToTree(type, child)) {
  70                 if (child instanceof ContainerSchemaNode) {
  71                     final ContainerSchemaNode container = (ContainerSchemaNode) child;
  72                     if (!container.isPresenceContainer()) {
  73                         findMandatoryNodes(builder, id.node(NodeIdentifier.create(child.getQName())), container, type);
  74                     }
  75                 } else {
  76                     boolean needEnforce = child instanceof MandatoryAware && ((MandatoryAware) child).isMandatory();
  77                     if (!needEnforce && child instanceof ElementCountConstraintAware) {
  78                         needEnforce = ((ElementCountConstraintAware) child)
  79                                 .getElementCountConstraint().map(constraint -> {
  80                                     final Integer min = constraint.getMinElements();
  81                                     return min != null && min > 0;
  82                                 }).orElse(Boolean.FALSE).booleanValue();
  83                     }
  84                     if (needEnforce) {
  85                         final YangInstanceIdentifier childId = id.node(NodeIdentifier.create(child.getQName()));
  86                         LOG.debug("Adding mandatory child {}", childId);
  87                         builder.add(childId.toOptimized());
  88                     }
  89                 }
  90             }
  91         }
  92     }
  93 }