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 Map<String, Object> serviceProfile = execution.getVariable("serviceProfile") as Map<String, Object>
319 execution.setVariable("nstSelectionUrl", "/api/oof/v1/selection/nst")
320 execution.setVariable("nstSelection_messageType", messageType)
321 execution.setVariable("nstSelection_correlator", requestId)
322 String timeout = UrnPropertiesReader.getVariable("mso.adapters.oof.timeout", execution);
323 execution.setVariable("nstSelection_timeout", timeout)
324 String oofRequest = oofUtils.buildSelectNSTRequest(requestId, messageType, serviceProfile)
325 execution.setVariable("nstSelection_oofRequest", oofRequest)
326 logger.debug("Finish prepareSelectNSTRequest")
331 * process async response of oof, put the {@solutions} at {@nstSolution}
334 public void processNSTSolutions(DelegateExecution execution) {
335 Map<String, Object> nstSolution
337 logger.debug("Start processing NSTSolutions")
338 Map<String, Object> resMap =
339 objectMapper.readValue(execution.getVariable("nstSelection_oofResponse") as String,
342 List<Map<String, Object>> nstSolutions = (List<Map<String, Object>>) resMap.get("solutions")
343 nstSolution = nstSolutions.get(0)
344 execution.setVariable("nstSolution", nstSolution)
346 //set nst info into sliceTaskParams
347 SliceTaskParamsAdapter sliceTaskParams =
348 execution.getVariable("sliceTaskParams") as SliceTaskParamsAdapter
349 TemplateInfo nstInfo = new TemplateInfo()
350 nstInfo.setUUID(nstSolution.get("UUID") as String)
351 nstInfo.setInvariantUUID(nstSolution.get("invariantUUID") as String)
352 nstInfo.setName(nstSolution.get("name") as String)
354 sliceTaskParams.setNSTInfo(nstInfo)
356 execution.setVariable("sliceTaskParams", sliceTaskParams)
358 } catch (Exception ex) {
359 logger.debug( "Failed to get NST solution suggested by OOF.")
360 exceptionUtil.buildAndThrowWorkflowException(execution, 401, "Failed to get NST solution suggested by OOF.")
365 public void prepareUpdateOrchestrationTask(DelegateExecution execution) {
366 logger.debug("Start prepareUpdateOrchestrationTask")
367 String requestMethod = "PUT"
368 String taskStatus = execution.getVariable("taskStatus")
369 SliceTaskParamsAdapter sliceTaskParams =
370 execution.getVariable("sliceTaskParams") as SliceTaskParamsAdapter
371 String paramJson = sliceTaskParams.convertToJson()
372 execution.setVariable("CSSOT_status", taskStatus)
373 execution.setVariable("CSSOT_paramJson", paramJson)
374 execution.setVariable("CSSOT_requestMethod", requestMethod)
375 logger.debug("Finish prepareUpdateOrchestrationTask")
379 public void prepareGetUserOptions(DelegateExecution execution) {
380 logger.debug("Start prepareGetUserOptions")
381 String requestMethod = "GET"
382 execution.setVariable("taskAction", "commit")
383 String taskAction = execution.getVariable("taskAction")
384 logger.debug("task action is: " + taskAction)
385 if (!"commit".equals(taskAction) && !"abort".equals(taskAction)) {
386 String msg = "Unknown task action: " + taskAction
388 exceptionUtil.buildAndThrowWorkflowException(execution, 500, msg)
390 execution.setVariable("CSSOT_requestMethod", requestMethod)
391 logger.debug("Finish prepareGetUserOptions")
394 public void processUserOptions(DelegateExecution execution) {
395 logger.debug("Start processUserOptions")
396 String response = execution.getVariable("CSSOT_dbResponse")
397 OrchestrationTask orchestrationTask = objectMapper.readValue(response, OrchestrationTask.class)
398 String paramJson = orchestrationTask.getParams()
399 logger.debug("paramJson: " + paramJson)
400 SliceTaskParamsAdapter sliceTaskParams = new SliceTaskParamsAdapter()
401 sliceTaskParams.convertFromJson(paramJson)
402 execution.setVariable("sliceTaskParams", sliceTaskParams)
403 logger.debug("Finish processUserOptions")
406 public void updateAAIOrchStatus(DelegateExecution execution) {
407 logger.debug("Start updateAAIOrchStatus")
408 String serviceInstanceId = execution.getVariable("serviceInstanceId")
409 String orchStatus = execution.getVariable("orchestrationStatus")
412 ServiceInstance si = new ServiceInstance()
413 si.setOrchestrationStatus(orchStatus)
415 AAIResourceUri uri = AAIUriFactory.createResourceUri(Types.SERVICE_INSTANCE.getFragment(serviceInstanceId))
416 client.update(uri, si)
417 } catch (BpmnError e) {
419 } catch (Exception ex) {
420 String msg = "Exception in CreateSliceService.updateAAIOrchStatus " + ex.getMessage()
422 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
425 logger.debug("Finish updateAAIOrchStatus")
428 public void prepareUpdateServiceOperationStatus(DelegateExecution execution) {
429 logger.debug("Start preUpdateServiceOperationStatus")
431 String serviceId = execution.getVariable("serviceInstanceId")
432 String operationId = execution.getVariable("operationId")
433 String operationType = execution.getVariable("operationType")
434 String userId = execution.getVariable("globalSubscriberId")
435 String result = execution.getVariable("operationResult")
436 String progress = execution.getVariable("operationProgress")
437 String reason = execution.getVariable("operationReason")
438 String operationContent = "service: " + result + " progress: " + progress
441 """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
442 xmlns:ns="http://org.onap.so/requestsdb">
445 <ns:initServiceOperationStatus xmlns:ns="http://org.onap.so/requestsdb">
446 <serviceId>${MsoUtils.xmlEscape(serviceId)}</serviceId>
447 <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
448 <operationType>${MsoUtils.xmlEscape(operationType)}</operationType>
449 <userId>${MsoUtils.xmlEscape(userId)}</userId>
450 <result>${MsoUtils.xmlEscape(result)}</result>
451 <operationContent>${MsoUtils.xmlEscape(operationContent)}</operationContent>
452 <progress>${MsoUtils.xmlEscape(progress)}</progress>
453 <reason>${MsoUtils.xmlEscape(reason)}</reason>
454 </ns:initServiceOperationStatus>
456 </soapenv:Envelope>"""
458 payload = utils.formatXml(payload)
459 execution.setVariable("CSSOS_updateServiceOperStatusRequest", payload)
460 logger.debug("Outgoing updateServiceOperStatusRequest: \n" + payload)
463 logger.error(LoggingAnchor.FIVE, MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
464 "Exception Occured Processing preUpdateServiceOperationStatus.", "BPMN",
465 ErrorCode.UnknownError.getValue(), "Exception is:\n" + e.getMessage())
467 logger.debug("Finish preUpdateServiceOperationStatus")
472 public void prepareCompletionRequest (DelegateExecution execution) {
473 logger.trace("Start prepareCompletionRequest")
475 String requestId = execution.getVariable("msoRequestId")
476 String serviceInstanceId = execution.getVariable("serviceInstanceId")
477 String source = execution.getVariable("source")
479 String msoCompletionRequest =
480 """<aetgt:MsoCompletionRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
481 xmlns:ns="http://org.onap/so/request/types/v1">
482 <request-info xmlns="http://org.onap/so/infra/vnf-request/v1">
483 <request-id>${MsoUtils.xmlEscape(requestId)}</request-id>
484 <action>CREATE</action>
485 <source>${MsoUtils.xmlEscape(source)}</source>
487 <status-message>Service Instance was created successfully.</status-message>
488 <serviceInstanceId>${MsoUtils.xmlEscape(serviceInstanceId)}</serviceInstanceId>
489 <mso-bpel-name>CreateGenericALaCarteServiceInstance</mso-bpel-name>
490 </aetgt:MsoCompletionRequest>"""
493 String xmlMsoCompletionRequest = utils.formatXml(msoCompletionRequest)
495 execution.setVariable("completionRequest", xmlMsoCompletionRequest)
496 logger.debug("Overall SUCCESS Response going to CompleteMsoProcess - " + "\n" + xmlMsoCompletionRequest)
498 } catch (Exception ex) {
499 String msg = " Exception in prepareCompletion:" + ex.getMessage()
501 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
503 logger.trace("Finish prepareCompletionRequest")