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