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.SDNCAdapterUtils
33 import org.onap.so.bpmn.core.json.JsonUtils
34 import org.onap.so.logger.MsoLogger
37 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
38 * flow for SDNC Network Resource Activate
40 public class ActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
41 private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, ActivateSDNCNetworkResource.class);
43 String Prefix = "ACTSDNCRES_"
45 ExceptionUtil exceptionUtil = new ExceptionUtil()
47 JsonUtils jsonUtil = new JsonUtils()
49 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
51 public void preProcessRequest(DelegateExecution execution) {
52 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
53 msoLogger.info(" ***** Started preProcessRequest *****")
56 //get bpmn inputs from resource request.
57 String requestId = execution.getVariable("mso-request-id")
58 String requestAction = execution.getVariable("requestAction")
59 String recipeParamsFromRequest = execution.getVariable("recipeParams")
60 String resourceInput = execution.getVariable("resourceInput")
61 //Get ResourceInput Object
62 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
63 execution.setVariable(Prefix + "resourceInput", resourceInputObj)
65 //Deal with recipeParams
66 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
67 String resourceName = resourceInputObj.getResourceInstanceName()
68 //For sdnc requestAction default is "createNetworkInstance"
69 String operationType = "Network"
70 if(!StringUtils.isBlank(recipeParamsFromRequest)){
71 //the operationType from worflow(first node) is second priority.
72 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
74 if(!StringUtils.isBlank(recipeParamsFromWf)){
75 //the operationType from worflow(first node) is highest priority.
76 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
79 String sdnc_svcAction = "activate"
80 switch (resourceInputObj.getResourceModelInfo().getModelName()) {
81 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
82 operationType = "SOTNConnectivity"
85 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
86 operationType = "SOTNAttachment"
89 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
90 operationType = "Site"
93 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
94 operationType = "SDWANDevice"
95 execution.setVariable("isActivateRequired", "true")
98 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
99 operationType = "SDWANPort"
100 execution.setVariable("isActivateRequired", "true")
103 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
104 operationType = "SDWANConnectivity"
107 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
108 operationType = "SDWANAttachment"
115 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
116 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
117 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
118 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
119 execution.setVariable("mso-request-id", requestId)
120 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
121 } catch (BpmnError e) {
123 } catch (Exception ex){
124 msg = "Exception in preProcessRequest " + ex.getMessage()
125 msoLogger.debug( msg)
126 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
130 public void prepareUpdateAfterActivateSDNCResource(DelegateExecution execution) {
131 msoLogger.info("started prepareUpdateAfterActivateSDNCResource ")
133 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
134 String operType = resourceInputObj.getOperationType()
135 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
136 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
137 String operationId = resourceInputObj.getOperationId()
138 String progress = "80"
139 String status = "activated"
140 String statusDescription = "SDCN resource activation completed"
142 execution.getVariable("operationId")
145 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
146 xmlns:ns="http://org.openecomp.mso/requestsdb">
149 <ns:updateResourceOperationStatus>
150 <operType>${msoUtils.xmlEncode(operType)}</operType>
151 <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
152 <progress>${msoUtils.xmlEncode(progress)}</progress>
153 <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
154 <serviceId>${msoUtils.xmlEncode(ServiceInstanceId)}</serviceId>
155 <status>${msoUtils.xmlEncode(status)}</status>
156 <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
157 </ns:updateResourceOperationStatus>
159 </soapenv:Envelope>""";
161 setProgressUpdateVariables(execution, body)
164 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
165 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
166 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
167 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
170 String customizeResourceParam(String networkInputParametersJson) {
171 List<Map<String, Object>> paramList = new ArrayList();
172 JSONObject jsonObject = new JSONObject(networkInputParametersJson);
173 Iterator iterator = jsonObject.keys();
174 while (iterator.hasNext()) {
175 String key = iterator.next();
176 HashMap<String, String> hashMap = new HashMap();
177 hashMap.put("name", key);
178 hashMap.put("value", jsonObject.get(key))
179 paramList.add(hashMap)
181 Map<String, List<Map<String, Object>>> paramMap = new HashMap();
182 paramMap.put("param", paramList);
184 return new JSONObject(paramMap).toString();
187 public void prepareSDNCRequest (DelegateExecution execution) {
188 msoLogger.info("Started prepareSDNCRequest ")
192 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
193 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
194 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
195 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
197 String parentServiceInstanceId = execution.getVariable("parentServiceInstanceId")
198 String hdrRequestId = execution.getVariable("mso-request-id")
199 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
200 String source = execution.getVariable("source")
201 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
202 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
203 String networkInstanceId = execution.getVariable("networkInstanceId")
204 String serviceType = resourceInputObj.getServiceType()
205 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
206 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
207 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
208 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
209 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
210 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
211 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
212 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
213 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
214 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
215 String resourceInputPrameters = resourceInputObj.getResourceParameters()
216 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
217 //here convert json string to xml string
218 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
219 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
220 String sdncTopologyActivateRequest = ""
223 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
224 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
225 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
226 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
227 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
228 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
229 <sdncadapter:RequestHeader>
230 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
231 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
232 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
233 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
234 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
235 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
236 </sdncadapter:RequestHeader>
237 <sdncadapterworkflow:SDNCRequestData>
238 <request-information>
239 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
240 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
241 <source>${msoUtils.xmlEncode(source)}</source>
242 <notification-url></notification-url>
243 <order-number></order-number>
244 <order-version></order-version>
245 </request-information>
246 <service-information>
247 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
248 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
249 <onap-model-information>
250 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
251 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
252 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
253 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
254 </onap-model-information>
255 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
256 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
257 <subscriber-name>${msoUtils.xmlEncode(globalCustomerId)}</subscriber-name>
258 </service-information>
260 <vnf-id>${msoUtils.xmlEncode(networkInstanceId)}</vnf-id>
261 <vnf-type></vnf-type>
262 <onap-model-information>
263 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
264 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
265 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
266 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
267 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
268 </onap-model-information>
271 <vnf-input-parameters>
272 $netowrkInputParameters
273 </vnf-input-parameters>
274 <request-version></request-version>
275 <vnf-name></vnf-name>
279 </sdncadapterworkflow:SDNCRequestData>
280 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
283 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
284 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/:
285 sdncTopologyActivateRequest =
286 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
287 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
288 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
289 <sdncadapter:RequestHeader>
290 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
291 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
292 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
293 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
294 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
295 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
296 </sdncadapter:RequestHeader>
297 <sdncadapterworkflow:SDNCRequestData>
298 <request-information>
299 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
300 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
301 <source>${msoUtils.xmlEncode(source)}</source>
302 <notification-url></notification-url>
303 <order-number></order-number>
304 <order-version></order-version>
305 </request-information>
306 <service-information>
307 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
308 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
309 <onap-model-information>
310 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
311 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
312 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
313 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
314 </onap-model-information>
315 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
316 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
317 </service-information>
318 <allotted-resource-information>
319 <!-- TODO: to be filled as per the request input -->
320 <allotted-resource-id>${msoUtils.xmlEncode(networkInstanceId)}</allotted-resource-id>
321 <allotted-resource-type></allotted-resource-type>
322 <parent-service-instance-id>$parentServiceInstanceId</parent-service-instance-id>
323 <onap-model-information>
324 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
325 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
326 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
327 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
328 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
329 </onap-model-information>
330 </allotted-resource-information>
331 <connection-attachment-request-input>
332 $netowrkInputParameters
333 </connection-attachment-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.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
346 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
347 <sdncadapter:SvcAction>${msoUtils.xmlEncode(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.xmlEncode(hdrRequestId)}</request-id>
355 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
356 <source>${msoUtils.xmlEncode(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.xmlEncode(serviceInstanceId)}</service-id>
363 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
364 <onap-model-information>
365 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
366 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
367 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
368 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
369 </onap-model-information>
370 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
371 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
372 </service-information>
373 <network-information>
374 <!-- TODO: to be filled by response from create -->
375 <network-id>${msoUtils.xmlEncode(networkInstanceId)}</network-id>
376 <onap-model-information>
377 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
378 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
379 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
380 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
381 <model-name>${msoUtils.xmlEncode(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 msoLogger.debug( exceptionMessage)
398 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
401 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
404 public void postActivateSDNCCall(DelegateExecution execution) {
405 msoLogger.info("started postCreateSDNCCall ")
407 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
408 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
410 msoLogger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
413 public void sendSyncResponse(DelegateExecution execution) {
414 msoLogger.dubug(" *** sendSyncResponse *** ")
417 String operationStatus = "finished"
418 // RESTResponse for main flow
419 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
420 msoLogger.dubug(" 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()
426 msoLogger.debug( msg)
427 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
429 msoLogger.dubug(" ***** Exit sendSyncResponse *****")