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.bpmn.common.scripts.MsoUtils
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()
56 public void preProcessRequest(DelegateExecution execution) {
57 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
58 msoLogger.info(" ***** Started preProcessRequest *****")
61 //get bpmn inputs from resource request.
62 String requestId = execution.getVariable("mso-request-id")
63 String requestAction = execution.getVariable("requestAction")
64 String recipeParamsFromRequest = execution.getVariable("recipeParams")
65 String resourceInput = execution.getVariable("resourceInput")
66 //Get ResourceInput Object
67 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
68 execution.setVariable(Prefix + "resourceInput", resourceInputObj)
70 //Deal with recipeParams
71 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
72 String resourceName = resourceInputObj.getResourceInstanceName()
73 //For sdnc requestAction default is "createNetworkInstance"
74 String operationType = "Network"
75 if(!StringUtils.isBlank(recipeParamsFromRequest)){
76 //the operationType from worflow(first node) is second priority.
77 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
79 if(!StringUtils.isBlank(recipeParamsFromWf)){
80 //the operationType from worflow(first node) is highest priority.
81 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
84 String sdnc_svcAction = "activate"
85 switch (resourceInputObj.getResourceModelInfo().getModelName()) {
86 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
87 operationType = "SOTNConnectivity"
90 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
91 operationType = "SOTNAttachment"
94 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
95 operationType = "Site"
98 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
99 operationType = "SDWANDevice"
100 execution.setVariable("isActivateRequired", "true")
103 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
104 operationType = "SDWANPort"
105 execution.setVariable("isActivateRequired", "true")
108 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
109 operationType = "SDWANConnectivity"
112 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
113 operationType = "SDWANAttachment"
120 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
121 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
122 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
123 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
124 execution.setVariable("mso-request-id", requestId)
125 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
126 } catch (BpmnError e) {
128 } catch (Exception ex){
129 msg = "Exception in preProcessRequest " + ex.getMessage()
130 msoLogger.debug( msg)
131 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
135 public void prepareUpdateAfterActivateSDNCResource(DelegateExecution execution) {
136 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
137 msoLogger.info("started prepareUpdateAfterActivateSDNCResource ")
139 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
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.openecomp.mso/requestsdb">
155 <ns:updateResourceOperationStatus>
156 <operType>${msoUtils.xmlEncode(operType)}</operType>
157 <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
158 <progress>${msoUtils.xmlEncode(progress)}</progress>
159 <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
160 <serviceId>${msoUtils.xmlEncode(ServiceInstanceId)}</serviceId>
161 <status>${msoUtils.xmlEncode(status)}</status>
162 <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
163 </ns:updateResourceOperationStatus>
165 </soapenv:Envelope>""";
167 setProgressUpdateVariables(execution, body)
170 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
171 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
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 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
195 msoLogger.info("Started prepareSDNCRequest ")
199 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
200 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
201 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
202 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
204 String parentServiceInstanceId = execution.getVariable("parentServiceInstanceId")
205 String hdrRequestId = execution.getVariable("mso-request-id")
206 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
207 String source = execution.getVariable("source")
208 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
209 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
210 String networkInstanceId = execution.getVariable("networkInstanceId")
211 String serviceType = resourceInputObj.getServiceType()
212 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
213 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
214 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
215 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
216 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
217 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
218 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
219 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
220 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
221 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
222 String resourceInputPrameters = resourceInputObj.getResourceParameters()
223 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
224 //here convert json string to xml string
225 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
226 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
227 String sdncTopologyActivateRequest = ""
230 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
231 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
232 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
233 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
234 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
235 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
236 <sdncadapter:RequestHeader>
237 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
238 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
239 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
240 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
241 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
242 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
243 </sdncadapter:RequestHeader>
244 <sdncadapterworkflow:SDNCRequestData>
245 <request-information>
246 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
247 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
248 <source>${msoUtils.xmlEncode(source)}</source>
249 <notification-url></notification-url>
250 <order-number></order-number>
251 <order-version></order-version>
252 </request-information>
253 <service-information>
254 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
255 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
256 <onap-model-information>
257 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
258 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
259 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
260 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
261 </onap-model-information>
262 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
263 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
264 <subscriber-name>${msoUtils.xmlEncode(globalCustomerId)}</subscriber-name>
265 </service-information>
267 <vnf-id>${msoUtils.xmlEncode(networkInstanceId)}</vnf-id>
268 <vnf-type></vnf-type>
269 <onap-model-information>
270 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
271 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
272 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
273 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
274 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
275 </onap-model-information>
278 <vnf-input-parameters>
279 $netowrkInputParameters
280 </vnf-input-parameters>
281 <request-version></request-version>
282 <vnf-name></vnf-name>
286 </sdncadapterworkflow:SDNCRequestData>
287 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
290 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
291 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/:
292 sdncTopologyActivateRequest =
293 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
294 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
295 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
296 <sdncadapter:RequestHeader>
297 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
298 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
299 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
300 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
301 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
302 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
303 </sdncadapter:RequestHeader>
304 <sdncadapterworkflow:SDNCRequestData>
305 <request-information>
306 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
307 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
308 <source>${msoUtils.xmlEncode(source)}</source>
309 <notification-url></notification-url>
310 <order-number></order-number>
311 <order-version></order-version>
312 </request-information>
313 <service-information>
314 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
315 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
316 <onap-model-information>
317 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
318 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
319 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
320 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
321 </onap-model-information>
322 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
323 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
324 </service-information>
325 <allotted-resource-information>
326 <!-- TODO: to be filled as per the request input -->
327 <allotted-resource-id>${msoUtils.xmlEncode(networkInstanceId)}</allotted-resource-id>
328 <allotted-resource-type></allotted-resource-type>
329 <parent-service-instance-id>$parentServiceInstanceId</parent-service-instance-id>
330 <onap-model-information>
331 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
332 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
333 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
334 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
335 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
336 </onap-model-information>
337 </allotted-resource-information>
338 <connection-attachment-request-input>
339 $netowrkInputParameters
340 </connection-attachment-request-input>
341 </sdncadapterworkflow:SDNCRequestData>
342 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
345 // for SDWANConnectivity and SOTN Connectivity
347 sdncTopologyActivateRequest =
348 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
349 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
350 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
351 <sdncadapter:RequestHeader>
352 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
353 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
354 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
355 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
356 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
357 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
358 </sdncadapter:RequestHeader>
359 <sdncadapterworkflow:SDNCRequestData>
360 <request-information>
361 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
362 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
363 <source>${msoUtils.xmlEncode(source)}</source>
364 <notification-url></notification-url>
365 <order-number></order-number>
366 <order-version></order-version>
367 </request-information>
368 <service-information>
369 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
370 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
371 <onap-model-information>
372 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
373 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
374 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
375 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
376 </onap-model-information>
377 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
378 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
379 </service-information>
380 <network-information>
381 <!-- TODO: to be filled by response from create -->
382 <network-id>${msoUtils.xmlEncode(networkInstanceId)}</network-id>
383 <onap-model-information>
384 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
385 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
386 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
387 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
388 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
389 </onap-model-information>
390 </network-information>
391 <network-request-input>
392 <network-input-parameters>$netowrkInputParameters</network-input-parameters>
393 </network-request-input>
394 </sdncadapterworkflow:SDNCRequestData>
395 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
399 String sdncTopologyActivateRequesAsString = utils.formatXml(sdncTopologyActivateRequest)
400 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyActivateRequesAsString)
402 } catch (Exception ex) {
403 String exceptionMessage = " Bpmn error encountered in CreateSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
404 msoLogger.debug( exceptionMessage)
405 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
408 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
411 public void postActivateSDNCCall(DelegateExecution execution) {
412 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
413 msoLogger.info("started postCreateSDNCCall ")
415 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
416 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
418 msoLogger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
421 public void sendSyncResponse(DelegateExecution execution) {
422 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
423 msoLogger.dubug(" *** sendSyncResponse *** ")
426 String operationStatus = "finished"
427 // RESTResponse for main flow
428 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
429 msoLogger.dubug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
430 sendWorkflowResponse(execution, 202, resourceOperationResp)
431 execution.setVariable("sentSyncResponse", true)
433 } catch (Exception ex) {
434 String msg = "Exceptuion in sendSyncResponse:" + ex.getMessage()
435 msoLogger.debug( msg)
436 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
438 msoLogger.dubug(" ***** Exit sendSyncResopnse *****")