2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.openecomp.sdc.generator.aai;
23 import org.openecomp.sdc.logging.api.Logger;
24 import org.openecomp.sdc.logging.api.LoggerFactory;
25 import org.openecomp.sdc.generator.aai.model.Resource;
26 import org.openecomp.sdc.generator.aai.model.Service;
27 import org.openecomp.sdc.generator.aai.model.Widget;
28 import org.openecomp.sdc.generator.aai.xml.Model;
29 import org.openecomp.sdc.generator.aai.xml.ModelElement;
30 import org.openecomp.sdc.generator.aai.xml.ModelElements;
31 import org.openecomp.sdc.generator.aai.xml.ModelVer;
32 import org.openecomp.sdc.generator.aai.xml.ModelVers;
33 import org.openecomp.sdc.generator.aai.xml.Relationship;
34 import org.openecomp.sdc.generator.aai.xml.RelationshipData;
35 import org.openecomp.sdc.generator.aai.xml.RelationshipList;
36 import org.openecomp.sdc.generator.logging.annotations.Metrics;
37 import org.w3c.dom.DOMException;
39 import java.io.StringWriter;
40 import java.util.List;
42 import javax.xml.bind.JAXBContext;
43 import javax.xml.bind.JAXBException;
44 import javax.xml.bind.Marshaller;
47 * Implementation of the {@link AaiModelGenerator} which generates the XML models from the
48 * Service/Resource/Widget java models.
50 public class AaiModelGeneratorImpl implements AaiModelGenerator {
51 private static Logger log = LoggerFactory.getLogger(AaiModelGeneratorImpl.class.getName());
54 * Method to generate the AAI model for a Service.
56 * @param service Java object model representing an AAI {@link Service} model
57 * @return XML representation of the service model in String format
61 public String generateModelFor(Service service) {
62 //Create a JAXB Model for AAI service model
63 Model aaiServiceModel = new Model();
64 log.debug("Generating Model for Service with ModelName: " + service.getModelName());
66 aaiServiceModel.setModelInvariantId(service.getModelId());
67 aaiServiceModel.setModelVers(new ModelVers());
68 ModelVer modelVer = new ModelVer();
69 modelVer.setModelDescription(service.getModelDescription());
70 modelVer.setModelName(service.getModelName());
71 modelVer.setModelVersion(service.getModelVersion());
72 modelVer.setModelVersionId(service.getModelNameVersionId());
73 modelVer.setModelElements(new ModelElements());
74 ModelElements modelElements = modelVer.getModelElements();
75 //Populate basic model details
77 .setModelType(service.getModelType().name().toLowerCase()); //Using enum name as model type
78 List<ModelElement> modelElementList = modelElements.getModelElement();
80 //Add service base widget model element
81 ModelElement serviceWidgetModelRelationshipElement =
82 createRelationshipModelElement(getNewDataDelFlagValue(service.getDeleteFlag()),
83 service.getWidgetId(),service.getWidgetInvariantId());
84 modelElementList.add(serviceWidgetModelRelationshipElement);
86 //Add the resource model elements
87 ModelElements serviceModelElements = serviceWidgetModelRelationshipElement.getModelElements();
88 List<ModelElement> serviceModelElementList = serviceModelElements.getModelElement();
89 Set<Resource> serviceResources = service.getResources();
90 if (serviceResources != null && !serviceResources.isEmpty()) {
91 for (Resource resourceModel : serviceResources) {
92 ModelElement aaiResourceModelElement =
93 createRelationshipModelElement(getNewDataDelFlagValue(resourceModel.getDeleteFlag()),
94 resourceModel.getModelNameVersionId(),resourceModel.getModelId());
95 serviceModelElementList.add(aaiResourceModelElement);
99 //Add the widget model elements
100 Set<Widget> serviceWidgets = service.getWidgets();
101 if (serviceWidgets != null && !serviceWidgets.isEmpty()) {
102 for (Widget widgetModel : serviceWidgets) {
103 ModelElement widgetModelElement =
104 createRelationshipModelElement(getNewDataDelFlagValue(widgetModel.getDeleteFlag()),
105 widgetModel.getId(),widgetModel.getWidgetId());
106 serviceModelElementList.add(widgetModelElement);
109 ModelVers modelVers = aaiServiceModel.getModelVers();
110 List<ModelVer> modelVerList = modelVers.getModelVer();
111 modelVerList.add(modelVer);
112 return getModelAsString(aaiServiceModel);
116 * Method to generate the AAI model for a Resource.
118 * @param resource Java object model representing an AAI {@link Resource} model
119 * @return XML representation of the resource model in String format
123 public String generateModelFor(Resource resource) {
124 //Create a JAXB Model for AAI Resource model
125 Model aaiResourceModel = new Model();
126 log.debug("Generating Model for Resource with ModelName: " + resource.getModelName());
127 aaiResourceModel.setModelInvariantId(resource.getModelId());
128 aaiResourceModel.setModelVers(new ModelVers());
129 ModelVer modelVer = new ModelVer();
130 modelVer.setModelDescription(resource.getModelDescription());
131 modelVer.setModelName(resource.getModelName());
132 modelVer.setModelVersion(resource.getModelVersion());
133 modelVer.setModelVersionId(resource.getModelNameVersionId());
134 modelVer.setModelElements(new ModelElements());
135 ModelElements modelElements = modelVer.getModelElements();
137 .setModelType(resource.getModelType().name().toLowerCase()); //Using enum name as model type
138 List<ModelElement> modelElementList = modelElements.getModelElement();
140 //Add resource base widget model element
141 ModelElement resourceWidgetModelRelationshipElement =
142 createRelationshipModelElement(getNewDataDelFlagValue(resource.getDeleteFlag()),
143 resource.getWidgetId(),resource.getWidgetInvariantId());
144 modelElementList.add(resourceWidgetModelRelationshipElement);
146 //Add the child resources to the base widget model element list
147 ModelElements baseResourceWidgetModelElements =
148 resourceWidgetModelRelationshipElement.getModelElements();
149 List<ModelElement> baseResourceWidgetModelElementList =
150 baseResourceWidgetModelElements.getModelElement();
151 Set<Resource> childResources = resource.getResources();
152 if (childResources != null && !childResources.isEmpty()) {
153 for (Resource childResourceModel : childResources) {
154 ModelElement aaiChildResourceModelElement = createRelationshipModelElement(
155 getNewDataDelFlagValue(childResourceModel.getDeleteFlag()),
156 childResourceModel.getModelNameVersionId(),childResourceModel.getModelId());
157 baseResourceWidgetModelElementList.add(aaiChildResourceModelElement);
160 //Add resource widgets/resources to the resource widget model relationship element
161 Set<Widget> resourceWidgets = resource.getWidgets();
162 if (resourceWidgets != null && !resourceWidgets.isEmpty()) {
163 generateWidgetChildren(resourceWidgetModelRelationshipElement, resourceWidgets);
166 ModelVers modelVers = aaiResourceModel.getModelVers();
167 List<ModelVer> modelVerList = modelVers.getModelVer();
168 modelVerList.add(modelVer);
169 return getModelAsString(aaiResourceModel);
174 * Method to create the <model-element></model-element> holding the relationship value for a
178 * @param newDataDelFlag Value of the <new-data-del-flag></new-data-del-flag> attribute for
179 * a widget/resource in
181 * @param relationshipValue Value of the <relationship-value></relationship-value> attribute
182 * for the widget/resource in
184 * @return Java object representation for the <model-element></model-element> holding the
187 private ModelElement createRelationshipModelElement(String newDataDelFlag,
188 String modelVersionId,String
190 ModelElement relationshipModelElement = new ModelElement();
191 relationshipModelElement.setNewDataDelFlag(newDataDelFlag); //Set new-data-del-flag value
192 relationshipModelElement.setCardinality("unbounded");
193 RelationshipList relationShipList = new RelationshipList();
194 final List<Relationship> relationships = relationShipList.getRelationship();
195 Relationship relationship = new Relationship();
196 relationship.setRelatedTo("model-ver");
197 List<RelationshipData> relationshipDataList = relationship.getRelationshipData();
199 RelationshipData modelVersionRelationshipData = new RelationshipData();
200 modelVersionRelationshipData.setRelationshipKey("model-ver.model-version-id");
201 modelVersionRelationshipData.setRelationshipValue(
202 modelVersionId); //Set the widget/resource name-version-uuid as value
203 relationshipDataList.add(modelVersionRelationshipData);
204 RelationshipData modelInvariantRelationshipData = new RelationshipData();
205 modelInvariantRelationshipData.setRelationshipKey("model.model-invariant-id");
206 modelInvariantRelationshipData.setRelationshipValue(
208 relationshipDataList.add(modelInvariantRelationshipData);
209 relationships.add(relationship);
210 relationshipModelElement.setRelationshipList(relationShipList);
211 relationshipModelElement.setModelElements(new ModelElements());
212 return relationshipModelElement;
216 * Method to create the child model elements of the widget. Handles the generation of recursive
217 * child widget elements (if any)
219 * @param parent Reference to the parent widget model element
220 * @param widgetChildrenSet Set of children obtained from the tosca/widget definition
222 private void generateWidgetChildren(ModelElement parent, Set<Widget> widgetChildrenSet) {
223 for (Widget widget : widgetChildrenSet) {
224 Set<Widget> widgetSubChildren = widget.getWidgets();
225 if (widgetSubChildren != null && !widgetSubChildren.isEmpty()) {
226 ModelElement widgetChildRelationshipElement =
227 createRelationshipModelElement(getNewDataDelFlagValue(widget.getDeleteFlag()),
228 widget.getId(),widget.getWidgetId());
229 //Recursive call for getting the children of widgets (if any)
230 generateWidgetChildren(widgetChildRelationshipElement, widgetSubChildren);
231 parent.getModelElements().getModelElement().add(widgetChildRelationshipElement);
233 ModelElement widgetChildRelationshipElement =
234 createRelationshipModelElement(getNewDataDelFlagValue(widget.getDeleteFlag()),
235 widget.getId(),widget.getWidgetId()
237 parent.getModelElements().getModelElement().add(widgetChildRelationshipElement);
243 * Converts the data delete flag value from boolean to String as per AAI model.
245 * @param delFlag Boolean value as true/false from the annotation
246 * @return Converted value to a flag as per AAI model
248 private String getNewDataDelFlagValue(boolean delFlag) {
257 * JAXB marshalling helper method to convert the Java object model to XML String.
259 * @param model Java Object model of a service/widget/resource
260 * @return XML representation of the Java model in String format
262 private String getModelAsString(Model model) {
263 JAXBContext jaxbContext;
264 StringWriter modelStringWriter = new StringWriter();
266 jaxbContext = JAXBContext.newInstance(Model.class);
267 Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
268 jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
269 jaxbMarshaller.setProperty(Marshaller.JAXB_ENCODING, "US-ASCII");
270 jaxbMarshaller.setProperty(Marshaller.JAXB_FRAGMENT, Boolean.TRUE);
271 jaxbMarshaller.marshal(model, modelStringWriter);
272 } catch (JAXBException jaxbException) {
273 throw new DOMException(DOMException.SYNTAX_ERR, jaxbException.getMessage());
276 return modelStringWriter.toString();