2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
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;
28 final class MinMaxElementsValidation extends ModificationApplyOperation {
29 private static final Logger LOG = LoggerFactory.getLogger(MinMaxElementsValidation.class);
31 private final SchemaAwareApplyOperation delegate;
32 private final int minElements;
33 private final int maxElements;
35 private MinMaxElementsValidation(final SchemaAwareApplyOperation delegate, final Integer minElements,
36 final Integer maxElements) {
37 this.delegate = requireNonNull(delegate);
38 this.minElements = minElements != null ? minElements : 0;
39 this.maxElements = maxElements != null ? maxElements : Integer.MAX_VALUE;
42 static ModificationApplyOperation from(final SchemaAwareApplyOperation delegate, final DataSchemaNode schema) {
43 if (!(schema instanceof ElementCountConstraintAware)) {
46 final Optional<ElementCountConstraint> optConstraint = ((ElementCountConstraintAware) schema)
47 .getElementCountConstraint();
48 if (!optConstraint.isPresent()) {
52 final ElementCountConstraint constraint = optConstraint.get();
53 return new MinMaxElementsValidation(delegate, constraint.getMinElements(), constraint.getMaxElements());
57 Optional<TreeNode> apply(final ModifiedNode modification, final Optional<TreeNode> storeMeta,
58 final Version version) {
59 Optional<TreeNode> ret = modification.getValidatedNode(this, storeMeta);
61 // Deal with the result moving on us
62 ret = delegate.apply(modification, storeMeta, version);
63 if (ret.isPresent()) {
64 checkChildren(ret.get().getData());
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);
76 if (!(modification instanceof ModifiedNode)) {
77 LOG.debug("Could not validate {}, does not implement expected class {}", modification, ModifiedNode.class);
80 final ModifiedNode modified = (ModifiedNode) modification;
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. Note we should not be checking number
84 final Optional<TreeNode> maybeApplied = delegate.apply(modified, current, version);
85 if (maybeApplied.isPresent()) {
86 // We only enforce min/max on present data and rely on MandatoryLeafEnforcer to take care of the empty case
87 validateMinMaxElements(path, maybeApplied.get().getData());
90 // Everything passed. We now have a snapshot of the result node, it would be too bad if we just threw it out.
91 // We know what the result of an apply operation is going to be *if* the following are kept unchanged:
92 // - the 'current' node
93 // - the schemacontext (therefore, the fact this object is associated with the modification)
95 // So let's stash the result. We will pick it up during apply operation.
96 modified.setValidatedNode(this, current, maybeApplied);
100 void verifyStructure(final NormalizedNode<?, ?> modification, final boolean verifyChildren) {
101 delegate.verifyStructure(modification, verifyChildren);
102 if (verifyChildren) {
103 checkChildren(modification);
108 ChildTrackingPolicy getChildPolicy() {
109 return delegate.getChildPolicy();
113 void mergeIntoModifiedNode(final ModifiedNode node, final NormalizedNode<?, ?> value, final Version version) {
114 delegate.mergeIntoModifiedNode(node, value, version);
118 public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
119 return delegate.getChild(child);
123 void recursivelyVerifyStructure(final NormalizedNode<?, ?> value) {
124 delegate.recursivelyVerifyStructure(value);
127 private void validateMinMaxElements(final ModificationPath path, final NormalizedNode<?, ?> value)
128 throws DataValidationFailedException {
129 final PathArgument id = value.getIdentifier();
130 final int children = numOfChildrenFromValue(value);
131 if (minElements > children) {
132 throw new RequiredElementCountException(path.toInstanceIdentifier(), minElements, maxElements, children,
133 "%s does not have enough elements (%s), needs at least %s", id, children, minElements);
135 if (maxElements < children) {
136 throw new RequiredElementCountException(path.toInstanceIdentifier(), minElements, maxElements, children,
137 "%s has too many elements (%s), can have at most %s", id, children, maxElements);
141 private void checkChildren(final NormalizedNode<?, ?> value) {
142 final PathArgument id = value.getIdentifier();
143 final int children = numOfChildrenFromValue(value);
144 checkArgument(minElements <= children, "Node %s does not have enough elements (%s), needs at least %s", id,
145 children, minElements);
146 checkArgument(maxElements >= children, "Node %s has too many elements (%s), can have at most %s", id, children,
150 private static int numOfChildrenFromValue(final NormalizedNode<?, ?> value) {
151 if (value instanceof NormalizedNodeContainer) {
152 return ((NormalizedNodeContainer<?, ?, ?>) value).getValue().size();
153 } else if (value instanceof UnkeyedListNode) {
154 return ((UnkeyedListNode) value).getSize();
157 throw new IllegalArgumentException(String.format(
158 "Unexpected type '%s', expected types are NormalizedNodeContainer and UnkeyedListNode",