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