yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/impl/valid/DataValidationException.java

   1 /*
   2  * Copyright (c) 2013 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.builder.impl.valid;
   9
  10 import java.util.Map;
  11 import java.util.Set;
  12 import org.opendaylight.yangtools.yang.common.QName;
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  14 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  15 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  16 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  17 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  18
  19 public class DataValidationException extends RuntimeException {
  20     private static final long serialVersionUID = 1L;
  21
  22     public DataValidationException(final String message) {
  23         super(message);
  24     }
  25
  26     public static void checkLegalChild(final boolean isLegal, final YangInstanceIdentifier.PathArgument child, final DataNodeContainer schema,
  27             final Set<QName> childNodes, final Set<YangInstanceIdentifier.AugmentationIdentifier> augments) {
  28         if (!isLegal) {
  29             throw new IllegalChildException(child, schema, childNodes, augments);
  30         }
  31     }
  32
  33     public static void checkLegalChild(final boolean isLegal, final YangInstanceIdentifier.PathArgument child, final DataSchemaNode schema,
  34             final Set<QName> childNodes) {
  35         if (!isLegal) {
  36             throw new IllegalChildException(child, schema, childNodes);
  37         }
  38     }
  39
  40     public static void checkLegalChild(final boolean isLegal, final YangInstanceIdentifier.PathArgument child, final ChoiceNode schema) {
  41         if (!isLegal) {
  42             throw new IllegalChildException(child, schema);
  43         }
  44     }
  45
  46     public static void checkLegalData(final boolean isLegal, final String messageTemplate, final Object... messageAttrs) {
  47         if (!isLegal) {
  48             throw new DataValidationException(String.format(messageTemplate, messageAttrs));
  49         }
  50     }
  51
  52     public static void checkListKey(final DataContainerChild<?, ?> childNode, final Map<QName, Object> keyValues, final QName keyQName,
  53             final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeId) {
  54         checkListKey(childNode, keyQName, nodeId);
  55
  56         Object expectedValue = nodeId.getKeyValues().get(keyQName);
  57         Object actualValue = childNode.getValue();
  58     }
  59
  60     public static void checkListKey(final DataContainerChild<?, ?> childNode, final QName keyQName, final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeId) {
  61         if (childNode == null) {
  62             throw new IllegalListKeyException(keyQName, nodeId);
  63         }
  64     }
  65
  66     static final class IllegalChildException extends DataValidationException {
  67         private static final long serialVersionUID = 1L;
  68
  69         public IllegalChildException(final YangInstanceIdentifier.PathArgument child, final DataNodeContainer schema,
  70                 final Set<QName> childNodes, final Set<YangInstanceIdentifier.AugmentationIdentifier> augments) {
  71             super(String.format("Unknown child node: %s, does not belong to: %s as a direct child. "
  72                     + "Direct child nodes: %s, augmented child nodes: %s", child, schema, childNodes, augments));
  73         }
  74
  75         public IllegalChildException(final YangInstanceIdentifier.PathArgument child, final ChoiceNode schema) {
  76             super(String.format("Unknown child node: %s, not detected in choice: %s", child, schema));
  77         }
  78
  79         public IllegalChildException(final YangInstanceIdentifier.PathArgument child, final DataSchemaNode schema, final Set<QName> childNodes) {
  80             super(String.format("Unknown child node: %s, does not belong to: %s as a child. "
  81                     + "Child nodes: %s", child, schema, childNodes));
  82         }
  83     }
  84
  85     static final class IllegalListKeyException extends DataValidationException {
  86         private static final long serialVersionUID = 1L;
  87
  88         public IllegalListKeyException(final QName keyQName, final YangInstanceIdentifier.NodeIdentifierWithPredicates id) {
  89             super(String.format("Key value not present for key: %s, in: %s", keyQName, id));
  90         }
  91
  92         public IllegalListKeyException(final QName keyQName, final YangInstanceIdentifier.NodeIdentifierWithPredicates id, final Object actualValue, final Object expectedValue) {
  93             super(String.format("Illegal value for key: %s, in: %s, actual value: %s, expected value from key: %s", keyQName, id, actualValue, expectedValue));
  94         }
  95     }
  96 }