2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 # Copyright (c) 2020, CMCC Technologies Co., Ltd.
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.onap.so.bpmn.infrastructure.scripts
23 import org.onap.aaiclient.client.generated.fluentbuilders.AAIFluentTypeBuilder
24 import org.onap.so.serviceinstancebeans.Service
26 import static org.apache.commons.lang3.StringUtils.*
27 import org.camunda.bpm.engine.delegate.BpmnError
28 import org.camunda.bpm.engine.delegate.DelegateExecution
29 import org.onap.aai.domain.yang.ServiceInstance
30 import org.onap.aaiclient.client.aai.AAIResourcesClient
31 import org.onap.aaiclient.client.aai.entities.uri.AAIResourceUri
32 import org.onap.aaiclient.client.aai.entities.uri.AAIUriFactory
33 import org.onap.aaiclient.client.generated.fluentbuilders.AAIFluentTypeBuilder.Types
34 import org.onap.logging.filter.base.ErrorCode
35 import org.onap.so.beans.nsmf.SliceTaskParams
36 import org.onap.so.beans.nsmf.SliceTaskParamsAdapter
37 import org.onap.so.beans.nsmf.oof.TemplateInfo
38 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
39 import org.onap.so.bpmn.common.scripts.ExceptionUtil
40 import org.onap.so.bpmn.common.scripts.MsoUtils
41 import org.onap.so.bpmn.common.scripts.NssmfAdapterUtils
42 import org.onap.so.bpmn.common.scripts.OofUtils
43 import org.onap.so.bpmn.core.UrnPropertiesReader
44 import org.onap.so.bpmn.core.json.JsonUtils
45 import org.onap.so.db.request.beans.OrchestrationTask
46 import org.onap.so.logger.LoggingAnchor
47 import org.onap.so.logger.MessageEnum
48 import org.slf4j.Logger
49 import org.slf4j.LoggerFactory
50 import org.springframework.web.util.UriUtils
51 import com.fasterxml.jackson.databind.ObjectMapper
52 import groovy.json.JsonSlurper
54 public class CreateSliceService extends AbstractServiceTaskProcessor {
55 String Prefix = "CRESS_"
57 ExceptionUtil exceptionUtil = new ExceptionUtil()
59 JsonUtils jsonUtil = new JsonUtils()
61 JsonSlurper jsonSlurper = new JsonSlurper()
63 ObjectMapper objectMapper = new ObjectMapper()
65 OofUtils oofUtils = new OofUtils()
67 AAIResourcesClient client = getAAIClient()
69 private static final Logger logger = LoggerFactory.getLogger(CreateSliceService.class)
71 public void preProcessRequest(DelegateExecution execution) {
72 logger.debug("Start preProcessRequest")
73 execution.setVariable("prefix", Prefix)
77 String ssRequest = execution.getVariable("bpmnRequest")
78 logger.debug(ssRequest)
80 String requestId = execution.getVariable("mso-request-id")
81 execution.setVariable("msoRequestId", requestId)
82 logger.debug("Input Request:" + ssRequest + " reqId:" + requestId)
84 String serviceInstanceId = execution.getVariable("serviceInstanceId")
85 if (isBlank(serviceInstanceId)) {
86 serviceInstanceId = UUID.randomUUID().toString()
89 String operationId = UUID.randomUUID().toString()
90 execution.setVariable("operationId", operationId)
92 logger.debug("Generated new Service Instance:" + serviceInstanceId)
93 serviceInstanceId = UriUtils.encode(serviceInstanceId, "UTF-8")
94 execution.setVariable("serviceInstanceId", serviceInstanceId)
97 String globalSubscriberId = jsonUtil.getJsonValue(ssRequest, "requestDetails.subscriberInfo.globalSubscriberId")
98 if (isBlank(globalSubscriberId)) {
99 msg = "Input globalSubscriberId' is null"
100 exceptionUtil.buildAndThrowWorkflowException(execution, 500, msg)
102 execution.setVariable("globalSubscriberId", globalSubscriberId)
106 execution.setVariable("source", jsonUtil.getJsonValue(ssRequest, "requestDetails.requestInfo.source"))
107 execution.setVariable("serviceInstanceName", jsonUtil.getJsonValue(ssRequest, "requestDetails.requestInfo.instanceName"))
108 execution.setVariable("disableRollback", jsonUtil.getJsonValue(ssRequest, "requestDetails.requestInfo.suppressRollback"))
109 String productFamilyId = jsonUtil.getJsonValue(ssRequest, "requestDetails.requestInfo.productFamilyId")
110 if (isBlank(productFamilyId)) {
111 msg = "Input productFamilyId is null"
113 //exceptionUtil.buildAndThrowWorkflowException(execution, 500, msg)
115 execution.setVariable("productFamilyId", productFamilyId)
119 String serviceModelInfo = jsonUtil.getJsonValue(ssRequest, "requestDetails.modelInfo")
120 if (isBlank(serviceModelInfo)) {
121 msg = "Input serviceModelInfo is null"
123 exceptionUtil.buildAndThrowWorkflowException(execution, 500, msg)
125 execution.setVariable("serviceModelInfo", serviceModelInfo)
128 logger.debug("modelInfo: " + serviceModelInfo)
130 // //requestParameters
131 // String subscriptionServiceType = jsonUtil.getJsonValue(ssRequest, "requestDetails.requestParameters.subscriptionServiceType")
132 // if (isBlank(subscriptionServiceType)) {
133 // msg = "Input subscriptionServiceType is null"
135 // exceptionUtil.buildAndThrowWorkflowException(execution, 500, msg)
137 // subscriptionServiceType = "5G"
138 // execution.setVariable("subscriptionServiceType", subscriptionServiceType)
140 // logger.debug("subscriptionServiceType: " + subscriptionServiceType)
143 * Extracting User Parameters from incoming Request and converting into a Map
145 Map reqMap = jsonSlurper.parseText(ssRequest) as Map
148 def userParamsList = reqMap.requestDetails?.requestParameters?.userParams
150 Map<String, String> inputMap = [:]
151 if (userParamsList) {
152 for (def i = 0; i < userParamsList.size(); i++) {
153 def userParams1 = userParamsList.get(i)
154 userParams1.each { param -> inputMap.put(param.key, param.value) }
158 logger.debug("User Input Parameters map: " + inputMap.toString())
159 String uuiRequest = inputMap.get("UUIRequest")
160 Map uuiReqMap = jsonSlurper.parseText(uuiRequest) as Map
161 Map<String, Object> serviceObject = (Map<String, Object>) uuiReqMap.get("service")
162 Map<String, Object> parameterObject = (Map<String, Object>) serviceObject.get("parameters")
163 Map<String, Object> requestInputs = (Map<String, Object>) parameterObject.get("requestInputs")
165 def serviceProfile = [:]
166 for(entry in requestInputs) {
167 serviceProfile[entry.key] = entry.value
170 execution.setVariable("serviceInputParams", inputMap)
171 execution.setVariable("uuiRequest", uuiRequest)
172 execution.setVariable("serviceProfile", serviceProfile)
173 execution.setVariable("subscriptionServiceType", serviceObject.get("serviceType"))
176 //execution.setVariable("serviceInputParams", jsonUtil.getJsonValue(siRequest, "requestDetails.requestParameters.userParams"))
177 //execution.setVariable("failExists", true)
179 } catch (BpmnError e) {
181 } catch (Exception ex) {
182 msg = "Exception in preProcessRequest " + ex.getMessage()
184 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
186 logger.debug("Finish preProcessRequest")
193 public void prepareInitServiceOperationStatus(DelegateExecution execution) {
194 logger.debug("Start prepareInitServiceOperationStatus")
196 String serviceId = execution.getVariable("serviceInstanceId")
197 String operationId = execution.getVariable("operationId")
198 String operationType = "CREATE"
199 String userId = execution.getVariable("globalSubscriberId")
200 String result = "processing"
201 String progress = "0"
203 String operationContent = "Prepare service creation"
204 logger.debug("Generated new operation for Service Instance serviceId:" + serviceId + " operationId:" + operationId)
205 serviceId = UriUtils.encode(serviceId,"UTF-8")
206 execution.setVariable("serviceInstanceId", serviceId)
207 execution.setVariable("operationType", operationType)
209 def dbAdapterEndpoint = UrnPropertiesReader.getVariable("mso.adapters.openecomp.db.endpoint",execution)
210 execution.setVariable("CSSOS_dbAdapterEndpoint", dbAdapterEndpoint)
211 logger.debug("DB Adapter Endpoint is: " + dbAdapterEndpoint)
212 def dbAdapterAuth = UrnPropertiesReader.getVariable("mso.requestDb.auth")
213 Map<String, String> CSSOS_headerMap = [:]
214 CSSOS_headerMap.put("content-type", "application/soap+xml")
215 CSSOS_headerMap.put("Authorization", dbAdapterAuth)
216 execution.setVariable("CSSOS_headerMap", CSSOS_headerMap)
217 logger.debug("DB Adapter Header is: " + CSSOS_headerMap)
220 """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
221 xmlns:ns="http://org.onap.so/requestsdb">
224 <ns:initServiceOperationStatus xmlns:ns="http://org.onap.so/requestsdb">
225 <serviceId>${MsoUtils.xmlEscape(serviceId)}</serviceId>
226 <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
227 <operationType>${MsoUtils.xmlEscape(operationType)}</operationType>
228 <userId>${MsoUtils.xmlEscape(userId)}</userId>
229 <result>${MsoUtils.xmlEscape(result)}</result>
230 <operationContent>${MsoUtils.xmlEscape(operationContent)}</operationContent>
231 <progress>${MsoUtils.xmlEscape(progress)}</progress>
232 <reason>${MsoUtils.xmlEscape(reason)}</reason>
233 </ns:initServiceOperationStatus>
235 </soapenv:Envelope>"""
237 payload = utils.formatXml(payload)
238 execution.setVariable("CSSOS_updateServiceOperStatusRequest", payload)
239 logger.debug("Outgoing updateServiceOperStatusRequest: \n" + payload)
241 logger.error(LoggingAnchor.FIVE, MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
242 "Exception Occured Processing prepareInitServiceOperationStatus.", "BPMN",
243 ErrorCode.UnknownError.getValue(), "Exception is:\n" + e)
245 logger.debug("Finish prepareInitServiceOperationStatus")
249 * prepare create OrchestrationTask
252 public void prepareCreateOrchestrationTask(DelegateExecution execution) {
253 logger.debug("Start createOrchestrationTask")
254 String taskId = execution.getBusinessKey()
255 execution.setVariable("orchestrationTaskId", taskId)
256 logger.debug("BusinessKey: " + taskId)
257 String serviceInstanceId = execution.getVariable("serviceInstanceId")
258 String serviceInstanceName = execution.getVariable("serviceInstanceName")
259 String taskName = "SliceServiceTask"
260 String taskStatus = "Planning"
261 String isManual = "false"
262 String requestMethod = "POST"
263 execution.setVariable("CSSOT_taskId", taskId)
264 execution.setVariable("CSSOT_name", taskName)
265 execution.setVariable("CSSOT_status", taskStatus)
266 execution.setVariable("CSSOT_isManual", isManual)
267 execution.setVariable("CSSOT_requestMethod", requestMethod)
269 Map<String, Object> serviceProfile = execution.getVariable("serviceProfile") as Map<String, Object>
271 SliceTaskParamsAdapter sliceTaskParams = new SliceTaskParamsAdapter()
272 sliceTaskParams.setServiceId(serviceInstanceId)
273 sliceTaskParams.setServiceName(serviceInstanceName)
274 sliceTaskParams.setServiceProfile(serviceProfile)
276 execution.setVariable("sliceTaskParams", sliceTaskParams)
278 String paramJson = sliceTaskParams.convertToJson()
279 execution.setVariable("CSSOT_paramJson", paramJson)
281 logger.debug("Finish createOrchestrationTask")
285 * send sync response to csmf
288 public void sendSyncResponse(DelegateExecution execution) {
289 logger.debug("Start sendSyncResponse")
291 String operationId = execution.getVariable("operationId")
292 String serviceInstanceId = execution.getVariable("serviceInstanceId")
293 // RESTResponse for API Handler (APIH) Reply Task
294 String createServiceRestRequest = """
297 "serviceId":"${serviceInstanceId}",
298 "operationId":"${operationId}"
303 logger.debug("sendSyncResponse to APIH:" + "\n" + createServiceRestRequest)
304 sendWorkflowResponse(execution, 202, createServiceRestRequest)
305 execution.setVariable("sentSyncResponse", true)
306 } catch (Exception e) {
307 String msg = "Exceptuion in sendSyncResponse:" + e.getMessage()
309 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
311 logger.debug("Finish sendSyncResponse")
314 public void prepareSelectNSTRequest(DelegateExecution execution) {
315 logger.debug("Start prepareSelectNSTRequest")
316 String requestId = execution.getVariable("msoRequestId")
317 String messageType = "NSTSelectionResponse"
318 execution.setVariable("nstSelectionUrl", "/api/oof/v1/selection/nst")
319 execution.setVariable("nstSelection_messageType", messageType)
320 execution.setVariable("nstSelection_correlator", requestId)
321 String timeout = UrnPropertiesReader.getVariable("mso.adapters.oof.timeout", execution);
322 execution.setVariable("nstSelection_timeout", timeout)
324 Map<String, Object> serviceProfile = execution.getVariable("serviceProfile") as Map<String, Object>
325 serviceProfile.remove("profileId")
326 String oofRequest = oofUtils.buildSelectNSTRequest(requestId, messageType, serviceProfile)
327 execution.setVariable("nstSelection_oofRequest", oofRequest)
328 logger.debug("Finish prepareSelectNSTRequest")
333 * process async response of oof, put the {@solutions} at {@nstSolution}
336 public void processNSTSolutions(DelegateExecution execution) {
337 Map<String, Object> nstSolution
339 logger.debug("Start processing NSTSolutions")
340 Map<String, Object> resMap =
341 objectMapper.readValue(execution.getVariable("nstSelection_oofResponse") as String,
344 List<Map<String, Object>> nstSolutions = (List<Map<String, Object>>) resMap.get("solutions")
345 nstSolution = nstSolutions.get(0)
346 execution.setVariable("nstSolution", nstSolution)
348 //set nst info into sliceTaskParams
349 SliceTaskParamsAdapter sliceTaskParams =
350 execution.getVariable("sliceTaskParams") as SliceTaskParamsAdapter
351 TemplateInfo nstInfo = new TemplateInfo()
352 nstInfo.setUUID(nstSolution.get("UUID") as String)
353 nstInfo.setInvariantUUID(nstSolution.get("invariantUUID") as String)
354 nstInfo.setName(nstSolution.get("NSTName") as String)
356 sliceTaskParams.setNSTInfo(nstInfo)
358 execution.setVariable("sliceTaskParams", sliceTaskParams)
360 } catch (Exception ex) {
361 logger.debug( "Failed to get NST solution suggested by OOF.")
362 exceptionUtil.buildAndThrowWorkflowException(execution, 401, "Failed to get NST solution suggested by OOF.")
367 public void prepareUpdateOrchestrationTask(DelegateExecution execution) {
368 logger.debug("Start prepareUpdateOrchestrationTask")
369 String requestMethod = "PUT"
370 String taskStatus = execution.getVariable("taskStatus")
371 SliceTaskParamsAdapter sliceTaskParams =
372 execution.getVariable("sliceTaskParams") as SliceTaskParamsAdapter
373 String paramJson = sliceTaskParams.convertToJson()
374 execution.setVariable("CSSOT_status", taskStatus)
375 execution.setVariable("CSSOT_paramJson", paramJson)
376 execution.setVariable("CSSOT_requestMethod", requestMethod)
377 logger.debug("Finish prepareUpdateOrchestrationTask")
381 public void prepareGetUserOptions(DelegateExecution execution) {
382 logger.debug("Start prepareGetUserOptions")
383 String requestMethod = "GET"
384 execution.setVariable("taskAction", "commit")
385 String taskAction = execution.getVariable("taskAction")
386 logger.debug("task action is: " + taskAction)
387 if (!"commit".equals(taskAction) && !"abort".equals(taskAction)) {
388 String msg = "Unknown task action: " + taskAction
390 exceptionUtil.buildAndThrowWorkflowException(execution, 500, msg)
392 execution.setVariable("CSSOT_requestMethod", requestMethod)
393 logger.debug("Finish prepareGetUserOptions")
396 public void processUserOptions(DelegateExecution execution) {
397 logger.debug("Start processUserOptions")
398 String response = execution.getVariable("CSSOT_dbResponse")
399 OrchestrationTask orchestrationTask = objectMapper.readValue(response, OrchestrationTask.class)
400 String paramJson = orchestrationTask.getParams()
401 logger.debug("paramJson: " + paramJson)
402 SliceTaskParamsAdapter sliceTaskParams = new SliceTaskParamsAdapter()
403 sliceTaskParams.convertFromJson(paramJson)
404 execution.setVariable("sliceTaskParams", sliceTaskParams)
405 logger.debug("Finish processUserOptions")
408 public void updateAAIOrchStatus(DelegateExecution execution) {
409 logger.debug("Start updateAAIOrchStatus")
410 String serviceInstanceId = execution.getVariable("serviceInstanceId")
411 String orchStatus = execution.getVariable("orchestrationStatus")
414 ServiceInstance si = new ServiceInstance()
415 si.setOrchestrationStatus(orchStatus)
417 AAIResourceUri uri = AAIUriFactory.createResourceUri(Types.SERVICE_INSTANCE.getFragment(serviceInstanceId))
418 client.update(uri, si)
419 } catch (BpmnError e) {
421 } catch (Exception ex) {
422 String msg = "Exception in CreateSliceService.updateAAIOrchStatus " + ex.getMessage()
424 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
427 logger.debug("Finish updateAAIOrchStatus")
430 public void prepareUpdateServiceOperationStatus(DelegateExecution execution) {
431 logger.debug("Start preUpdateServiceOperationStatus")
433 String serviceId = execution.getVariable("serviceInstanceId")
434 String operationId = execution.getVariable("operationId")
435 String operationType = execution.getVariable("operationType")
436 String userId = execution.getVariable("globalSubscriberId")
437 String result = execution.getVariable("operationResult")
438 String progress = execution.getVariable("operationProgress")
439 String reason = execution.getVariable("operationReason")
440 String operationContent = "service: " + result + " progress: " + progress
443 """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
444 xmlns:ns="http://org.onap.so/requestsdb">
447 <ns:initServiceOperationStatus xmlns:ns="http://org.onap.so/requestsdb">
448 <serviceId>${MsoUtils.xmlEscape(serviceId)}</serviceId>
449 <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
450 <operationType>${MsoUtils.xmlEscape(operationType)}</operationType>
451 <userId>${MsoUtils.xmlEscape(userId)}</userId>
452 <result>${MsoUtils.xmlEscape(result)}</result>
453 <operationContent>${MsoUtils.xmlEscape(operationContent)}</operationContent>
454 <progress>${MsoUtils.xmlEscape(progress)}</progress>
455 <reason>${MsoUtils.xmlEscape(reason)}</reason>
456 </ns:initServiceOperationStatus>
458 </soapenv:Envelope>"""
460 payload = utils.formatXml(payload)
461 execution.setVariable("CSSOS_updateServiceOperStatusRequest", payload)
462 logger.debug("Outgoing updateServiceOperStatusRequest: \n" + payload)
465 logger.error(LoggingAnchor.FIVE, MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
466 "Exception Occured Processing preUpdateServiceOperationStatus.", "BPMN",
467 ErrorCode.UnknownError.getValue(), "Exception is:\n" + e.getMessage())
469 logger.debug("Finish preUpdateServiceOperationStatus")
474 public void prepareCompletionRequest (DelegateExecution execution) {
475 logger.trace("Start prepareCompletionRequest")
477 String requestId = execution.getVariable("msoRequestId")
478 String serviceInstanceId = execution.getVariable("serviceInstanceId")
479 String source = execution.getVariable("source")
481 String msoCompletionRequest =
482 """<aetgt:MsoCompletionRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
483 xmlns:ns="http://org.onap/so/request/types/v1">
484 <request-info xmlns="http://org.onap/so/infra/vnf-request/v1">
485 <request-id>${MsoUtils.xmlEscape(requestId)}</request-id>
486 <action>CREATE</action>
487 <source>${MsoUtils.xmlEscape(source)}</source>
489 <status-message>Service Instance was created successfully.</status-message>
490 <serviceInstanceId>${MsoUtils.xmlEscape(serviceInstanceId)}</serviceInstanceId>
491 <mso-bpel-name>CreateGenericALaCarteServiceInstance</mso-bpel-name>
492 </aetgt:MsoCompletionRequest>"""
495 String xmlMsoCompletionRequest = utils.formatXml(msoCompletionRequest)
497 execution.setVariable("completionRequest", xmlMsoCompletionRequest)
498 logger.debug("Overall SUCCESS Response going to CompleteMsoProcess - " + "\n" + xmlMsoCompletionRequest)
500 } catch (Exception ex) {
501 String msg = " Exception in prepareCompletion:" + ex.getMessage()
503 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
505 logger.trace("Finish prepareCompletionRequest")