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