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.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableCollection.Builder;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collection;
  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.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 // TODO: would making this Serializable be useful (for Functions and similar?)
  31 abstract class MandatoryLeafEnforcer implements Immutable {
  32     private static final class Strict extends MandatoryLeafEnforcer {
  33         private final Collection<YangInstanceIdentifier> mandatoryNodes;
  34
  35         Strict(final Collection<YangInstanceIdentifier> mandatoryNodes) {
  36             this.mandatoryNodes = Preconditions.checkNotNull(mandatoryNodes);
  37         }
  38
  39         @Override
  40         void enforceOnData(final NormalizedNode<?, ?> data) {
  41             for (final YangInstanceIdentifier id : mandatoryNodes) {
  42                 final Optional<NormalizedNode<?, ?>> descandant = NormalizedNodes.findNode(data, id);
  43                 Preconditions.checkArgument(descandant.isPresent(), "Node %s is missing mandatory descendant %s",
  44                         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                     final ConstraintDefinition constraints = child.getConstraints();
  74                     final Integer minElements = constraints.getMinElements();
  75                     if (constraints.isMandatory() || minElements != null && minElements.intValue() > 0) {
  76                         final YangInstanceIdentifier childId = id.node(NodeIdentifier.create(child.getQName()));
  77                         LOG.debug("Adding mandatory child {}", childId);
  78                         builder.add(childId.toOptimized());
  79                     }
  80                 }
  81             }
  82         }
  83     }
  84
  85     static MandatoryLeafEnforcer forContainer(final DataNodeContainer schema, final DataTreeConfiguration treeConfig) {
  86         if (!treeConfig.isMandatoryNodesValidationEnabled()) {
  87             return NOOP_ENFORCER;
  88         }
  89
  90         final Builder<YangInstanceIdentifier> builder = ImmutableList.builder();
  91         findMandatoryNodes(builder, YangInstanceIdentifier.EMPTY, schema, treeConfig.getTreeType());
  92         final Collection<YangInstanceIdentifier> mandatoryNodes = builder.build();
  93         return mandatoryNodes.isEmpty() ? NOOP_ENFORCER : new Strict(mandatoryNodes);
  94     }
  95 }