64c42a0498698c849b0cfa79554b8a8f59b36ae8
[so.git] / mso-api-handlers / mso-api-handler-infra / src / main / java / org / onap / so / apihandlerinfra / MsoRequest.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * ONAP - SO
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6  * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
7  * ================================================================================
8  * Modifications Copyright (c) 2019 Samsung
9  * ================================================================================
10  * Modifications Copyright (c) 2020 Nokia
11  * ================================================================================
12  * Licensed under the Apache License, Version 2.0 (the "License");
13  * you may not use this file except in compliance with the License.
14  * You may obtain a copy of the License at
15  *
16  *      http://www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an "AS IS" BASIS,
20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  * ============LICENSE_END=========================================================
24  */
25
26 package org.onap.so.apihandlerinfra;
27
28 import java.io.IOException;
29 import java.io.StringWriter;
30 import java.sql.Timestamp;
31 import java.util.ArrayList;
32 import java.util.HashMap;
33 import java.util.List;
34 import java.util.Map;
35 import java.util.Optional;
36 import java.util.StringTokenizer;
37 import javax.ws.rs.core.MultivaluedMap;
38 import javax.ws.rs.core.Response;
39 import javax.xml.XMLConstants;
40 import javax.xml.transform.OutputKeys;
41 import javax.xml.transform.Transformer;
42 import javax.xml.transform.TransformerFactory;
43 import javax.xml.transform.dom.DOMSource;
44 import javax.xml.transform.stream.StreamResult;
45 import org.onap.aai.domain.yang.Tenant;
46 import org.onap.so.apihandler.common.ResponseBuilder;
47 import org.onap.so.apihandlerinfra.infra.rest.AAIDataRetrieval;
48 import org.onap.so.apihandlerinfra.tasksbeans.TasksRequest;
49 import org.onap.so.apihandlerinfra.validation.ApplyUpdatedConfigValidation;
50 import org.onap.so.apihandlerinfra.validation.CloudConfigurationValidation;
51 import org.onap.so.apihandlerinfra.validation.ConfigurationParametersValidation;
52 import org.onap.so.apihandlerinfra.validation.CustomWorkflowValidation;
53 import org.onap.so.apihandlerinfra.validation.InPlaceSoftwareUpdateValidation;
54 import org.onap.so.apihandlerinfra.validation.InstanceIdMapValidation;
55 import org.onap.so.apihandlerinfra.validation.MembersValidation;
56 import org.onap.so.apihandlerinfra.validation.ModelInfoValidation;
57 import org.onap.so.apihandlerinfra.validation.PlatformLOBValidation;
58 import org.onap.so.apihandlerinfra.validation.ProjectOwningEntityValidation;
59 import org.onap.so.apihandlerinfra.validation.RelatedInstancesValidation;
60 import org.onap.so.apihandlerinfra.validation.RequestInfoValidation;
61 import org.onap.so.apihandlerinfra.validation.RequestParametersValidation;
62 import org.onap.so.apihandlerinfra.validation.RequestScopeValidation;
63 import org.onap.so.apihandlerinfra.validation.SubscriberInfoValidation;
64 import org.onap.so.apihandlerinfra.validation.UserParamsValidation;
65 import org.onap.so.apihandlerinfra.validation.ValidationInformation;
66 import org.onap.so.apihandlerinfra.validation.ValidationRule;
67 import org.onap.so.apihandlerinfra.vnfbeans.RequestStatusType;
68 import org.onap.so.apihandlerinfra.vnfbeans.VnfInputs;
69 import org.onap.so.apihandlerinfra.vnfbeans.VnfRequest;
70 import org.onap.so.constants.Status;
71 import org.onap.so.db.request.beans.InfraActiveRequests;
72 import org.onap.so.db.request.client.RequestsDbClient;
73 import org.onap.so.exceptions.ValidationException;
74 import org.onap.so.logger.LogConstants;
75 import org.onap.so.serviceinstancebeans.CloudConfiguration;
76 import org.onap.so.serviceinstancebeans.ModelInfo;
77 import org.onap.so.serviceinstancebeans.ModelType;
78 import org.onap.so.serviceinstancebeans.PolicyException;
79 import org.onap.so.serviceinstancebeans.RelatedInstance;
80 import org.onap.so.serviceinstancebeans.RelatedInstanceList;
81 import org.onap.so.serviceinstancebeans.RequestError;
82 import org.onap.so.serviceinstancebeans.RequestInfo;
83 import org.onap.so.serviceinstancebeans.RequestParameters;
84 import org.onap.so.serviceinstancebeans.Service;
85 import org.onap.so.serviceinstancebeans.ServiceException;
86 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
87 import org.slf4j.Logger;
88 import org.slf4j.LoggerFactory;
89 import org.slf4j.MDC;
90 import org.springframework.beans.factory.annotation.Autowired;
91 import org.springframework.beans.factory.annotation.Value;
92 import org.springframework.stereotype.Component;
93 import org.w3c.dom.Document;
94 import org.w3c.dom.Element;
95 import org.w3c.dom.Node;
96 import org.w3c.dom.NodeList;
97 import com.fasterxml.jackson.annotation.JsonInclude.Include;
98 import com.fasterxml.jackson.core.JsonGenerationException;
99 import com.fasterxml.jackson.databind.JsonMappingException;
100 import com.fasterxml.jackson.databind.ObjectMapper;
101
102 @Component
103 public class MsoRequest {
104
105     @Autowired
106     private RequestsDbClient requestsDbClient;
107
108     @Autowired
109     private ResponseBuilder builder;
110
111     @Autowired
112     private AAIDataRetrieval aaiDataRet;
113
114     @Value("${mso.enforceDLP:false}")
115     private boolean enforceDLP;
116
117     private static Logger logger = LoggerFactory.getLogger(MsoRequest.class);
118
119     public Response buildServiceErrorResponse(int httpResponseCode, MsoException exceptionType, String errorText,
120             String messageId, List<String> variables, String version) {
121
122         if (errorText.length() > 1999) {
123             errorText = errorText.substring(0, 1999);
124         }
125
126         RequestError re = new RequestError();
127
128         if ("PolicyException".equals(exceptionType.name())) {
129
130             PolicyException pe = new PolicyException();
131             pe.setMessageId(messageId);
132             pe.setText(errorText);
133             if (variables != null) {
134                 for (String variable : variables) {
135                     pe.getVariables().add(variable);
136                 }
137             }
138             re.setPolicyException(pe);
139
140         } else {
141
142             ServiceException se = new ServiceException();
143             se.setMessageId(messageId);
144             se.setText(errorText);
145             if (variables != null) {
146                 for (String variable : variables) {
147                     se.getVariables().add(variable);
148                 }
149             }
150             re.setServiceException(se);
151         }
152         return builder.buildResponse(httpResponseCode, null, re, version);
153     }
154
155
156     // Parse request JSON
157     public void parse(ServiceInstancesRequest sir, Map<String, String> instanceIdMap, Actions action, String version,
158             String originalRequestJSON, int reqVersion, Boolean aLaCarteFlag) throws ValidationException, IOException {
159
160         logger.debug("Validating the Service Instance request");
161         List<ValidationRule> rules = new ArrayList<>();
162         logger.debug("Incoming version is: {} coverting to int: {}", version, reqVersion);
163         RequestParameters requestParameters = sir.getRequestDetails().getRequestParameters();
164         ValidationInformation info =
165                 new ValidationInformation(sir, instanceIdMap, action, reqVersion, aLaCarteFlag, requestParameters);
166
167         rules.add(new InstanceIdMapValidation());
168
169         String workflowUuid = null;
170         if (instanceIdMap != null) {
171             workflowUuid = instanceIdMap.get("workflowUuid");
172         }
173
174         if (workflowUuid != null) {
175             rules.add(new CustomWorkflowValidation());
176         } else if (reqVersion >= 6 && action == Action.inPlaceSoftwareUpdate) {
177             rules.add(new InPlaceSoftwareUpdateValidation());
178         } else if (reqVersion >= 6 && action == Action.applyUpdatedConfig) {
179             rules.add(new ApplyUpdatedConfigValidation());
180         } else if (action == Action.addMembers || action == Action.removeMembers) {
181             rules.add(new MembersValidation());
182         } else {
183             rules.add(new RequestScopeValidation());
184             rules.add(new RequestParametersValidation());
185             rules.add(new RequestInfoValidation());
186             rules.add(new ModelInfoValidation());
187             rules.add(new CloudConfigurationValidation());
188             rules.add(new SubscriberInfoValidation());
189             if (!enforceDLP) {
190                 rules.add(new PlatformLOBValidation());
191                 rules.add(new ProjectOwningEntityValidation());
192             }
193             rules.add(new RelatedInstancesValidation());
194             rules.add(new ConfigurationParametersValidation());
195         }
196         if (reqVersion >= 7 && requestParameters != null && requestParameters.getUserParams() != null) {
197             for (Map<String, Object> params : requestParameters.getUserParams()) {
198                 if (params.containsKey("service")) {
199                     ObjectMapper obj = new ObjectMapper();
200                     String input = obj.writeValueAsString(params.get("service"));
201                     Service validate = obj.readValue(input, Service.class);
202                     info.setUserParams(validate);
203                     rules.add(new UserParamsValidation());
204                     break;
205                 }
206             }
207         }
208         for (ValidationRule rule : rules) {
209             rule.validate(info);
210         }
211     }
212
213     void parseOrchestration(ServiceInstancesRequest sir) throws ValidationException {
214         RequestInfo requestInfo = sir.getRequestDetails().getRequestInfo();
215
216         if (requestInfo == null) {
217             throw new ValidationException("requestInfo");
218         }
219
220         if (empty(requestInfo.getSource())) {
221             throw new ValidationException("source");
222         }
223         if (empty(requestInfo.getRequestorId())) {
224             throw new ValidationException("requestorId");
225         }
226     }
227
228     public Map<String, List<String>> getOrchestrationFilters(MultivaluedMap<String, String> queryParams) {
229         final String FILTER_KEY = "filter";
230         Map<String, List<String>> orchestrationFilterParams = new HashMap<>();
231
232         Optional.ofNullable(queryParams.get(FILTER_KEY)).ifPresent(listValues -> listValues
233                 .forEach(value -> addValueToOrchestrationFilterParamsMap(orchestrationFilterParams, value)));
234
235         return orchestrationFilterParams;
236     }
237
238     private void addValueToOrchestrationFilterParamsMap(Map<String, List<String>> orchestrationFilterParams,
239             String value) {
240         final String TOKEN_DELIMITER = ":";
241         StringTokenizer stringTokenizer = new StringTokenizer(value, TOKEN_DELIMITER);
242
243         if (!stringTokenizer.hasMoreTokens()) {
244             return;
245         }
246         String mapKey = stringTokenizer.nextToken();
247         List<String> orchestrationList = new ArrayList<>();
248         while (stringTokenizer.hasMoreTokens()) {
249             orchestrationList.add(stringTokenizer.nextToken());
250         }
251
252         orchestrationFilterParams.put(mapKey, orchestrationList);
253     }
254
255     public InfraActiveRequests createRequestObject(ServiceInstancesRequest servInsReq, Actions action, String requestId,
256             Status status, String originalRequestJSON, String requestScope) {
257         InfraActiveRequests aq = new InfraActiveRequests();
258         try {
259             if (null == servInsReq) {
260                 servInsReq = new ServiceInstancesRequest();
261             }
262             String networkType = "";
263             String vnfType = "";
264             aq.setRequestId(requestId);
265             aq.setRequestAction(action.toString());
266             aq.setRequestUrl(MDC.get(LogConstants.HTTP_URL));
267
268             Timestamp startTimeStamp = new Timestamp(System.currentTimeMillis());
269
270             aq.setStartTime(startTimeStamp);
271             if (requestScope.equals(ModelType.instanceGroup.name()) && action == Action.deleteInstance) {
272                 aq.setRequestScope(requestScope);
273             } else {
274                 RequestInfo requestInfo = servInsReq.getRequestDetails().getRequestInfo();
275                 if (requestInfo != null) {
276
277                     if (requestInfo.getSource() != null) {
278                         aq.setSource(requestInfo.getSource());
279                     }
280                     if (requestInfo.getCallbackUrl() != null) {
281                         aq.setCallBackUrl(requestInfo.getCallbackUrl());
282                     }
283                     if (requestInfo.getCorrelator() != null) {
284                         aq.setCorrelator(requestInfo.getCorrelator());
285                     }
286
287                     if (requestInfo.getRequestorId() != null) {
288                         aq.setRequestorId(requestInfo.getRequestorId());
289                     }
290                 }
291
292                 if (servInsReq.getRequestDetails().getModelInfo() != null
293                         || (action == Action.inPlaceSoftwareUpdate || action == Action.applyUpdatedConfig)) {
294                     aq.setRequestScope(requestScope);
295                 }
296
297                 if (servInsReq.getRequestDetails().getCloudConfiguration() != null) {
298                     CloudConfiguration cloudConfiguration = servInsReq.getRequestDetails().getCloudConfiguration();
299                     if (cloudConfiguration.getLcpCloudRegionId() != null) {
300                         aq.setCloudRegion(cloudConfiguration.getLcpCloudRegionId());
301                     }
302
303                     if (cloudConfiguration.getTenantId() != null) {
304                         aq.setTenantId(cloudConfiguration.getTenantId());
305                     }
306
307                 }
308
309                 if (servInsReq.getServiceInstanceId() != null) {
310                     aq.setServiceInstanceId(servInsReq.getServiceInstanceId());
311                 }
312
313                 if (servInsReq.getVnfInstanceId() != null) {
314                     aq.setVnfId(servInsReq.getVnfInstanceId());
315                 }
316
317                 if (servInsReq.getPnfName() != null) {
318                     aq.setRequestScope(requestScope);
319                     aq.setPnfName(servInsReq.getPnfName());
320                 }
321
322                 if (servInsReq.getRequestDetails() != null && servInsReq.getRequestDetails().getRequestInfo() != null
323                         && servInsReq.getRequestDetails().getRequestInfo().getProductFamilyId() != null) {
324                     logger.debug("Retrieving productFamilyName to put into requests db");
325
326                     org.onap.aai.domain.yang.Service service =
327                             aaiDataRet.getService(servInsReq.getRequestDetails().getRequestInfo().getProductFamilyId());
328                     if (service != null) {
329                         logger.debug("Found service by service-id");
330                         String productFamilyName = service.getServiceDescription();
331                         if (productFamilyName != null) {
332                             aq.setProductFamilyName(productFamilyName);
333                         }
334                     }
335                 }
336
337                 aq.setProductFamilyName(getProductFamilyNameFromAAI(servInsReq));
338
339                 aq.setTenantName(getTenantNameFromAAI(servInsReq));
340
341                 if (ModelType.service.name().equalsIgnoreCase(requestScope)) {
342                     if (servInsReq.getRequestDetails().getRequestInfo() != null) {
343                         if (servInsReq.getRequestDetails().getRequestInfo().getInstanceName() != null) {
344                             aq.setServiceInstanceName(requestInfo.getInstanceName());
345                         }
346                     }
347                 }
348
349                 if (ModelType.network.name().equalsIgnoreCase(requestScope)) {
350                     aq.setNetworkName(servInsReq.getRequestDetails().getRequestInfo().getInstanceName());
351                     aq.setNetworkType(networkType);
352                     aq.setNetworkId(servInsReq.getNetworkInstanceId());
353                 }
354
355                 if (ModelType.volumeGroup.name().equalsIgnoreCase(requestScope)) {
356                     aq.setVolumeGroupId(servInsReq.getVolumeGroupInstanceId());
357                     aq.setVolumeGroupName(servInsReq.getRequestDetails().getRequestInfo().getInstanceName());
358                     aq.setVnfType(vnfType);
359
360                 }
361
362                 if (ModelType.vfModule.name().equalsIgnoreCase(requestScope)) {
363                     aq.setVfModuleName(requestInfo.getInstanceName());
364                     aq.setVfModuleModelName(servInsReq.getRequestDetails().getModelInfo().getModelName());
365                     aq.setVfModuleId(servInsReq.getVfModuleInstanceId());
366                     aq.setVolumeGroupId(servInsReq.getVolumeGroupInstanceId());
367                     aq.setVnfType(vnfType);
368
369                 }
370
371                 if (ModelType.configuration.name().equalsIgnoreCase(requestScope)) {
372                     aq.setConfigurationId(servInsReq.getConfigurationId());
373                     aq.setConfigurationName(requestInfo.getInstanceName());
374                 }
375                 if (requestScope.equalsIgnoreCase(ModelType.instanceGroup.name())) {
376                     aq.setInstanceGroupId(servInsReq.getInstanceGroupId());
377                     aq.setInstanceGroupName(requestInfo.getInstanceName());
378                 }
379                 if (ModelType.vnf.name().equalsIgnoreCase(requestScope)) {
380                     if (requestInfo != null) {
381                         aq.setVnfName(requestInfo.getInstanceName());
382                     }
383                     if (null != servInsReq.getRequestDetails()) {
384                         RelatedInstanceList[] instanceList = servInsReq.getRequestDetails().getRelatedInstanceList();
385
386                         if (instanceList != null) {
387
388                             for (RelatedInstanceList relatedInstanceList : instanceList) {
389
390                                 RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
391                                 if (relatedInstance.getModelInfo().getModelType().equals(ModelType.service)) {
392                                     aq.setVnfType(vnfType);
393                                 }
394                             }
395                         }
396                     }
397                 }
398             }
399
400             aq.setRequestBody(originalRequestJSON);
401
402             aq.setRequestStatus(status.toString());
403             aq.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
404         } catch (Exception e) {
405             logger.error("Exception when creation record request", e);
406
407             if (!status.equals(Status.FAILED)) {
408                 throw e;
409             }
410         }
411         return aq;
412     }
413
414     public InfraActiveRequests createRequestObject(TasksRequest taskRequest, Action action, String requestId,
415             Status status, String originalRequestJSON) {
416         InfraActiveRequests aq = new InfraActiveRequests();
417         try {
418
419             org.onap.so.apihandlerinfra.tasksbeans.RequestInfo requestInfo =
420                     taskRequest.getRequestDetails().getRequestInfo();
421             aq.setRequestId(requestId);
422             aq.setRequestAction(action.name());
423             aq.setRequestUrl(MDC.get(LogConstants.HTTP_URL));
424
425             Timestamp startTimeStamp = new Timestamp(System.currentTimeMillis());
426
427             aq.setStartTime(startTimeStamp);
428             if (requestInfo != null) {
429
430                 if (requestInfo.getSource() != null) {
431                     aq.setSource(requestInfo.getSource());
432                 }
433
434                 if (requestInfo.getRequestorId() != null) {
435                     aq.setRequestorId(requestInfo.getRequestorId());
436                 }
437             }
438
439             aq.setRequestBody(originalRequestJSON);
440             aq.setRequestStatus(status.toString());
441             aq.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
442
443         } catch (Exception e) {
444             logger.error("Exception when creation record request", e);
445
446             if (!status.equals(Status.FAILED)) {
447                 throw e;
448             }
449         }
450         return aq;
451     }
452
453     public void createErrorRequestRecord(Status status, String requestId, String errorMessage, Actions action,
454             String requestScope, String requestJSON, String serviceInstanceId, ServiceInstancesRequest sir) {
455         try {
456             InfraActiveRequests request = new InfraActiveRequests(requestId);
457             Timestamp startTimeStamp = new Timestamp(System.currentTimeMillis());
458             request.setStartTime(startTimeStamp);
459             request.setRequestStatus(status.toString());
460             request.setStatusMessage(errorMessage);
461             request.setProgress((long) 100);
462             request.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
463             request.setRequestAction(action.toString());
464             request.setRequestScope(requestScope);
465             request.setRequestBody(requestJSON);
466             if (serviceInstanceId != null) {
467                 request.setServiceInstanceId(serviceInstanceId);
468             }
469             Timestamp endTimeStamp = new Timestamp(System.currentTimeMillis());
470             request.setEndTime(endTimeStamp);
471             request.setRequestUrl(MDC.get(LogConstants.HTTP_URL));
472             if (sir != null) {
473                 if (sir.getRequestDetails() != null && sir.getRequestDetails().getRequestInfo() != null) {
474                     request.setRequestorId(sir.getRequestDetails().getRequestInfo().getRequestorId());
475                     request.setSource(sir.getRequestDetails().getRequestInfo().getSource());
476                     if (ModelType.service.name().equalsIgnoreCase(requestScope)) {
477                         if (sir.getRequestDetails().getRequestInfo().getInstanceName() != null) {
478                             request.setServiceInstanceName(sir.getRequestDetails().getRequestInfo().getInstanceName());
479                         }
480                     }
481                 }
482             }
483             requestsDbClient.save(request);
484         } catch (Exception e) {
485             logger.error("Exception when updating record in DB", e);
486             logger.debug("Exception: ", e);
487         }
488     }
489
490     public Response buildResponse(int httpResponseCode, String errorCode, InfraActiveRequests inProgress) {
491         return buildResponseWithError(httpResponseCode, errorCode, inProgress, null);
492     }
493
494     public Response buildResponseWithError(int httpResponseCode, String errorCode, InfraActiveRequests inProgress,
495             String errorString) {
496
497
498         // Log the failed request into the MSO Requests database
499
500         return Response.status(httpResponseCode).entity(null).build();
501
502     }
503
504     public Response buildResponseFailedValidation(int httpResponseCode, String exceptionMessage) {
505
506         return Response.status(httpResponseCode).entity(null).build();
507     }
508
509
510     public String getServiceType(VnfInputs vnfInputs) {
511         if (vnfInputs.getServiceType() != null)
512             return vnfInputs.getServiceType();
513         if (vnfInputs.getServiceId() != null)
514             return vnfInputs.getServiceId();
515         return null;
516     }
517
518     public long translateStatus(RequestStatusType status) {
519         switch (status) {
520             case FAILED:
521             case COMPLETE:
522                 return Constants.PROGRESS_REQUEST_COMPLETED;
523             case IN_PROGRESS:
524                 return Constants.PROGRESS_REQUEST_IN_PROGRESS;
525             default:
526                 return 0;
527         }
528     }
529
530     public static String domToStr(Document doc) {
531         if (doc == null) {
532             return null;
533         }
534
535         try {
536             StringWriter sw = new StringWriter();
537             StreamResult sr = new StreamResult(sw);
538             TransformerFactory tf = TransformerFactory.newInstance();
539             tf.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
540             tf.setAttribute(XMLConstants.ACCESS_EXTERNAL_STYLESHEET, "");
541             Transformer t = tf.newTransformer();
542             t.setOutputProperty(OutputKeys.STANDALONE, "yes");
543             NodeList nl = doc.getDocumentElement().getChildNodes();
544             DOMSource source = null;
545             for (int x = 0; x < nl.getLength(); x++) {
546                 Node e = nl.item(x);
547                 if (e instanceof Element) {
548                     source = new DOMSource(e);
549                     break;
550                 }
551             }
552             if (source != null) {
553                 t.transform(source, sr);
554
555                 String s = sw.toString();
556                 return s;
557             }
558
559             return null;
560
561         } catch (Exception e) {
562             logger.error("Exception in domToStr", e);
563         }
564         return null;
565     }
566
567     public void addBPMNSpecificInputs(VnfRequest vnfReq, VnfInputs vnfInputs, String personaModelId,
568             String personaModelVersion, Boolean isBaseVfModule, String vnfPersonaModelId,
569             String vnfPersonaModelVersion) {
570         vnfInputs.setPersonaModelId(personaModelId);
571         vnfInputs.setPersonaModelVersion(personaModelVersion);
572         vnfInputs.setIsBaseVfModule(isBaseVfModule);
573         vnfInputs.setVnfPersonaModelId(vnfPersonaModelId);
574         vnfInputs.setVnfPersonaModelVersion(vnfPersonaModelVersion);
575
576         vnfReq.setVnfInputs(vnfInputs);
577
578     }
579
580     private static boolean empty(String s) {
581         return (s == null || s.trim().isEmpty());
582     }
583
584     public String getRequestJSON(ServiceInstancesRequest sir)
585             throws JsonGenerationException, JsonMappingException, IOException {
586         ObjectMapper mapper = new ObjectMapper();
587         mapper.setSerializationInclusion(Include.NON_NULL);
588
589         logger.debug("building sir from object {}", sir);
590         String requestJSON = mapper.writeValueAsString(sir);
591
592         // Perform mapping from VID-style modelInfo fields to ASDC-style modelInfo fields
593
594         logger.debug("REQUEST JSON before mapping: {}", requestJSON);
595         // modelUuid = modelVersionId
596         requestJSON = requestJSON.replaceAll("\"modelVersionId\":", "\"modelUuid\":");
597         // modelCustomizationUuid = modelCustomizationId
598         requestJSON = requestJSON.replaceAll("\"modelCustomizationId\":", "\"modelCustomizationUuid\":");
599         // modelInstanceName = modelCustomizationName
600         requestJSON = requestJSON.replaceAll("\"modelCustomizationName\":", "\"modelInstanceName\":");
601         // modelInvariantUuid = modelInvariantId
602         requestJSON = requestJSON.replaceAll("\"modelInvariantId\":", "\"modelInvariantUuid\":");
603         logger.debug("REQUEST JSON after mapping: {}", requestJSON);
604
605         return requestJSON;
606     }
607
608
609     public boolean getAlacarteFlag(ServiceInstancesRequest sir) {
610         if (sir.getRequestDetails().getRequestParameters() != null
611                 && sir.getRequestDetails().getRequestParameters().getALaCarte() != null)
612             return sir.getRequestDetails().getRequestParameters().getALaCarte();
613
614         return false;
615     }
616
617
618     public String getNetworkType(ServiceInstancesRequest sir, String requestScope) {
619         if (requestScope.equalsIgnoreCase(ModelType.network.name()))
620             return sir.getRequestDetails().getModelInfo().getModelName();
621         else
622             return null;
623     }
624
625
626     public String getServiceInstanceType(ServiceInstancesRequest sir, String requestScope) {
627         if (requestScope.equalsIgnoreCase(ModelType.network.name()))
628             return sir.getRequestDetails().getModelInfo().getModelName();
629         else
630             return null;
631     }
632
633
634     public String getSDCServiceModelVersion(ServiceInstancesRequest sir) {
635         String sdcServiceModelVersion = null;
636         if (sir.getRequestDetails().getRelatedInstanceList() != null)
637             for (RelatedInstanceList relatedInstanceList : sir.getRequestDetails().getRelatedInstanceList()) {
638                 RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
639                 ModelInfo relatedInstanceModelInfo = relatedInstance.getModelInfo();
640                 if (relatedInstanceModelInfo.getModelType().equals(ModelType.service))
641                     sdcServiceModelVersion = relatedInstanceModelInfo.getModelVersion();
642             }
643         return sdcServiceModelVersion;
644     }
645
646
647     public String getVfModuleType(ServiceInstancesRequest sir, String requestScope) {
648
649         String vnfType;
650         String vfModuleType = null;
651         String vfModuleModelName;
652         ModelInfo modelInfo = sir.getRequestDetails().getModelInfo();
653         RelatedInstanceList[] instanceList = sir.getRequestDetails().getRelatedInstanceList();
654         String serviceModelName = null;
655         String vnfModelName = null;
656         String volumeGroupId = null;
657
658         if (instanceList == null) {
659             return null;
660         }
661         for (RelatedInstanceList relatedInstanceList : instanceList) {
662             RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
663             ModelInfo relatedInstanceModelInfo = relatedInstance.getModelInfo();
664
665             if (relatedInstanceModelInfo.getModelType().equals(ModelType.service)) {
666                 serviceModelName = relatedInstanceModelInfo.getModelName();
667             } else if (relatedInstanceModelInfo.getModelType().equals(ModelType.vnf)
668                     && !(ModelType.configuration.name().equalsIgnoreCase(requestScope))) {
669                 vnfModelName = relatedInstanceModelInfo.getModelCustomizationName();
670             } else if (relatedInstanceModelInfo.getModelType().equals(ModelType.volumeGroup)) {
671                 volumeGroupId = relatedInstance.getInstanceId();
672             }
673         }
674         if (requestScope.equalsIgnoreCase(ModelType.vfModule.name())) {
675             vfModuleModelName = modelInfo.getModelName();
676             vnfType = serviceModelName + "/" + vnfModelName;
677             vfModuleType = vnfType + "::" + vfModuleModelName;
678             sir.setVolumeGroupInstanceId(volumeGroupId);
679         }
680
681         return vfModuleType;
682
683     }
684
685     public String getVnfType(ServiceInstancesRequest sir, String requestScope) {
686
687         String vnfType = null;
688         RelatedInstanceList[] instanceList = sir.getRequestDetails().getRelatedInstanceList();
689         String serviceModelName = null;
690         String vnfModelName = null;
691         String volumeGroupId = null;
692
693         if (instanceList == null) {
694             return null;
695         }
696         for (RelatedInstanceList relatedInstanceList : instanceList) {
697             RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
698             ModelInfo relatedInstanceModelInfo = relatedInstance.getModelInfo();
699
700             if (relatedInstanceModelInfo.getModelType().equals(ModelType.service)) {
701                 serviceModelName = relatedInstanceModelInfo.getModelName();
702             } else if (relatedInstanceModelInfo.getModelType().equals(ModelType.vnf)
703                     && !(ModelType.configuration.name().equalsIgnoreCase(requestScope))) {
704                 vnfModelName = relatedInstanceModelInfo.getModelCustomizationName();
705             } else if (relatedInstanceModelInfo.getModelType().equals(ModelType.volumeGroup)) {
706                 volumeGroupId = relatedInstance.getInstanceId();
707             }
708         }
709
710         if (requestScope.equalsIgnoreCase(ModelType.volumeGroup.name())) {
711             vnfType = serviceModelName + "/" + vnfModelName;
712         } else if (requestScope.equalsIgnoreCase(ModelType.vfModule.name())) {
713             vnfType = serviceModelName + "/" + vnfModelName;
714             sir.setVolumeGroupInstanceId(volumeGroupId);
715         } else if (requestScope.equalsIgnoreCase(ModelType.vnf.name()))
716             vnfType = serviceModelName + "/" + sir.getRequestDetails().getModelInfo().getModelCustomizationName();
717
718         return vnfType;
719     }
720
721     protected String getTenantNameFromAAI(ServiceInstancesRequest servInsReq) {
722         String tenantName = null;
723         if (servInsReq.getRequestDetails() != null && servInsReq.getRequestDetails().getCloudConfiguration() != null
724                 && servInsReq.getRequestDetails().getCloudConfiguration().getTenantId() != null) {
725             Tenant tenant = aaiDataRet.getTenant(servInsReq.getRequestDetails().getCloudConfiguration().getCloudOwner(),
726                     servInsReq.getRequestDetails().getCloudConfiguration().getLcpCloudRegionId(),
727                     servInsReq.getRequestDetails().getCloudConfiguration().getTenantId());
728             if (tenant != null) {
729                 tenantName = tenant.getTenantName();
730             }
731         }
732         return tenantName;
733     }
734
735     protected String getProductFamilyNameFromAAI(ServiceInstancesRequest servInsReq) {
736         String productFamilyName = null;
737         if (servInsReq.getRequestDetails() != null && servInsReq.getRequestDetails().getRequestInfo() != null
738                 && servInsReq.getRequestDetails().getRequestInfo().getProductFamilyId() != null) {
739             org.onap.aai.domain.yang.Service service =
740                     aaiDataRet.getService(servInsReq.getRequestDetails().getRequestInfo().getProductFamilyId());
741             if (service != null) {
742                 productFamilyName = service.getServiceDescription();
743             }
744         }
745         return productFamilyName;
746     }
747
748 }