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 com.google.common.base.Preconditions;
  11 import com.google.common.collect.ImmutableCollection.Builder;
  12 import com.google.common.collect.ImmutableList;
  13 import java.util.Collection;
  14 import java.util.Optional;
  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.ConstraintDefinition;
  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.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 Collection<YangInstanceIdentifier> mandatoryNodes;
  35
  36         Strict(final Collection<YangInstanceIdentifier> mandatoryNodes) {
  37             this.mandatoryNodes = Preconditions.checkNotNull(mandatoryNodes);
  38         }
  39
  40         @Override
  41         void enforceOnData(final NormalizedNode<?, ?> data) {
  42             for (final YangInstanceIdentifier id : mandatoryNodes) {
  43                 final Optional<NormalizedNode<?, ?>> descandant = NormalizedNodes.findNode(data, id);
  44                 Preconditions.checkArgument(descandant.isPresent(), "Node %s is missing mandatory descendant %s",
  45                         data.getIdentifier(), id);
  46             }
  47         }
  48     }
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
  51     private static final MandatoryLeafEnforcer NOOP_ENFORCER = new MandatoryLeafEnforcer() {
  52         @Override
  53         void enforceOnData(final NormalizedNode<?, ?> normalizedNode) {
  54             // Intentional no-op
  55         }
  56     };
  57
  58     final void enforceOnTreeNode(final TreeNode tree) {
  59         enforceOnData(tree.getData());
  60     }
  61
  62     abstract void enforceOnData(NormalizedNode<?, ?> normalizedNode);
  63
  64     private static void findMandatoryNodes(final Builder<YangInstanceIdentifier> builder,
  65             final YangInstanceIdentifier id, final DataNodeContainer schema, final TreeType type) {
  66         for (final DataSchemaNode child : schema.getChildNodes()) {
  67             if (SchemaAwareApplyOperation.belongsToTree(type, child)) {
  68                 if (child instanceof ContainerSchemaNode) {
  69                     final ContainerSchemaNode container = (ContainerSchemaNode) child;
  70                     if (!container.isPresenceContainer()) {
  71                         findMandatoryNodes(builder, id.node(NodeIdentifier.create(child.getQName())), container, type);
  72                     }
  73                 } else {
  74                     final boolean mandatory = child instanceof MandatoryAware && ((MandatoryAware) child).isMandatory();
  75                     final ConstraintDefinition constraints = child.getConstraints();
  76                     final Integer minElements = constraints.getMinElements();
  77                     if (mandatory || minElements != null && minElements.intValue() > 0) {
  78                         final YangInstanceIdentifier childId = id.node(NodeIdentifier.create(child.getQName()));
  79                         LOG.debug("Adding mandatory child {}", childId);
  80                         builder.add(childId.toOptimized());
  81                     }
  82                 }
  83             }
  84         }
  85     }
  86
  87     static MandatoryLeafEnforcer forContainer(final DataNodeContainer schema, final DataTreeConfiguration treeConfig) {
  88         if (!treeConfig.isMandatoryNodesValidationEnabled()) {
  89             return NOOP_ENFORCER;
  90         }
  91
  92         final Builder<YangInstanceIdentifier> builder = ImmutableList.builder();
  93         findMandatoryNodes(builder, YangInstanceIdentifier.EMPTY, schema, treeConfig.getTreeType());
  94         final Collection<YangInstanceIdentifier> mandatoryNodes = builder.build();
  95         return mandatoryNodes.isEmpty() ? NOOP_ENFORCER : new Strict(mandatoryNodes);
  96     }
  97 }