yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/MinMaxElementsValidation.java

   1 /*
   2  * Copyright (c) 2015 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 java.util.Optional;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  17 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  18 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  19 import org.opendaylight.yangtools.yang.data.api.schema.tree.RequiredElementCountException;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  24 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraintAware;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 final class MinMaxElementsValidation<T extends DataSchemaNode & ElementCountConstraintAware>
  29         extends DelegatingModificationApplyOperation {
  30     private static final Logger LOG = LoggerFactory.getLogger(MinMaxElementsValidation.class);
  31
  32     private final SchemaAwareApplyOperation<T> delegate;
  33     private final int minElements;
  34     private final int maxElements;
  35
  36     private MinMaxElementsValidation(final SchemaAwareApplyOperation<T> delegate, final Integer minElements,
  37             final Integer maxElements) {
  38         this.delegate = requireNonNull(delegate);
  39         this.minElements = minElements != null ? minElements : 0;
  40         this.maxElements = maxElements != null ? maxElements : Integer.MAX_VALUE;
  41     }
  42
  43     static <T extends DataSchemaNode & ElementCountConstraintAware> ModificationApplyOperation from(
  44             final SchemaAwareApplyOperation<T> delegate) {
  45         final Optional<ElementCountConstraint> optConstraint = delegate.getSchema().getElementCountConstraint();
  46         if (!optConstraint.isPresent()) {
  47             return delegate;
  48         }
  49
  50         final ElementCountConstraint constraint = optConstraint.get();
  51         return new MinMaxElementsValidation<>(delegate, constraint.getMinElements(), constraint.getMaxElements());
  52     }
  53
  54     @Override
  55     ModificationApplyOperation delegate() {
  56         return delegate;
  57     }
  58
  59     @Override
  60     Optional<TreeNode> apply(final ModifiedNode modification, final Optional<TreeNode> storeMeta,
  61             final Version version) {
  62         Optional<TreeNode> ret = modification.getValidatedNode(this, storeMeta);
  63         if (ret == null) {
  64             // Deal with the result moving on us
  65             ret = delegate.apply(modification, storeMeta, version);
  66             checkChildren(modification.getIdentifier(), numOfChildrenFromTreeNode(ret));
  67         }
  68         return ret;
  69     }
  70
  71     @Override
  72     void checkApplicable(final ModificationPath path, final NodeModification modification,
  73             final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
  74         delegate.checkApplicable(path, modification, current, version);
  75
  76         if (!(modification instanceof ModifiedNode)) {
  77             LOG.debug("Could not validate {}, does not implement expected class {}", modification, ModifiedNode.class);
  78             return;
  79         }
  80         final ModifiedNode modified = (ModifiedNode) modification;
  81
  82         // We need to actually perform the operation to deal with merge in a sane manner. We know the modification
  83         // is immutable, so the result of validation will probably not change.
  84         final Optional<TreeNode> maybeApplied = delegate.apply(modified, current, version);
  85         validateMinMaxElements(path, modified.getIdentifier(), numOfChildrenFromTreeNode(maybeApplied));
  86
  87         // Everything passed. We now have a snapshot of the result node, it would be too bad if we just threw it out.
  88         // We know what the result of an apply operation is going to be *if* the following are kept unchanged:
  89         // - the 'current' node
  90         // - the schemacontext (therefore, the fact this object is associated with the modification)
  91         //
  92         // So let's stash the result. We will pick it up during apply operation.
  93         modified.setValidatedNode(this, current, maybeApplied);
  94     }
  95
  96     @Override
  97     void fullVerifyStructure(final NormalizedNode<?, ?> modification) {
  98         delegate.fullVerifyStructure(modification);
  99         checkChildren(modification.getIdentifier(), numOfChildrenFromValue(modification));
 100     }
 101
 102     private void validateMinMaxElements(final ModificationPath path, final PathArgument id, final int children)
 103             throws DataValidationFailedException {
 104         if (minElements > children) {
 105             throw new RequiredElementCountException(path.toInstanceIdentifier(), minElements, maxElements,
 106                 children, "%s does not have enough elements (%s), needs at least %s", id, children, minElements);
 107         }
 108         if (maxElements < children) {
 109             throw new RequiredElementCountException(path.toInstanceIdentifier(), minElements, maxElements,
 110                 children, "%s has too many elements (%s), can have at most %s", id, children, maxElements);
 111         }
 112     }
 113
 114     private void checkChildren(final PathArgument id, final int children) {
 115         checkArgument(minElements <= children, "Node %s does not have enough elements (%s), needs at least %s", id,
 116                 children, minElements);
 117         checkArgument(maxElements >= children, "Node %s has too many elements (%s), can have at most %s", id, children,
 118                 maxElements);
 119     }
 120
 121     private static int numOfChildrenFromTreeNode(final Optional<TreeNode> node) {
 122         return node.isPresent() ? numOfChildrenFromValue(node.get().getData()) : 0;
 123     }
 124
 125     private static int numOfChildrenFromValue(final NormalizedNode<?, ?> value) {
 126         if (value instanceof NormalizedNodeContainer) {
 127             return ((NormalizedNodeContainer<?, ?, ?>) value).getValue().size();
 128         } else if (value instanceof UnkeyedListNode) {
 129             return ((UnkeyedListNode) value).getSize();
 130         }
 131
 132         throw new IllegalArgumentException(String.format(
 133                 "Unexpected type '%s', expected types are NormalizedNodeContainer and UnkeyedListNode",
 134                 value.getClass()));
 135     }
 136 }