Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 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 | package org.onosproject.yangutils.translator.tojava.javamodel; |
| 17 | |
| 18 | import java.io.IOException; |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 19 | import java.util.ArrayList; |
| 20 | import java.util.List; |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 21 | |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.YangNode; |
| 23 | import org.onosproject.yangutils.datamodel.YangNotification; |
Shankara-Huawei | bdf24bb | 2016-08-02 18:13:13 +0530 | [diff] [blame^] | 24 | import org.onosproject.yangutils.datamodel.javadatamodel.JavaFileInfo; |
| 25 | import org.onosproject.yangutils.datamodel.javadatamodel.YangJavaModule; |
| 26 | import org.onosproject.yangutils.datamodel.javadatamodel.YangPluginConfig; |
Bharat saraswal | 6ef0b76 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 27 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 28 | import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator; |
Gaurav Agrawal | 8a5af14 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo; |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
| 31 | |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_ALL_EVENT_CLASS_MASK; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_INTERFACE_WITH_BUILDER; |
VinodKumarS-Huawei | cb3a1f5 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_SERVICE_AND_MANAGER; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 35 | import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.generateCodeOfRootNode; |
Bharat saraswal | b551aae | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 36 | import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.isGenerationOfCodeReq; |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.isManagerCodeGenRequired; |
Bharat saraswal | b1170bd | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getRootPackage; |
Shankara-Huawei | b9999eb | 2016-07-14 16:53:09 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.utils.UtilConstants.SBI; |
Bharat saraswal | e707f03 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 40 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.searchAndDeleteTempDir; |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 41 | |
| 42 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 43 | * Represents module information extended to support java code generation. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 44 | */ |
Shankara-Huawei | bdf24bb | 2016-08-02 18:13:13 +0530 | [diff] [blame^] | 45 | public class YangJavaModuleTranslator |
| 46 | extends YangJavaModule |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 47 | implements JavaCodeGeneratorInfo, JavaCodeGenerator { |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 48 | |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 49 | private static final long serialVersionUID = 806201625L; |
| 50 | |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 51 | /** |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 52 | * File handle to maintain temporary java code fragments as per the code snippet types. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 53 | */ |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 54 | private transient TempJavaCodeFragmentFiles tempFileHandle; |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 55 | |
| 56 | /** |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 57 | * List of notifications nodes. |
| 58 | */ |
Bharat saraswal | b1170bd | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 59 | private transient List<YangNode> notificationNodes; |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 60 | |
| 61 | /** |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 62 | * Creates a YANG node of module type. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 63 | */ |
Shankara-Huawei | bdf24bb | 2016-08-02 18:13:13 +0530 | [diff] [blame^] | 64 | public YangJavaModuleTranslator() { |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 65 | super(); |
| 66 | setJavaFileInfo(new JavaFileInfo()); |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 67 | setNotificationNodes(new ArrayList<>()); |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 68 | getJavaFileInfo().setGeneratedFileTypes(GENERATE_SERVICE_AND_MANAGER | GENERATE_INTERFACE_WITH_BUILDER); |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 69 | |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 73 | * Returns the generated java file information. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 74 | * |
| 75 | * @return generated java file information |
| 76 | */ |
| 77 | @Override |
| 78 | public JavaFileInfo getJavaFileInfo() { |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 79 | if (javaFileInfo == null) { |
Bharat saraswal | 6ef0b76 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 80 | throw new TranslatorException("Missing java info in java datamodel node"); |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 81 | } |
| 82 | return javaFileInfo; |
| 83 | } |
| 84 | |
| 85 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 86 | * Sets the java file info object. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 87 | * |
| 88 | * @param javaInfo java file info object |
| 89 | */ |
| 90 | @Override |
| 91 | public void setJavaFileInfo(JavaFileInfo javaInfo) { |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 92 | javaFileInfo = javaInfo; |
| 93 | } |
| 94 | |
| 95 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 96 | * Returns the temporary file handle. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 97 | * |
| 98 | * @return temporary file handle |
| 99 | */ |
| 100 | @Override |
| 101 | public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() { |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 102 | return tempFileHandle; |
| 103 | } |
| 104 | |
| 105 | /** |
Bharat saraswal | d9822e9 | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 106 | * Sets temporary file handle. |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 107 | * |
| 108 | * @param fileHandle temporary file handle |
| 109 | */ |
| 110 | @Override |
| 111 | public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) { |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 112 | tempFileHandle = fileHandle; |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * Generates java code for module. |
| 117 | * |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 118 | * @param yangPlugin YANG plugin config |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 119 | * @throws TranslatorException when fails to generate the source files |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 120 | */ |
| 121 | @Override |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 122 | public void generateCodeEntry(YangPluginConfig yangPlugin) throws TranslatorException { |
janani b | dd1314f | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 123 | String modulePkg = getRootPackage(getVersion(), getNameSpace().getUri(), getRevision().getRevDate(), |
| 124 | yangPlugin.getConflictResolver()); |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 125 | |
| 126 | if (isNotificationChildNodePresent(this)) { |
| 127 | getJavaFileInfo().setGeneratedFileTypes(getJavaFileInfo().getGeneratedFileTypes() |
| 128 | | GENERATE_ALL_EVENT_CLASS_MASK); |
| 129 | } |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 130 | try { |
| 131 | generateCodeOfRootNode(this, yangPlugin, modulePkg); |
| 132 | } catch (IOException e) { |
| 133 | throw new TranslatorException( |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 134 | "Failed to prepare generate code entry for module node " + getName()); |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 135 | } |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 136 | } |
| 137 | |
Vidyashree Rama | 7445371 | 2016-04-18 12:29:39 +0530 | [diff] [blame] | 138 | /** |
| 139 | * Creates a java file using the YANG module info. |
| 140 | */ |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 141 | @Override |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 142 | public void generateCodeExit() throws TranslatorException { |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 143 | /** |
| 144 | * As part of the notification support the following files needs to be generated. |
| 145 | * 1) Subject of the notification(event), this is simple interface with builder class. |
| 146 | * 2) Event class extending "AbstractEvent" and defining event type enum. |
| 147 | * 3) Event listener interface extending "EventListener". |
| 148 | * 4) Event subject class. |
| 149 | * |
| 150 | * The manager class needs to extend the "ListenerRegistry". |
| 151 | */ |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 152 | try { |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 153 | if ((getJavaFileInfo().getGeneratedFileTypes() & GENERATE_ALL_EVENT_CLASS_MASK) != 0) { |
| 154 | getTempJavaCodeFragmentFiles().generateJavaFile(GENERATE_ALL_EVENT_CLASS_MASK, this); |
| 155 | } |
| 156 | getTempJavaCodeFragmentFiles() |
| 157 | .generateJavaFile(GENERATE_INTERFACE_WITH_BUILDER, this); |
| 158 | if (isManagerCodeGenRequired(this)) { |
| 159 | if (isGenerationOfCodeReq(getJavaFileInfo())) { |
| 160 | if ((getJavaFileInfo().getPluginConfig().getCodeGenerateForsbi() == null) |
Shankara-Huawei | bdf24bb | 2016-08-02 18:13:13 +0530 | [diff] [blame^] | 161 | || (!getJavaFileInfo().getPluginConfig().getCodeGenerateForsbi().equals(SBI))) { |
| 162 | getTempJavaCodeFragmentFiles().getServiceTempFiles().setManagerNeedToBeGenerated(true); |
| 163 | } |
Shankara-Huawei | b9999eb | 2016-07-14 16:53:09 +0530 | [diff] [blame] | 164 | } |
Bharat saraswal | b1170bd | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 165 | } |
Bharat saraswal | d50c638 | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 166 | getTempJavaCodeFragmentFiles().generateJavaFile(GENERATE_SERVICE_AND_MANAGER, this); |
| 167 | |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 168 | searchAndDeleteTempDir(getJavaFileInfo().getBaseCodeGenPath() + |
| 169 | getJavaFileInfo().getPackageFilePath()); |
Bharat saraswal | b1170bd | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 170 | searchAndDeleteTempDir(getJavaFileInfo().getPluginConfig().getCodeGenDir() + |
| 171 | getJavaFileInfo().getPackageFilePath()); |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 172 | } catch (IOException e) { |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 173 | throw new TranslatorException("Failed to generate code for module node " + getName()); |
Bharat saraswal | ab4c6ba | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 174 | } |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 175 | } |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 176 | |
| 177 | /** |
| 178 | * Returns notifications node list. |
| 179 | * |
| 180 | * @return notification nodes |
| 181 | */ |
| 182 | public List<YangNode> getNotificationNodes() { |
| 183 | return notificationNodes; |
| 184 | } |
| 185 | |
| 186 | /** |
| 187 | * Sets notifications list. |
| 188 | * |
| 189 | * @param notificationNodes notification list |
| 190 | */ |
| 191 | private void setNotificationNodes(List<YangNode> notificationNodes) { |
| 192 | this.notificationNodes = notificationNodes; |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * Adds to notification node list. |
| 197 | * |
| 198 | * @param curNode notification node |
| 199 | */ |
| 200 | private void addToNotificaitonList(YangNode curNode) { |
| 201 | getNotificationNodes().add(curNode); |
| 202 | } |
| 203 | |
| 204 | /** |
| 205 | * Checks if there is any rpc defined in the module or sub-module. |
| 206 | * |
| 207 | * @param rootNode root node of the data model |
| 208 | * @return status of rpc's existence |
| 209 | */ |
Bharat saraswal | e707f03 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 210 | private boolean isNotificationChildNodePresent(YangNode rootNode) { |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 211 | YangNode childNode = rootNode.getChild(); |
| 212 | |
| 213 | while (childNode != null) { |
| 214 | if (childNode instanceof YangNotification) { |
| 215 | addToNotificaitonList(childNode); |
| 216 | } |
| 217 | childNode = childNode.getNextSibling(); |
| 218 | } |
| 219 | |
Bharat saraswal | e707f03 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 220 | return !getNotificationNodes().isEmpty(); |
Bharat saraswal | 33dfa01 | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 221 | } |
Vinod Kumar S | 3804650 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 222 | } |