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 NoOp extends MandatoryLeafEnforcer {
  33         @Override
  34         protected void enforceOnTreeNode(final TreeNode tree) {
  35             // Intentional no-op
  36         }
  37
  38         @Override
  39         protected void enforceOnTreeNode(final NormalizedNode<?, ?> normalizedNode) {
  40             // Intentional no-op
  41         }
  42     }
  43
  44     private static final class Strict extends MandatoryLeafEnforcer {
  45         private final Collection<YangInstanceIdentifier> mandatoryNodes;
  46
  47         private Strict(final Collection<YangInstanceIdentifier> mandatoryNodes) {
  48             this.mandatoryNodes = Preconditions.checkNotNull(mandatoryNodes);
  49         }
  50
  51         @Override
  52         protected void enforceOnTreeNode(final TreeNode tree) {
  53             enforceOnTreeNode(tree.getData());
  54         }
  55
  56         @Override
  57         protected void enforceOnTreeNode(final NormalizedNode<?, ?> data) {
  58             for (final YangInstanceIdentifier id : mandatoryNodes) {
  59                 final Optional<NormalizedNode<?, ?>> descandant = NormalizedNodes.findNode(data, id);
  60                 Preconditions.checkArgument(descandant.isPresent(), "Node %s is missing mandatory descendant %s",
  61                         data.getIdentifier(), id);
  62             }
  63         }
  64     }
  65
  66     private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
  67     private static final MandatoryLeafEnforcer NOOP_ENFORCER = new NoOp();
  68
  69     protected abstract void enforceOnTreeNode(final TreeNode tree);
  70
  71     protected abstract void enforceOnTreeNode(final NormalizedNode<?, ?> normalizedNode);
  72
  73     private static void findMandatoryNodes(final Builder<YangInstanceIdentifier> builder,
  74             final YangInstanceIdentifier id, final DataNodeContainer schema, final TreeType type) {
  75         for (final DataSchemaNode child : schema.getChildNodes()) {
  76             if (SchemaAwareApplyOperation.belongsToTree(type, child)) {
  77                 if (child instanceof ContainerSchemaNode) {
  78                     final ContainerSchemaNode container = (ContainerSchemaNode) child;
  79                     if (!container.isPresenceContainer()) {
  80                         findMandatoryNodes(builder, id.node(NodeIdentifier.create(child.getQName())), container, type);
  81                     }
  82                 } else {
  83                     final ConstraintDefinition constraints = child.getConstraints();
  84                     final Integer minElements = constraints.getMinElements();
  85                     if (constraints.isMandatory() || (minElements != null && minElements > 0)) {
  86                         final YangInstanceIdentifier childId = id.node(NodeIdentifier.create(child.getQName()));
  87                         LOG.debug("Adding mandatory child {}", childId);
  88                         builder.add(childId.toOptimized());
  89                     }
  90                 }
  91             }
  92         }
  93     }
  94
  95     static MandatoryLeafEnforcer forContainer(final DataNodeContainer schema, final DataTreeConfiguration treeConfig) {
  96         if (!treeConfig.isMandatoryNodesValidationEnabled()) {
  97             return NOOP_ENFORCER;
  98         }
  99         final TreeType treeType = treeConfig.getTreeType();
 100         switch (treeType) {
 101         case CONFIGURATION:
 102             final Builder<YangInstanceIdentifier> builder = ImmutableList.builder();
 103             findMandatoryNodes(builder, YangInstanceIdentifier.EMPTY, schema, treeType);
 104             final Collection<YangInstanceIdentifier> mandatoryNodes = builder.build();
 105             return mandatoryNodes.isEmpty() ? NOOP_ENFORCER : new Strict(mandatoryNodes);
 106         case OPERATIONAL:
 107             return NOOP_ENFORCER;
 108         default:
 109             throw new UnsupportedOperationException(String.format("Not supported tree type %s", treeType));
 110         }
 111     }
 112 }