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.json.JsonUtils
37 import org.onap.so.bpmn.core.UrnPropertiesReader
38 import org.slf4j.Logger
39 import org.slf4j.LoggerFactory
42 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
43 * flow for SDNC Network Resource Activate
45 public class ActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
46 private static final Logger logger = LoggerFactory.getLogger( ActivateSDNCNetworkResource.class);
48 String Prefix = "ACTSDNCRES_"
50 ExceptionUtil exceptionUtil = new ExceptionUtil()
52 JsonUtils jsonUtil = new JsonUtils()
54 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
56 MsoUtils msoUtils = new MsoUtils()
58 public void preProcessRequest(DelegateExecution execution) {
59 logger.info(" ***** Started preProcessRequest *****")
62 //get bpmn inputs from resource request.
63 String requestId = execution.getVariable("mso-request-id")
64 String requestAction = execution.getVariable("requestAction")
65 String recipeParamsFromRequest = execution.getVariable("recipeParams")
66 String resourceInput = execution.getVariable("resourceInput")
67 //Get ResourceInput Object
68 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
69 execution.setVariable(Prefix + "resourceInput", resourceInputObj.toString())
71 //Deal with recipeParams
72 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
73 String resourceName = resourceInputObj.getResourceInstanceName()
74 //For sdnc requestAction default is "createNetworkInstance"
75 String operationType = "Network"
76 if(!StringUtils.isBlank(recipeParamsFromRequest)){
77 //the operationType from worflow(first node) is second priority.
78 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
80 if(!StringUtils.isBlank(recipeParamsFromWf)){
81 //the operationType from worflow(first node) is highest priority.
82 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
85 String sdnc_svcAction = "activate"
86 switch (resourceInputObj.getResourceModelInfo().getModelName()) {
87 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
88 operationType = "SOTNConnectivity"
91 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
92 operationType = "SOTNAttachment"
95 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
96 operationType = "Site"
99 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
100 operationType = "SDWANDevice"
101 execution.setVariable("isActivateRequired", "true")
104 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
105 operationType = "SDWANPort"
106 execution.setVariable("isActivateRequired", "true")
109 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
110 operationType = "SDWANConnectivity"
113 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
114 operationType = "SDWANAttachment"
121 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
122 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
123 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
124 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
125 execution.setVariable("mso-request-id", requestId)
126 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
127 } catch (BpmnError e) {
129 } catch (Exception ex){
130 String msg = "Exception in preProcessRequest " + ex.getMessage()
132 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
136 public void prepareUpdateAfterActivateSDNCResource(DelegateExecution execution) {
137 logger.info("started prepareUpdateAfterActivateSDNCResource ")
139 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(execution.getVariable(Prefix + "resourceInput"), ResourceInput.class)
140 String operType = resourceInputObj.getOperationType()
141 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
142 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
143 String operationId = resourceInputObj.getOperationId()
144 String progress = "80"
145 String status = "activated"
146 String statusDescription = "SDCN resource activation completed"
148 execution.getVariable("operationId")
151 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
152 xmlns:ns="http://org.onap.so/requestsdb">
155 <ns:updateResourceOperationStatus>
156 <operType>${msoUtils.xmlEscape(operType)}</operType>
157 <operationId>${msoUtils.xmlEscape(operationId)}</operationId>
158 <progress>${msoUtils.xmlEscape(progress)}</progress>
159 <resourceTemplateUUID>${msoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
160 <serviceId>${msoUtils.xmlEscape(ServiceInstanceId)}</serviceId>
161 <status>${msoUtils.xmlEscape(status)}</status>
162 <statusDescription>${msoUtils.xmlEscape(statusDescription)}</statusDescription>
163 </ns:updateResourceOperationStatus>
165 </soapenv:Envelope>""";
167 setProgressUpdateVariables(execution, body)
170 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
171 def dbAdapterEndpoint = UrnPropertiesReader.getVariable("mso.adapters.openecomp.db.endpoint", execution)
172 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
173 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
176 String customizeResourceParam(String networkInputParametersJson) {
177 List<Map<String, Object>> paramList = new ArrayList();
178 JSONObject jsonObject = new JSONObject(networkInputParametersJson);
179 Iterator iterator = jsonObject.keys();
180 while (iterator.hasNext()) {
181 String key = iterator.next();
182 HashMap<String, String> hashMap = new HashMap();
183 hashMap.put("name", key);
184 hashMap.put("value", jsonObject.get(key))
185 paramList.add(hashMap)
187 Map<String, List<Map<String, Object>>> paramMap = new HashMap();
188 paramMap.put("param", paramList);
190 return new JSONObject(paramMap).toString();
193 public void prepareSDNCRequest (DelegateExecution execution) {
194 logger.info("Started prepareSDNCRequest ")
198 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
199 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
200 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
201 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
203 String parentServiceInstanceId = execution.getVariable("parentServiceInstanceId")
204 String hdrRequestId = execution.getVariable("mso-request-id")
205 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
206 String source = execution.getVariable("source")
207 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
208 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(execution.getVariable(Prefix + "resourceInput"), ResourceInput.class)
209 String networkInstanceId = execution.getVariable("networkInstanceId")
210 String serviceType = resourceInputObj.getServiceType()
211 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
212 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
213 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
214 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
215 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
216 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
217 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
218 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
219 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
220 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
221 String resourceInputPrameters = resourceInputObj.getResourceParameters()
222 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
223 //here convert json string to xml string
224 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
225 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
226 String sdncTopologyActivateRequest = ""
229 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
230 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
231 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
232 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
233 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
234 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
235 <sdncadapter:RequestHeader>
236 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
237 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
238 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
239 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
240 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
241 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
242 </sdncadapter:RequestHeader>
243 <sdncadapterworkflow:SDNCRequestData>
244 <request-information>
245 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
246 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
247 <source>${msoUtils.xmlEscape(source)}</source>
248 <notification-url></notification-url>
249 <order-number></order-number>
250 <order-version></order-version>
251 </request-information>
252 <service-information>
253 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
254 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
255 <onap-model-information>
256 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
257 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
258 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
259 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
260 </onap-model-information>
261 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
262 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
263 <subscriber-name>${msoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
264 </service-information>
266 <vnf-id>${msoUtils.xmlEscape(networkInstanceId)}</vnf-id>
267 <vnf-type></vnf-type>
268 <onap-model-information>
269 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
270 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
271 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
272 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
273 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
274 </onap-model-information>
277 <vnf-input-parameters>
278 $netowrkInputParameters
279 </vnf-input-parameters>
280 <request-version></request-version>
281 <vnf-name></vnf-name>
285 </sdncadapterworkflow:SDNCRequestData>
286 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
289 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
290 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/:
291 sdncTopologyActivateRequest =
292 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
293 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
294 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
295 <sdncadapter:RequestHeader>
296 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
297 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
298 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
299 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
300 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
301 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
302 </sdncadapter:RequestHeader>
303 <sdncadapterworkflow:SDNCRequestData>
304 <request-information>
305 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
306 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
307 <source>${msoUtils.xmlEscape(source)}</source>
308 <notification-url></notification-url>
309 <order-number></order-number>
310 <order-version></order-version>
311 </request-information>
312 <service-information>
313 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
314 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
315 <onap-model-information>
316 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
317 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
318 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
319 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
320 </onap-model-information>
321 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
322 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
323 </service-information>
324 <allotted-resource-information>
325 <!-- TODO: to be filled as per the request input -->
326 <allotted-resource-id>${msoUtils.xmlEscape(networkInstanceId)}</allotted-resource-id>
327 <allotted-resource-type></allotted-resource-type>
328 <parent-service-instance-id>$parentServiceInstanceId</parent-service-instance-id>
329 <onap-model-information>
330 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
331 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
332 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
333 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
334 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
335 </onap-model-information>
336 </allotted-resource-information>
337 <connection-attachment-request-input>
338 $netowrkInputParameters
339 </connection-attachment-request-input>
340 </sdncadapterworkflow:SDNCRequestData>
341 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
344 // for SDWANConnectivity and SOTN Connectivity
346 sdncTopologyActivateRequest =
347 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
348 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
349 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
350 <sdncadapter:RequestHeader>
351 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
352 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
353 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
354 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
355 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
356 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
357 </sdncadapter:RequestHeader>
358 <sdncadapterworkflow:SDNCRequestData>
359 <request-information>
360 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
361 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
362 <source>${msoUtils.xmlEscape(source)}</source>
363 <notification-url></notification-url>
364 <order-number></order-number>
365 <order-version></order-version>
366 </request-information>
367 <service-information>
368 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
369 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
370 <onap-model-information>
371 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
372 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
373 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
374 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
375 </onap-model-information>
376 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
377 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
378 </service-information>
379 <network-information>
380 <!-- TODO: to be filled by response from create -->
381 <network-id>${msoUtils.xmlEscape(networkInstanceId)}</network-id>
382 <onap-model-information>
383 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
384 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
385 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
386 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
387 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
388 </onap-model-information>
389 </network-information>
390 <network-request-input>
391 <network-input-parameters>$netowrkInputParameters</network-input-parameters>
392 </network-request-input>
393 </sdncadapterworkflow:SDNCRequestData>
394 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
398 String sdncTopologyActivateRequesAsString = utils.formatXml(sdncTopologyActivateRequest)
399 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyActivateRequesAsString)
401 } catch (Exception ex) {
402 String exceptionMessage = " Bpmn error encountered in CreateSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
403 logger.debug(exceptionMessage)
404 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
407 logger.info(" ***** Exit prepareSDNCRequest *****")
410 public void postActivateSDNCCall(DelegateExecution execution) {
411 logger.info("started postCreateSDNCCall ")
413 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
414 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
416 logger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
419 public void sendSyncResponse(DelegateExecution execution) {
420 logger.info("started sendsyncResp")
423 String operationStatus = "finished"
424 // RESTResponse for main flow
425 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
426 logger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
427 sendWorkflowResponse(execution, 202, resourceOperationResp)
428 execution.setVariable("sentSyncResponse", true)
430 } catch (Exception ex) {
431 String msg = "Exception in sendSyncResponse:" + ex.getMessage()
433 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
435 logger.info("exited send sync Resp")