Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59: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 | |
| 17 | package org.onosproject.yangutils.translator.tojava.javamodel; |
| 18 | |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 19 | import org.onosproject.yangutils.datamodel.RpcNotificationContainer; |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 20 | import org.onosproject.yangutils.datamodel.YangNode; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.datamodel.javadatamodel.YangJavaNotification; |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 23 | import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator; |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 24 | import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo; |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 25 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoContainer; |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 26 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoTranslator; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 27 | import org.onosproject.yangutils.translator.tojava.JavaQualifiedTypeInfoTranslator; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 28 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFilesContainer; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.translator.tojava.TempJavaServiceFragmentFiles; |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 31 | import org.onosproject.yangutils.translator.tojava.utils.JavaExtendsListHolder; |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 32 | import org.onosproject.yangutils.utils.io.YangPluginConfig; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 33 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 34 | import java.io.IOException; |
| 35 | |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 36 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_INTERFACE_WITH_BUILDER; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.generateCodeOfAugmentableNode; |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getEnumJavaAttribute; |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.translator.tojava.utils.TranslatorErrorType.FAIL_AT_ENTRY; |
| 40 | import static org.onosproject.yangutils.translator.tojava.utils.TranslatorErrorType.FAIL_AT_EXIT; |
| 41 | import static org.onosproject.yangutils.translator.tojava.utils.TranslatorErrorType.INVALID_NODE; |
| 42 | import static org.onosproject.yangutils.translator.tojava.utils.TranslatorUtils.getErrorMsg; |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 43 | import static org.onosproject.yangutils.utils.UtilConstants.EVENT_LISTENER_STRING; |
| 44 | import static org.onosproject.yangutils.utils.UtilConstants.EVENT_STRING; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 45 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCapitalCase; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 46 | |
| 47 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 48 | * Represents notification information extended to support java code generation. |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 49 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 50 | public class YangJavaNotificationTranslator |
| 51 | extends YangJavaNotification |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 52 | implements JavaCodeGenerator, JavaCodeGeneratorInfo { |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 53 | |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 54 | private static final long serialVersionUID = 806201624L; |
| 55 | |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 56 | /** |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 57 | * File handle to maintain temporary java code fragments as per the code |
| 58 | * snippet types. |
| 59 | */ |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 60 | private transient TempJavaCodeFragmentFiles tempFileHandle; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 61 | |
| 62 | /** |
| 63 | * Creates an instance of java Notification. |
| 64 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 65 | public YangJavaNotificationTranslator() { |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 66 | setJavaFileInfo(new JavaFileInfoTranslator()); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 67 | getJavaFileInfo().setGeneratedFileTypes(GENERATE_INTERFACE_WITH_BUILDER); |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Returns the generated java file information. |
| 72 | * |
| 73 | * @return generated java file information |
| 74 | */ |
| 75 | @Override |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 76 | public JavaFileInfoTranslator getJavaFileInfo() { |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 77 | |
| 78 | if (javaFileInfo == null) { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 79 | throw new TranslatorException(getErrorMsg(INVALID_NODE, this)); |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 80 | } |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 81 | return (JavaFileInfoTranslator) javaFileInfo; |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 85 | * Sets the java file info object. |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 86 | * |
| 87 | * @param javaInfo java file info object |
| 88 | */ |
| 89 | @Override |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 90 | public void setJavaFileInfo(JavaFileInfoTranslator javaInfo) { |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 91 | javaFileInfo = javaInfo; |
| 92 | } |
| 93 | |
| 94 | /** |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 95 | * Returns the temporary file handle. |
| 96 | * |
| 97 | * @return temporary file handle |
| 98 | */ |
| 99 | @Override |
| 100 | public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() { |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 101 | return tempFileHandle; |
| 102 | } |
| 103 | |
| 104 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 105 | * Sets temporary file handle. |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 106 | * |
| 107 | * @param fileHandle temporary file handle |
| 108 | */ |
| 109 | @Override |
| 110 | public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) { |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 111 | tempFileHandle = fileHandle; |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Prepare the information for java code generation corresponding to YANG |
| 116 | * notification info. |
| 117 | * |
janani b | 1c6acc4 | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 118 | * @param yangPlugin YANG plugin config |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 119 | * @throws TranslatorException translator operation fail |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 120 | */ |
| 121 | @Override |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 122 | public void generateCodeEntry(YangPluginConfig yangPlugin) |
| 123 | throws TranslatorException { |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 124 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 125 | /* |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 126 | * As part of the notification support the following files needs to be |
| 127 | * generated. |
| 128 | * 1) Subject of the notification(event), this is simple interface with |
| 129 | * builder class. |
| 130 | * 2) Event class extending "AbstractEvent" and defining event type |
| 131 | * enum. |
VinodKumarS-Huawei | 6266db3 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 132 | * 3) Event listener interface extending "EventListener". |
| 133 | * |
| 134 | * The manager class needs to extend the ListenerRegistry. |
| 135 | */ |
Ray Milkey | 85971c6 | 2016-05-11 18:39:39 +0000 | [diff] [blame] | 136 | |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 137 | // Generate subject of the notification(event), this is simple interface |
| 138 | // with builder class. |
| 139 | try { |
| 140 | generateCodeOfAugmentableNode(this, yangPlugin); |
| 141 | addNotificationToExtendsList(); |
| 142 | } catch (IOException e) { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 143 | throw new TranslatorException(getErrorMsg(FAIL_AT_ENTRY, this, |
| 144 | e.getLocalizedMessage())); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 145 | } |
| 146 | } |
Ray Milkey | 85971c6 | 2016-05-11 18:39:39 +0000 | [diff] [blame] | 147 | |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 148 | /*Adds current notification info to the extends list so its parents service*/ |
| 149 | private void addNotificationToExtendsList() { |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 150 | YangNode parent = getParent(); |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 151 | TempJavaServiceFragmentFiles tempFiles = |
| 152 | ((TempJavaCodeFragmentFilesContainer) parent).getTempJavaCodeFragmentFiles() |
| 153 | .getServiceTempFiles(); |
| 154 | JavaExtendsListHolder holder = tempFiles.getJavaExtendsListHolder(); |
| 155 | JavaQualifiedTypeInfoTranslator event = |
| 156 | new JavaQualifiedTypeInfoTranslator(); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 157 | |
| 158 | String parentInfo = getCapitalCase(((JavaFileInfoContainer) parent) |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 159 | .getJavaFileInfo() |
| 160 | .getJavaName()); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 161 | event.setClassInfo(parentInfo + EVENT_STRING); |
| 162 | event.setPkgInfo(getJavaFileInfo().getPackage()); |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 163 | holder.addToExtendsList(event, parent, tempFiles); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 164 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 165 | JavaQualifiedTypeInfoTranslator eventListener = |
| 166 | new JavaQualifiedTypeInfoTranslator(); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 167 | |
| 168 | eventListener.setClassInfo(parentInfo + EVENT_LISTENER_STRING); |
| 169 | eventListener.setPkgInfo(getJavaFileInfo().getPackage()); |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 170 | holder.addToExtendsList(eventListener, parent, tempFiles); |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | /** |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 174 | * Creates a java file using the YANG notification info. |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 175 | */ |
| 176 | @Override |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 177 | public void generateCodeExit() |
| 178 | throws TranslatorException { |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 179 | try { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 180 | getTempJavaCodeFragmentFiles().generateJavaFile( |
| 181 | GENERATE_INTERFACE_WITH_BUILDER, this); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 182 | } catch (IOException e) { |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 183 | throw new TranslatorException(getErrorMsg(FAIL_AT_EXIT, this, |
| 184 | e.getLocalizedMessage())); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 185 | } |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 186 | } |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 187 | |
| 188 | @Override |
| 189 | public void setNameSpaceAndAddToParentSchemaMap() { |
| 190 | // Get parent namespace. |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 191 | if (getParent() != null) { |
| 192 | String nameSpace = getParent().getNameSpace(); |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 193 | // Set namespace for self node. |
| 194 | setNameSpace(nameSpace); |
| 195 | // Process addition of leaf to the child schema map of parent. |
| 196 | processAdditionOfSchemaNodeToParentMap(getName(), getNameSpace()); |
| 197 | // Obtain the notification name as per enum in notification. |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 198 | String enumName = getEnumJavaAttribute(getName().toUpperCase()); |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 199 | |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 200 | ((RpcNotificationContainer) getParent()) |
| 201 | .addToNotificationEnumMap(enumName, this); |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 202 | |
| 203 | } |
| 204 | /* |
| 205 | * Check if node contains leaf/leaf-list, if yes add namespace for leaf |
| 206 | * and leaf list. |
| 207 | */ |
Gaurav Agrawal | 3b57f36 | 2016-09-07 13:16:35 +0530 | [diff] [blame] | 208 | setLeafNameSpaceAndAddToParentSchemaMap(); |
Gaurav Agrawal | 61edaa0 | 2016-08-31 16:52:56 +0530 | [diff] [blame] | 209 | } |
Vidyashree Rama | 620b6e9 | 2016-03-28 11:59:27 +0530 | [diff] [blame] | 210 | } |