Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +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.yangutils.translator.tojava.javamodel; |
| 18 | |
| 19 | import java.io.IOException; |
| 20 | |
| 21 | import org.onosproject.yangutils.datamodel.RpcNotificationContainer; |
| 22 | import org.onosproject.yangutils.datamodel.YangInput; |
| 23 | import org.onosproject.yangutils.datamodel.YangNode; |
| 24 | import org.onosproject.yangutils.datamodel.YangOutput; |
| 25 | import org.onosproject.yangutils.datamodel.YangRpc; |
| 26 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
| 27 | import org.onosproject.yangutils.translator.tojava.JavaAttributeInfo; |
| 28 | import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator; |
| 29 | import org.onosproject.yangutils.translator.tojava.JavaFileInfo; |
| 30 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoContainer; |
| 31 | import org.onosproject.yangutils.translator.tojava.JavaQualifiedTypeInfo; |
| 32 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
| 33 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFilesContainer; |
| 34 | import org.onosproject.yangutils.translator.tojava.TempJavaFragmentFiles; |
| 35 | import org.onosproject.yangutils.translator.tojava.utils.YangPluginConfig; |
| 36 | |
| 37 | import static org.onosproject.yangutils.datamodel.utils.DataModelUtils.getParentNodeInGenCode; |
| 38 | import static org.onosproject.yangutils.translator.tojava.JavaAttributeInfo.getAttributeInfoForTheData; |
| 39 | import static org.onosproject.yangutils.translator.tojava.JavaQualifiedTypeInfo.getQualifiedTypeInfoOfCurNode; |
| 40 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCapitalCase; |
| 41 | import static org.onosproject.yangutils.translator.tojava.utils.YangJavaModelUtils.updatePackageInfo; |
| 42 | import static org.onosproject.yangutils.utils.UtilConstants.ACTIVATE; |
| 43 | import static org.onosproject.yangutils.utils.UtilConstants.COMPONENT; |
| 44 | import static org.onosproject.yangutils.utils.UtilConstants.DEACTIVATE; |
| 45 | import static org.onosproject.yangutils.utils.UtilConstants.MANAGER; |
| 46 | import static org.onosproject.yangutils.utils.UtilConstants.REFERENCE; |
| 47 | import static org.onosproject.yangutils.utils.UtilConstants.REFERENCE_CARDINALITY; |
| 48 | import static org.onosproject.yangutils.utils.UtilConstants.SERVICE; |
| 49 | |
| 50 | /** |
| 51 | * Represents rpc information extended to support java code generation. |
| 52 | */ |
| 53 | public class YangJavaRpc |
| 54 | extends YangRpc |
| 55 | implements JavaCodeGenerator, JavaCodeGeneratorInfo { |
| 56 | |
| 57 | private static final long serialVersionUID = 806201622L; |
| 58 | |
| 59 | /** |
| 60 | * Contains the information of the java file being generated. |
| 61 | */ |
| 62 | private JavaFileInfo javaFileInfo; |
| 63 | |
| 64 | /** |
| 65 | * Temproary file for code generation. |
| 66 | */ |
| 67 | private transient TempJavaCodeFragmentFiles tempJavaCodeFragmentFiles; |
| 68 | |
| 69 | /** |
| 70 | * Creates an instance of YANG java rpc. |
| 71 | */ |
| 72 | public YangJavaRpc() { |
| 73 | super(); |
| 74 | setJavaFileInfo(new JavaFileInfo()); |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Returns the generated java file information. |
| 79 | * |
| 80 | * @return generated java file information |
| 81 | */ |
| 82 | @Override |
| 83 | public JavaFileInfo getJavaFileInfo() { |
| 84 | |
| 85 | if (javaFileInfo == null) { |
| 86 | throw new TranslatorException("missing java info in java datamodel node"); |
| 87 | } |
| 88 | return javaFileInfo; |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Sets the java file info object. |
| 93 | * |
| 94 | * @param javaInfo java file info object |
| 95 | */ |
| 96 | @Override |
| 97 | public void setJavaFileInfo(JavaFileInfo javaInfo) { |
| 98 | javaFileInfo = javaInfo; |
| 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() { |
| 103 | return tempJavaCodeFragmentFiles; |
| 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) { |
| 108 | tempJavaCodeFragmentFiles = fileHandle; |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Prepares the information for java code generation corresponding to YANG |
| 113 | * RPC info. |
| 114 | * |
| 115 | * @param yangPlugin YANG plugin config |
| 116 | * @throws TranslatorException translator operations fails |
| 117 | */ |
| 118 | @Override |
| 119 | public void generateCodeEntry(YangPluginConfig yangPlugin) |
| 120 | throws TranslatorException { |
| 121 | |
| 122 | // Add package information for rpc and create corresponding folder. |
| 123 | try { |
| 124 | updatePackageInfo(this, yangPlugin); |
| 125 | } catch (IOException e) { |
| 126 | throw new TranslatorException("Failed to prepare generate code entry for RPC node " + getName()); |
| 127 | } |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Creates a java file using the YANG RPC info. |
| 132 | * |
| 133 | * @throws TranslatorException translator operations fails |
| 134 | */ |
| 135 | @Override |
| 136 | public void generateCodeExit() |
| 137 | throws TranslatorException { |
| 138 | // Get the parent module/sub-module. |
| 139 | YangNode parent = getParentNodeInGenCode(this); |
| 140 | |
| 141 | // Parent should be holder of rpc or notification. |
| 142 | if (!(parent instanceof RpcNotificationContainer)) { |
| 143 | throw new TranslatorException("parent node of rpc can only be module or sub-module"); |
| 144 | } |
| 145 | |
| 146 | /* |
| 147 | * Create attribute info for input and output of rpc and add it to the |
| 148 | * parent import list. |
| 149 | */ |
| 150 | |
| 151 | JavaAttributeInfo javaAttributeInfoOfInput = null; |
| 152 | JavaAttributeInfo javaAttributeInfoOfOutput = null; |
| 153 | |
| 154 | // Get the child input and output node and obtain create java attribute |
| 155 | // info. |
| 156 | YangNode yangNode = getChild(); |
| 157 | while (yangNode != null) { |
| 158 | if (yangNode instanceof YangInput) { |
| 159 | javaAttributeInfoOfInput = getChildNodeAsAttributeInParentService(yangNode, this); |
| 160 | |
| 161 | } else if (yangNode instanceof YangOutput) { |
| 162 | javaAttributeInfoOfOutput = getChildNodeAsAttributeInParentService(yangNode, this); |
| 163 | } else { |
| 164 | throw new TranslatorException("RPC should contain only input/output child nodes."); |
| 165 | } |
| 166 | yangNode = yangNode.getNextSibling(); |
| 167 | } |
| 168 | |
| 169 | if (!(parent instanceof TempJavaCodeFragmentFilesContainer)) { |
| 170 | throw new TranslatorException("missing parent temp file handle"); |
| 171 | } |
| 172 | |
| 173 | /* |
| 174 | * Add the rpc information to the parent's service temp file. |
| 175 | */ |
| 176 | try { |
| 177 | |
| 178 | ((TempJavaCodeFragmentFilesContainer) parent).getTempJavaCodeFragmentFiles().getServiceTempFiles() |
| 179 | .addJavaSnippetInfoToApplicableTempFiles(javaAttributeInfoOfInput, javaAttributeInfoOfOutput, |
| 180 | ((JavaFileInfoContainer) parent).getJavaFileInfo().getPluginConfig(), getName()); |
| 181 | |
| 182 | } catch (IOException e) { |
| 183 | throw new TranslatorException("Failed to generate code for RPC node " + getName()); |
| 184 | } |
| 185 | // No file will be generated during RPC exit. |
| 186 | } |
| 187 | |
| 188 | /** |
| 189 | * Creates an attribute info object corresponding to a data model node and |
| 190 | * return it. |
| 191 | * |
| 192 | * @param childNode child data model node(input / output) for which the java code generation |
| 193 | * is being handled |
| 194 | * @param currentNode parent node (module / sub-module) in which the child node is an attribute |
| 195 | * @return AttributeInfo attribute details required to add in temporary |
| 196 | * files |
| 197 | */ |
| 198 | public JavaAttributeInfo getChildNodeAsAttributeInParentService( |
| 199 | YangNode childNode, YangNode currentNode) { |
| 200 | |
| 201 | YangNode parentNode = getParentNodeInGenCode(currentNode); |
| 202 | |
| 203 | String childNodeName = ((JavaFileInfoContainer) childNode).getJavaFileInfo().getJavaName(); |
| 204 | /* |
| 205 | * Get the import info corresponding to the attribute for import in |
| 206 | * generated java files or qualified access |
| 207 | */ |
| 208 | JavaQualifiedTypeInfo qualifiedTypeInfo = getQualifiedTypeInfoOfCurNode(childNode, |
| 209 | getCapitalCase(childNodeName)); |
| 210 | if (!(parentNode instanceof TempJavaCodeFragmentFilesContainer)) { |
| 211 | throw new TranslatorException("Parent node does not have file info"); |
| 212 | } |
| 213 | |
| 214 | TempJavaFragmentFiles tempJavaFragmentFiles; |
| 215 | tempJavaFragmentFiles = ((TempJavaCodeFragmentFilesContainer) parentNode) |
| 216 | .getTempJavaCodeFragmentFiles() |
| 217 | .getServiceTempFiles(); |
| 218 | |
| 219 | if (tempJavaFragmentFiles == null) { |
| 220 | throw new TranslatorException("Parent node does not have service file info"); |
| 221 | } |
| 222 | boolean isQualified = addImportToService(qualifiedTypeInfo); |
| 223 | return getAttributeInfoForTheData(qualifiedTypeInfo, childNodeName, null, isQualified, false); |
| 224 | } |
| 225 | |
| 226 | /** |
| 227 | * Adds to service class import list. |
| 228 | * |
| 229 | * @param importInfo import info |
| 230 | * @return true or false |
| 231 | */ |
| 232 | private boolean addImportToService(JavaQualifiedTypeInfo importInfo) { |
| 233 | JavaFileInfo fileInfo = ((JavaFileInfoContainer) getParent()).getJavaFileInfo(); |
| 234 | |
| 235 | if (importInfo.getClassInfo().contentEquals(SERVICE) |
| 236 | || importInfo.getClassInfo().contentEquals(COMPONENT) |
| 237 | || importInfo.getClassInfo().contentEquals(getCapitalCase(ACTIVATE)) |
| 238 | || importInfo.getClassInfo().contentEquals(getCapitalCase(DEACTIVATE)) |
| 239 | || importInfo.getClassInfo().contentEquals(REFERENCE_CARDINALITY) |
| 240 | || importInfo.getClassInfo().contentEquals(REFERENCE) |
| 241 | || importInfo.getClassInfo().contentEquals(getCapitalCase(fileInfo.getJavaName() + SERVICE)) |
| 242 | || importInfo.getClassInfo().contentEquals(getCapitalCase(fileInfo.getJavaName() + MANAGER))) { |
| 243 | return true; |
| 244 | } |
| 245 | |
| 246 | String className; |
| 247 | className = getCapitalCase(fileInfo.getJavaName()) + "Service"; |
| 248 | |
| 249 | return ((TempJavaCodeFragmentFilesContainer) getParent()).getTempJavaCodeFragmentFiles() |
| 250 | .getServiceTempFiles().getJavaImportData().addImportInfo(importInfo, |
| 251 | className, fileInfo.getPackage()); |
| 252 | } |
| 253 | |
| 254 | } |