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