2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
6 * ================================================================================
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.apache.commons.lang3.StringUtils
24 import org.camunda.bpm.engine.delegate.BpmnError
25 import org.json.JSONObject
27 import org.onap.so.bpmn.common.recipe.ResourceInput
28 import org.onap.so.bpmn.common.resource.ResourceRequestBuilder
29 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
30 import org.camunda.bpm.engine.delegate.DelegateExecution
31 import org.onap.so.bpmn.core.json.JsonUtils
32 import org.onap.so.bpmn.common.scripts.ExceptionUtil
33 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
34 import org.onap.so.logger.MsoLogger
35 import org.onap.so.logger.MsoLogger
38 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
39 * flow for SDNC Network Resource Activate
41 public class ActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
42 private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, ActivateSDNCNetworkResource.class);
44 String Prefix = "ACTSDNCRES_"
46 ExceptionUtil exceptionUtil = new ExceptionUtil()
48 JsonUtils jsonUtil = new JsonUtils()
50 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
52 public void preProcessRequest(DelegateExecution execution) {
53 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
54 msoLogger.info(" ***** Started preProcessRequest *****")
57 //get bpmn inputs from resource request.
58 String requestId = execution.getVariable("mso-request-id")
59 String requestAction = execution.getVariable("requestAction")
60 String recipeParamsFromRequest = execution.getVariable("recipeParams")
61 String resourceInput = execution.getVariable("resourceInput")
62 //Get ResourceInput Object
63 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
64 execution.setVariable(Prefix + "resourceInput", resourceInputObj)
66 //Deal with recipeParams
67 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
68 String resourceName = resourceInputObj.getResourceInstanceName()
69 //For sdnc requestAction default is "createNetworkInstance"
70 String operationType = "Network"
71 if(!StringUtils.isBlank(recipeParamsFromRequest)){
72 //the operationType from worflow(first node) is second priority.
73 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
75 if(!StringUtils.isBlank(recipeParamsFromWf)){
76 //the operationType from worflow(first node) is highest priority.
77 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
80 String sdnc_svcAction = "activate"
81 switch (resourceInputObj.getResourceModelInfo().getModelName()) {
82 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
83 operationType = "SOTNConnectivity"
86 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
87 operationType = "SOTNAttachment"
90 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
91 operationType = "Site"
94 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
95 operationType = "SDWANDevice"
96 execution.setVariable("isActivateRequired", "true")
99 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
100 operationType = "SDWANPort"
101 execution.setVariable("isActivateRequired", "true")
104 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
105 operationType = "SDWANConnectivity"
108 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
109 operationType = "SDWANAttachment"
116 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
117 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
118 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
119 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
120 execution.setVariable("mso-request-id", requestId)
121 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
122 } catch (BpmnError e) {
124 } catch (Exception ex){
125 msg = "Exception in preProcessRequest " + ex.getMessage()
126 msoLogger.debug( msg)
127 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
131 public void prepareUpdateAfterActivateSDNCResource(DelegateExecution execution) {
132 msoLogger.info("started prepareUpdateAfterActivateSDNCResource ")
134 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
135 String operType = resourceInputObj.getOperationType()
136 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
137 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
138 String operationId = resourceInputObj.getOperationId()
139 String progress = "80"
140 String status = "activated"
141 String statusDescription = "SDCN resource activation completed"
143 execution.getVariable("operationId")
146 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
147 xmlns:ns="http://org.openecomp.mso/requestsdb">
150 <ns:updateResourceOperationStatus>
151 <operType>${msoUtils.xmlEncode(operType)}</operType>
152 <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
153 <progress>${msoUtils.xmlEncode(progress)}</progress>
154 <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
155 <serviceId>${msoUtils.xmlEncode(ServiceInstanceId)}</serviceId>
156 <status>${msoUtils.xmlEncode(status)}</status>
157 <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
158 </ns:updateResourceOperationStatus>
160 </soapenv:Envelope>""";
162 setProgressUpdateVariables(execution, body)
165 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
166 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
167 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
168 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
171 String customizeResourceParam(String networkInputParametersJson) {
172 List<Map<String, Object>> paramList = new ArrayList();
173 JSONObject jsonObject = new JSONObject(networkInputParametersJson);
174 Iterator iterator = jsonObject.keys();
175 while (iterator.hasNext()) {
176 String key = iterator.next();
177 HashMap<String, String> hashMap = new HashMap();
178 hashMap.put("name", key);
179 hashMap.put("value", jsonObject.get(key))
180 paramList.add(hashMap)
182 Map<String, List<Map<String, Object>>> paramMap = new HashMap();
183 paramMap.put("param", paramList);
185 return new JSONObject(paramMap).toString();
188 public void prepareSDNCRequest (DelegateExecution execution) {
189 msoLogger.info("Started prepareSDNCRequest ")
193 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
194 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
195 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
196 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
198 String parentServiceInstanceId = execution.getVariable("parentServiceInstanceId")
199 String hdrRequestId = execution.getVariable("mso-request-id")
200 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
201 String source = execution.getVariable("source")
202 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
203 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
204 String networkInstanceId = execution.getVariable("networkInstanceId")
205 String serviceType = resourceInputObj.getServiceType()
206 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
207 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
208 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
209 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
210 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
211 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
212 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
213 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
214 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
215 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
216 String resourceInputPrameters = resourceInputObj.getResourceParameters()
217 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
218 //here convert json string to xml string
219 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
220 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
221 String sdncTopologyActivateRequest = ""
224 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
225 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
226 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
227 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
228 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
229 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
230 <sdncadapter:RequestHeader>
231 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
232 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
233 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
234 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
235 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
236 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
237 </sdncadapter:RequestHeader>
238 <sdncadapterworkflow:SDNCRequestData>
239 <request-information>
240 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
241 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
242 <source>${msoUtils.xmlEncode(source)}</source>
243 <notification-url></notification-url>
244 <order-number></order-number>
245 <order-version></order-version>
246 </request-information>
247 <service-information>
248 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
249 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
250 <onap-model-information>
251 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
252 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
253 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
254 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
255 </onap-model-information>
256 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
257 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
258 <subscriber-name>${msoUtils.xmlEncode(globalCustomerId)}</subscriber-name>
259 </service-information>
261 <vnf-id>${msoUtils.xmlEncode(networkInstanceId)}</vnf-id>
262 <vnf-type></vnf-type>
263 <onap-model-information>
264 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
265 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
266 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
267 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
268 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
269 </onap-model-information>
272 <vnf-input-parameters>
273 $netowrkInputParameters
274 </vnf-input-parameters>
275 <request-version></request-version>
276 <vnf-name></vnf-name>
280 </sdncadapterworkflow:SDNCRequestData>
281 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
284 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
285 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/:
286 sdncTopologyActivateRequest =
287 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
288 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
289 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
290 <sdncadapter:RequestHeader>
291 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
292 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
293 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
294 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
295 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
296 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
297 </sdncadapter:RequestHeader>
298 <sdncadapterworkflow:SDNCRequestData>
299 <request-information>
300 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
301 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
302 <source>${msoUtils.xmlEncode(source)}</source>
303 <notification-url></notification-url>
304 <order-number></order-number>
305 <order-version></order-version>
306 </request-information>
307 <service-information>
308 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
309 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
310 <onap-model-information>
311 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
312 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
313 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
314 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
315 </onap-model-information>
316 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
317 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
318 </service-information>
319 <allotted-resource-information>
320 <!-- TODO: to be filled as per the request input -->
321 <allotted-resource-id>${msoUtils.xmlEncode(networkInstanceId)}</allotted-resource-id>
322 <allotted-resource-type></allotted-resource-type>
323 <parent-service-instance-id>$parentServiceInstanceId</parent-service-instance-id>
324 <onap-model-information>
325 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
326 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
327 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
328 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
329 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
330 </onap-model-information>
331 </allotted-resource-information>
332 <connection-attachment-request-input>
333 $netowrkInputParameters
334 </connection-attachment-request-input>
335 </sdncadapterworkflow:SDNCRequestData>
336 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
339 // for SDWANConnectivity and SOTN Connectivity
341 sdncTopologyActivateRequest =
342 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
343 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
344 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
345 <sdncadapter:RequestHeader>
346 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
347 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
348 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
349 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
350 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
351 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
352 </sdncadapter:RequestHeader>
353 <sdncadapterworkflow:SDNCRequestData>
354 <request-information>
355 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
356 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
357 <source>${msoUtils.xmlEncode(source)}</source>
358 <notification-url></notification-url>
359 <order-number></order-number>
360 <order-version></order-version>
361 </request-information>
362 <service-information>
363 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
364 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
365 <onap-model-information>
366 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
367 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
368 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
369 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
370 </onap-model-information>
371 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
372 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
373 </service-information>
374 <network-information>
375 <!-- TODO: to be filled by response from create -->
376 <network-id>${msoUtils.xmlEncode(networkInstanceId)}</network-id>
377 <onap-model-information>
378 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
379 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
380 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
381 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
382 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
383 </onap-model-information>
384 </network-information>
385 <network-request-input>
386 <network-input-parameters>$netowrkInputParameters</network-input-parameters>
387 </network-request-input>
388 </sdncadapterworkflow:SDNCRequestData>
389 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
393 String sdncTopologyActivateRequesAsString = utils.formatXml(sdncTopologyActivateRequest)
394 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyActivateRequesAsString)
396 } catch (Exception ex) {
397 String exceptionMessage = " Bpmn error encountered in CreateSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
398 msoLogger.debug( exceptionMessage)
399 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
402 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
405 public void postActivateSDNCCall(DelegateExecution execution) {
406 msoLogger.info("started postCreateSDNCCall ")
408 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
409 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
411 msoLogger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
414 public void sendSyncResponse(DelegateExecution execution) {
415 msoLogger.dubug(" *** sendSyncResponse *** ")
418 String operationStatus = "finished"
419 // RESTResponse for main flow
420 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
421 msoLogger.dubug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
422 sendWorkflowResponse(execution, 202, resourceOperationResp)
423 execution.setVariable("sentSyncResponse", true)
425 } catch (Exception ex) {
426 String msg = "Exception in sendSyncResponse:" + ex.getMessage()
427 msoLogger.debug( msg)
428 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
430 msoLogger.dubug(" ***** Exit sendSyncResponse *****")