2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (c) 2019 Samsung
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.so.bpmn.infrastructure.scripts
25 import org.apache.commons.lang3.StringUtils
26 import org.camunda.bpm.engine.delegate.BpmnError
27 import org.camunda.bpm.engine.delegate.DelegateExecution
28 import org.json.JSONObject
30 import org.onap.so.bpmn.common.recipe.ResourceInput
31 import org.onap.so.bpmn.common.resource.ResourceRequestBuilder
32 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
33 import org.onap.so.bpmn.common.scripts.ExceptionUtil
34 import org.onap.so.bpmn.common.scripts.MsoUtils
35 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
36 import org.onap.so.bpmn.core.domain.ModelInfo
37 import org.onap.so.bpmn.core.domain.ResourceType
38 import org.onap.so.bpmn.core.json.JsonUtils
39 import org.onap.so.bpmn.core.UrnPropertiesReader
40 import org.slf4j.Logger
41 import org.slf4j.LoggerFactory
44 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
45 * flow for SDNC Network Resource Activate
47 public class ActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
48 private static final Logger logger = LoggerFactory.getLogger( ActivateSDNCNetworkResource.class);
50 String Prefix = "ACTSDNCRES_"
52 ExceptionUtil exceptionUtil = new ExceptionUtil()
54 JsonUtils jsonUtil = new JsonUtils()
56 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
58 MsoUtils msoUtils = new MsoUtils()
60 public void preProcessRequest(DelegateExecution execution) {
61 logger.info(" ***** Started preProcessRequest *****")
64 //get bpmn inputs from resource request.
65 String requestId = execution.getVariable("mso-request-id")
66 String requestAction = execution.getVariable("requestAction")
67 String recipeParamsFromRequest = execution.getVariable("recipeParams")
68 String resourceInput = execution.getVariable("resourceInput")
69 //Get ResourceInput Object
70 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
71 execution.setVariable(Prefix + "resourceInput", resourceInputObj.toString())
73 //Deal with recipeParams
74 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
75 String resourceName = resourceInputObj.getResourceInstanceName()
76 //For sdnc requestAction default is "createNetworkInstance"
77 String operationType = "Network"
78 if(!StringUtils.isBlank(recipeParamsFromRequest)){
79 //the operationType from worflow(first node) is second priority.
80 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
82 if(!StringUtils.isBlank(recipeParamsFromWf)){
83 //the operationType from worflow(first node) is highest priority.
84 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
87 String sdnc_svcAction = "activate"
88 String sdnc_requestAction = sdnc_svcAction.capitalize() + UrnPropertiesReader.getVariable("resource-config." + resourceInputObj.resourceModelInfo.getModelName() +".operation-type") + "Instance"
90 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
91 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
92 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
93 execution.setVariable("mso-request-id", requestId)
94 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
95 } catch (BpmnError e) {
97 } catch (Exception ex){
98 String msg = "Exception in preProcessRequest " + ex.getMessage()
100 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
104 public void prepareUpdateAfterActivateSDNCResource(DelegateExecution execution) {
105 logger.info("started prepareUpdateAfterActivateSDNCResource ")
107 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(execution.getVariable(Prefix + "resourceInput"), ResourceInput.class)
108 String operType = resourceInputObj.getOperationType()
109 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
110 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
111 String operationId = resourceInputObj.getOperationId()
112 String progress = "80"
113 String status = "activated"
114 String statusDescription = "SDCN resource activation completed"
116 execution.getVariable("operationId")
119 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
120 xmlns:ns="http://org.onap.so/requestsdb">
123 <ns:updateResourceOperationStatus>
124 <operType>${msoUtils.xmlEscape(operType)}</operType>
125 <operationId>${msoUtils.xmlEscape(operationId)}</operationId>
126 <progress>${msoUtils.xmlEscape(progress)}</progress>
127 <resourceTemplateUUID>${msoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
128 <serviceId>${msoUtils.xmlEscape(ServiceInstanceId)}</serviceId>
129 <status>${msoUtils.xmlEscape(status)}</status>
130 <statusDescription>${msoUtils.xmlEscape(statusDescription)}</statusDescription>
131 </ns:updateResourceOperationStatus>
133 </soapenv:Envelope>""";
135 setProgressUpdateVariables(execution, body)
138 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
139 def dbAdapterEndpoint = UrnPropertiesReader.getVariable("mso.adapters.openecomp.db.endpoint", execution)
140 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
141 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
144 String customizeResourceParam(String networkInputParametersJson) {
145 List<Map<String, Object>> paramList = new ArrayList()
146 JSONObject jsonObject = new JSONObject(networkInputParametersJson);
147 Iterator iterator = jsonObject.keys()
148 while (iterator.hasNext()) {
149 String key = iterator.next()
150 HashMap<String, String> hashMap = new HashMap()
151 hashMap.put("name", key);
152 hashMap.put("value", jsonObject.get(key))
153 paramList.add(hashMap)
155 Map<String, List<Map<String, Object>>> paramMap = new HashMap()
156 paramMap.put("param", paramList)
158 return new JSONObject(paramMap).toString()
161 public void prepareSDNCRequest (DelegateExecution execution) {
162 logger.info("Started prepareSDNCRequest ")
166 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
167 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
168 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
169 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
171 String parentServiceInstanceId = execution.getVariable("parentServiceInstanceId")
172 String hdrRequestId = execution.getVariable("mso-request-id")
173 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
174 String source = execution.getVariable("source")
175 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
176 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(execution.getVariable(Prefix + "resourceInput"), ResourceInput.class)
177 String resourceInstanceId = execution.getVariable("resourceInstanceId")
178 String serviceType = resourceInputObj.getServiceType()
179 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
180 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
181 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
182 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
183 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
184 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
185 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
186 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
187 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
188 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
189 String resourceInputPrameters = resourceInputObj.getResourceParameters()
190 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
191 //here convert json string to xml string
192 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
193 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
194 String sdncTopologyActivateRequest = ""
195 String modelType = resourceInputObj.getResourceModelInfo().getModelType()
197 //When a new resource creation request reaches SO, the parent resources information needs to be provided
198 //while creating the child resource.
200 String vnfmodelInvariantUuid = ""
201 String vnfmodelCustomizationUuid = ""
202 String vnfmodelUuid = ""
203 String vnfmodelVersion = ""
204 String vnfmodelName = ""
205 if(modelType.equalsIgnoreCase(ResourceType.GROUP.toString())) {
206 vnfid = resourceInputObj.getVnfId()
207 ModelInfo vfModelInfo = resourceInputObj.getVfModelInfo()
208 vnfmodelInvariantUuid = vfModelInfo.getModelInvariantUuid()
209 vnfmodelCustomizationUuid = vfModelInfo.getModelCustomizationUuid()
210 vnfmodelUuid = vfModelInfo.getModelUuid()
211 vnfmodelVersion = vfModelInfo.getModelVersion()
212 vnfmodelName = vfModelInfo.getModelName()
217 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
218 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
219 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
220 <sdncadapter:RequestHeader>
221 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
222 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
223 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
224 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
225 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
226 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
227 </sdncadapter:RequestHeader>
228 <sdncadapterworkflow:SDNCRequestData>
229 <request-information>
230 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
231 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
232 <source>${msoUtils.xmlEscape(source)}</source>
233 <notification-url></notification-url>
234 <order-number></order-number>
235 <order-version></order-version>
236 </request-information>
237 <service-information>
238 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
239 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
240 <onap-model-information>
241 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
242 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
243 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
244 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
245 </onap-model-information>
246 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
247 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
248 <subscriber-name>${msoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
249 </service-information>
251 <vnf-id>${msoUtils.xmlEscape(resourceInstanceId)}</vnf-id>
252 <vnf-type></vnf-type>
253 <onap-model-information>
254 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
255 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
256 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
257 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
258 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
259 </onap-model-information>
262 <vnf-input-parameters>
263 $netowrkInputParameters
264 </vnf-input-parameters>
265 <request-version></request-version>
266 <vnf-name></vnf-name>
270 </sdncadapterworkflow:SDNCRequestData>
271 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
275 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
276 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
277 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
278 <sdncadapter:RequestHeader>
279 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
280 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
281 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
282 <sdncadapter:SvcOperation>vf-module-topology-operation</sdncadapter:SvcOperation>
283 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
284 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
285 </sdncadapter:RequestHeader>
286 <sdncadapterworkflow:SDNCRequestData>
287 <request-information>
288 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
289 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
290 <source>${msoUtils.xmlEscape(source)}</source>
291 <notification-url></notification-url>
292 <order-number></order-number>
293 <order-version></order-version>
294 </request-information>
295 <service-information>
296 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
297 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
298 <onap-model-information>
299 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
300 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
301 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
302 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
303 </onap-model-information>
304 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
305 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
306 <subscriber-name>${msoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
307 </service-information>
309 <onap-model-information>
310 <model-invariant-uuid>${msoUtils.xmlEscape(vnfmodelInvariantUuid)}</model-invariant-uuid>
311 <model-customization-uuid>${msoUtils.xmlEscape(vnfmodelCustomizationUuid)}</model-customization-uuid>
312 <model-uuid>${msoUtils.xmlEscape(vnfmodelUuid)}</model-uuid>
313 <model-version>${msoUtils.xmlEscape(vnfmodelVersion)}</model-version>
314 <model-name>${msoUtils.xmlEscape(vnfmodelName)}</model-name>
315 </onap-model-information>
316 <vnf-id>${msoUtils.xmlEscape(vnfid)}</vnf-id>
318 <vf-module-information>
319 <from-preload>false</from-preload>
320 <vf-module-id>${msoUtils.xmlEscape(resourceInstanceId)}</vf-module-id>
321 <onap-model-information>
322 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
323 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
324 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
325 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
326 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
327 </onap-model-information>
328 </vf-module-information>
329 <vf-module-request-input>
330 <vf-module-input-parameters>
331 $netowrkInputParameters
332 </vf-module-input-parameters>
333 </vf-module-request-input>
334 </sdncadapterworkflow:SDNCRequestData>
335 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
338 // for SDWANConnectivity and SOTN Connectivity
340 sdncTopologyActivateRequest =
341 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
342 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
343 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
344 <sdncadapter:RequestHeader>
345 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
346 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
347 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
348 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
349 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
350 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
351 </sdncadapter:RequestHeader>
352 <sdncadapterworkflow:SDNCRequestData>
353 <request-information>
354 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
355 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
356 <source>${msoUtils.xmlEscape(source)}</source>
357 <notification-url></notification-url>
358 <order-number></order-number>
359 <order-version></order-version>
360 </request-information>
361 <service-information>
362 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
363 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
364 <onap-model-information>
365 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
366 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
367 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
368 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
369 </onap-model-information>
370 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
371 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
372 </service-information>
373 <network-information>
374 <!-- TODO: to be filled by response from create -->
375 <network-id>${msoUtils.xmlEscape(resourceInstanceId)}</network-id>
376 <onap-model-information>
377 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
378 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
379 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
380 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
381 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
382 </onap-model-information>
383 </network-information>
384 <network-request-input>
385 <network-input-parameters>$netowrkInputParameters</network-input-parameters>
386 </network-request-input>
387 </sdncadapterworkflow:SDNCRequestData>
388 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
392 String sdncTopologyActivateRequesAsString = utils.formatXml(sdncTopologyActivateRequest)
393 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyActivateRequesAsString)
395 } catch (Exception ex) {
396 String exceptionMessage = " Bpmn error encountered in CreateSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
397 logger.debug(exceptionMessage)
398 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
401 logger.info(" ***** Exit prepareSDNCRequest *****")
404 public void postActivateSDNCCall(DelegateExecution execution) {
405 logger.info("started postCreateSDNCCall ")
407 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
408 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
410 logger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
413 public void sendSyncResponse(DelegateExecution execution) {
414 logger.info("started sendsyncResp")
417 String operationStatus = "finished"
418 // RESTResponse for main flow
419 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
420 logger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
421 sendWorkflowResponse(execution, 202, resourceOperationResp)
422 execution.setVariable("sentSyncResponse", true)
424 } catch (Exception ex) {
425 String msg = "Exception in sendSyncResponse:" + ex.getMessage()
427 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
429 logger.info("exited send sync Resp")