sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yms.app.ydt; |
| 18 | |
| 19 | import org.onosproject.yangutils.datamodel.YangSchemaNode; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 20 | import org.onosproject.yangutils.datamodel.YangSchemaNodeType; |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 21 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 22 | import org.onosproject.yms.app.ydt.exceptions.YdtException; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 23 | |
| 24 | import static org.onosproject.yangutils.datamodel.YangSchemaNodeType.YANG_MULTI_INSTANCE_LEAF_NODE; |
| 25 | import static org.onosproject.yangutils.datamodel.YangSchemaNodeType.YANG_MULTI_INSTANCE_NODE; |
| 26 | import static org.onosproject.yangutils.datamodel.YangSchemaNodeType.YANG_SINGLE_INSTANCE_LEAF_NODE; |
| 27 | import static org.onosproject.yangutils.datamodel.YangSchemaNodeType.YANG_SINGLE_INSTANCE_NODE; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 28 | import static org.onosproject.yms.app.ydt.YdtConstants.errorMsg; |
| 29 | |
| 30 | /** |
| 31 | * Represents an YANG node factory to create different types of YANG data tree |
| 32 | * node. |
| 33 | */ |
| 34 | final class YdtNodeFactory { |
| 35 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 36 | // YDT formatted error string |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 37 | private static final String FMT_NOT_EXIST = |
| 38 | "Schema node with name %s doesn't exist."; |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 39 | //TODO need to handle later |
| 40 | private static final String E_MULTI_INS = |
| 41 | "Requested interface adds an instance of type list or " + |
| 42 | "leaf-list node only."; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 43 | |
| 44 | // No instantiation |
| 45 | private YdtNodeFactory() { |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Returns a YANG data tree node for a given name, set of values and |
| 50 | * instance type. |
| 51 | * |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 52 | * @param node data node as per YANG schema metadata |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 53 | * @param cardinality requested cardinality of node |
| 54 | * @param callType identify the call type |
| 55 | * @return YANG data tree node |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 56 | * @throws YdtException when user requested node type doesn't exist |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 57 | */ |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 58 | static YdtNode getNode( |
| 59 | YangSchemaNode node, RequestedCardinality cardinality, |
| 60 | RequestedCallType callType) throws YdtException { |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 61 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 62 | YdtNode newNode; |
| 63 | YangSchemaNodeType type = node.getYangSchemaNodeType(); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 64 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 65 | try { |
| 66 | switch (cardinality) { |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 67 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 68 | case UNKNOWN: |
| 69 | /* |
| 70 | * if requested node type is UNKNOWN, check corresponding |
| 71 | * yang data node type and create respective type node. |
| 72 | */ |
| 73 | newNode = getYangSchemaNodeTypeSpecificContext(node, type, |
| 74 | callType); |
| 75 | break; |
| 76 | |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 77 | /* |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 78 | * if requested node type is specified and it exist as node of |
| 79 | * some other type in data model then throw exception |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 80 | */ |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 81 | case SINGLE_INSTANCE: |
| 82 | validateNodeType(node, type, YANG_SINGLE_INSTANCE_NODE); |
| 83 | newNode = new YdtSingleInstanceNode(node); |
| 84 | break; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 85 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 86 | case MULTI_INSTANCE: |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 87 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 88 | validateNodeType(node, type, YANG_MULTI_INSTANCE_NODE); |
| 89 | newNode = new YdtMultiInstanceNode(node); |
| 90 | break; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 91 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 92 | case SINGLE_INSTANCE_LEAF: |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 93 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 94 | validateNodeType(node, type, YANG_SINGLE_INSTANCE_LEAF_NODE); |
| 95 | newNode = new YdtSingleInstanceLeafNode(node); |
| 96 | break; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 97 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 98 | case MULTI_INSTANCE_LEAF: |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 99 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 100 | validateNodeType(node, type, YANG_MULTI_INSTANCE_LEAF_NODE); |
| 101 | newNode = new YdtMultiInstanceLeafNode(node); |
| 102 | break; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 103 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 104 | default: |
| 105 | newNode = null; |
| 106 | } |
| 107 | } catch (DataModelException | YdtException e) { |
| 108 | throw new YdtException(e.getLocalizedMessage()); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 109 | } |
| 110 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 111 | if (newNode == null) { |
| 112 | throw new YdtException(errorMsg(FMT_NOT_EXIST, node.getName())); |
| 113 | } |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 114 | |
| 115 | return newNode; |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Validates the requested ydt node type against the schema node type, |
| 120 | * if it is not equal then it will throw warning. |
| 121 | * |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 122 | * @param node schema node |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 123 | * @param nodeType actual node type |
| 124 | * @param requestedType user requested node type |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 125 | * @throws YdtException when user requested node type doesn't exist |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 126 | */ |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 127 | private static void validateNodeType( |
| 128 | YangSchemaNode node, YangSchemaNodeType nodeType, |
| 129 | YangSchemaNodeType requestedType) throws YdtException { |
| 130 | |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 131 | if (nodeType != requestedType) { |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 132 | throw new YdtException(errorMsg(FMT_NOT_EXIST, node.getName())); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 133 | } |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Creates Yang data tree node of YangSchemaNode type specific for |
| 138 | * requestedCardinality of type UNKNOWN and returns the same. |
| 139 | * |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 140 | * @param node schema node |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 141 | * @param nodeType schema node type as per YANG schema metadata |
| 142 | * @param callType identify the call type |
| 143 | * @return YANG data tree node |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 144 | * @throws YdtException when user requested node type doesn't exist |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 145 | */ |
| 146 | private static YdtNode getYangSchemaNodeTypeSpecificContext( |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 147 | YangSchemaNode node, YangSchemaNodeType nodeType, |
| 148 | RequestedCallType callType) throws YdtException, DataModelException { |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 149 | switch (callType) { |
| 150 | case LEAF: |
| 151 | switch (nodeType) { |
| 152 | |
| 153 | case YANG_SINGLE_INSTANCE_LEAF_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 154 | return new YdtSingleInstanceLeafNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 155 | |
| 156 | case YANG_MULTI_INSTANCE_LEAF_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 157 | return new YdtMultiInstanceLeafNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 158 | |
| 159 | default: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 160 | return null; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 161 | } |
| 162 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 163 | case NON_LEAF: |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 164 | switch (nodeType) { |
| 165 | |
| 166 | case YANG_SINGLE_INSTANCE_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 167 | return new YdtSingleInstanceNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 168 | |
| 169 | case YANG_MULTI_INSTANCE_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 170 | return new YdtMultiInstanceNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 171 | |
| 172 | default: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 173 | return null; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | case MULTI_INSTANCE: |
| 177 | switch (nodeType) { |
| 178 | |
| 179 | case YANG_MULTI_INSTANCE_LEAF_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 180 | return new YdtMultiInstanceLeafNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 181 | |
| 182 | case YANG_MULTI_INSTANCE_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 183 | return new YdtMultiInstanceNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 184 | |
| 185 | default: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 186 | throw new YdtException(E_MULTI_INS); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 187 | } |
| 188 | |
| 189 | default: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 190 | return null; |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 191 | } |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Create Yang data tree node of YangSchemaNode type specific and |
| 196 | * returns the same. |
| 197 | * |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 198 | * @param node schema node |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 199 | * @return YANG data tree node |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 200 | * @throws YdtException when user requested node type doesn't exist |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 201 | */ |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 202 | static YdtNode getYangSchemaNodeTypeSpecificContext(YangSchemaNode node) |
| 203 | throws YdtException { |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 204 | |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 205 | switch (node.getYangSchemaNodeType()) { |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 206 | |
| 207 | case YANG_SINGLE_INSTANCE_LEAF_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 208 | return new YdtSingleInstanceLeafNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 209 | |
| 210 | case YANG_MULTI_INSTANCE_LEAF_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 211 | return new YdtMultiInstanceLeafNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 212 | |
| 213 | case YANG_SINGLE_INSTANCE_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 214 | return new YdtSingleInstanceNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 215 | |
| 216 | case YANG_MULTI_INSTANCE_NODE: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 217 | return new YdtMultiInstanceNode(node); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 218 | |
| 219 | default: |
sonu gupta | eff184b | 2016-11-24 12:43:49 +0530 | [diff] [blame^] | 220 | throw new YdtException(errorMsg(FMT_NOT_EXIST, node.getName())); |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 221 | } |
sonu gupta | 1bb37b8 | 2016-11-11 16:51:18 +0530 | [diff] [blame] | 222 | } |
| 223 | } |