2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (c) 2019 Samsung
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.so.bpmn.infrastructure.scripts
25 import org.apache.commons.lang3.StringUtils
26 import org.camunda.bpm.engine.delegate.BpmnError
27 import org.camunda.bpm.engine.delegate.DelegateExecution
28 import org.json.JSONObject
30 import org.onap.so.bpmn.common.recipe.ResourceInput
31 import org.onap.so.bpmn.common.resource.ResourceRequestBuilder
32 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
33 import org.onap.so.bpmn.common.scripts.ExceptionUtil
34 import org.onap.so.bpmn.common.scripts.MsoUtils
35 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
36 import org.onap.so.bpmn.core.domain.ResourceType
37 import org.onap.so.bpmn.core.json.JsonUtils
38 import org.onap.so.bpmn.core.UrnPropertiesReader
39 import org.slf4j.Logger
40 import org.slf4j.LoggerFactory
43 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
44 * flow for SDNC Network Resource Activate
46 public class ActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
47 private static final Logger logger = LoggerFactory.getLogger( ActivateSDNCNetworkResource.class);
49 String Prefix = "ACTSDNCRES_"
51 ExceptionUtil exceptionUtil = new ExceptionUtil()
53 JsonUtils jsonUtil = new JsonUtils()
55 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
57 MsoUtils msoUtils = new MsoUtils()
59 public void preProcessRequest(DelegateExecution execution) {
60 logger.info(" ***** Started preProcessRequest *****")
63 //get bpmn inputs from resource request.
64 String requestId = execution.getVariable("mso-request-id")
65 String requestAction = execution.getVariable("requestAction")
66 String recipeParamsFromRequest = execution.getVariable("recipeParams")
67 String resourceInput = execution.getVariable("resourceInput")
68 //Get ResourceInput Object
69 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
70 execution.setVariable(Prefix + "resourceInput", resourceInputObj.toString())
72 //Deal with recipeParams
73 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
74 String resourceName = resourceInputObj.getResourceInstanceName()
75 //For sdnc requestAction default is "createNetworkInstance"
76 String operationType = "Network"
77 if(!StringUtils.isBlank(recipeParamsFromRequest)){
78 //the operationType from worflow(first node) is second priority.
79 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
81 if(!StringUtils.isBlank(recipeParamsFromWf)){
82 //the operationType from worflow(first node) is highest priority.
83 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
86 String sdnc_svcAction = "activate"
87 String sdnc_requestAction = UrnPropertiesReader.getVariable("resource-config." + resourceInputObj.resourceModelInfo.getModelName() +".operation-type")
88 String isActivateRequired = UrnPropertiesReader.getVariable("resource-config." + resourceInputObj.resourceModelInfo.getModelName() +".activation-required")
89 execution.setVariable("isActivateRequired", isActivateRequired)
91 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
92 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
93 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
94 execution.setVariable("mso-request-id", requestId)
95 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
96 } catch (BpmnError e) {
98 } catch (Exception ex){
99 String msg = "Exception in preProcessRequest " + ex.getMessage()
101 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
105 public void prepareUpdateAfterActivateSDNCResource(DelegateExecution execution) {
106 logger.info("started prepareUpdateAfterActivateSDNCResource ")
108 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(execution.getVariable(Prefix + "resourceInput"), ResourceInput.class)
109 String operType = resourceInputObj.getOperationType()
110 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
111 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
112 String operationId = resourceInputObj.getOperationId()
113 String progress = "80"
114 String status = "activated"
115 String statusDescription = "SDCN resource activation completed"
117 execution.getVariable("operationId")
120 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
121 xmlns:ns="http://org.onap.so/requestsdb">
124 <ns:updateResourceOperationStatus>
125 <operType>${msoUtils.xmlEscape(operType)}</operType>
126 <operationId>${msoUtils.xmlEscape(operationId)}</operationId>
127 <progress>${msoUtils.xmlEscape(progress)}</progress>
128 <resourceTemplateUUID>${msoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
129 <serviceId>${msoUtils.xmlEscape(ServiceInstanceId)}</serviceId>
130 <status>${msoUtils.xmlEscape(status)}</status>
131 <statusDescription>${msoUtils.xmlEscape(statusDescription)}</statusDescription>
132 </ns:updateResourceOperationStatus>
134 </soapenv:Envelope>""";
136 setProgressUpdateVariables(execution, body)
139 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
140 def dbAdapterEndpoint = UrnPropertiesReader.getVariable("mso.adapters.openecomp.db.endpoint", execution)
141 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
142 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
145 String customizeResourceParam(String networkInputParametersJson) {
146 List<Map<String, Object>> paramList = new ArrayList()
147 JSONObject jsonObject = new JSONObject(networkInputParametersJson);
148 Iterator iterator = jsonObject.keys()
149 while (iterator.hasNext()) {
150 String key = iterator.next()
151 HashMap<String, String> hashMap = new HashMap()
152 hashMap.put("name", key);
153 hashMap.put("value", jsonObject.get(key))
154 paramList.add(hashMap)
156 Map<String, List<Map<String, Object>>> paramMap = new HashMap()
157 paramMap.put("param", paramList)
159 return new JSONObject(paramMap).toString()
162 public void prepareSDNCRequest (DelegateExecution execution) {
163 logger.info("Started prepareSDNCRequest ")
167 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
168 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
169 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
170 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
172 String parentServiceInstanceId = execution.getVariable("parentServiceInstanceId")
173 String hdrRequestId = execution.getVariable("mso-request-id")
174 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
175 String source = execution.getVariable("source")
176 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
177 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(execution.getVariable(Prefix + "resourceInput"), ResourceInput.class)
178 String networkInstanceId = execution.getVariable("networkInstanceId")
179 String serviceType = resourceInputObj.getServiceType()
180 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
181 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
182 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
183 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
184 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
185 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
186 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
187 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
188 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
189 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
190 String resourceInputPrameters = resourceInputObj.getResourceParameters()
191 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
192 //here convert json string to xml string
193 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
194 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
195 String sdncTopologyActivateRequest = ""
196 String modelType = resourceInputObj.getResourceModelInfo().getModelType()
199 sdncTopologyActivateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
200 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
201 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
202 <sdncadapter:RequestHeader>
203 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
204 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
205 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
206 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
207 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
208 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
209 </sdncadapter:RequestHeader>
210 <sdncadapterworkflow:SDNCRequestData>
211 <request-information>
212 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
213 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
214 <source>${msoUtils.xmlEscape(source)}</source>
215 <notification-url></notification-url>
216 <order-number></order-number>
217 <order-version></order-version>
218 </request-information>
219 <service-information>
220 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
221 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
222 <onap-model-information>
223 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
224 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
225 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
226 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
227 </onap-model-information>
228 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
229 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
230 <subscriber-name>${msoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
231 </service-information>
233 <vnf-id>${msoUtils.xmlEscape(networkInstanceId)}</vnf-id>
234 <vnf-type></vnf-type>
235 <onap-model-information>
236 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
237 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
238 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
239 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
240 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
241 </onap-model-information>
244 <vnf-input-parameters>
245 $netowrkInputParameters
246 </vnf-input-parameters>
247 <request-version></request-version>
248 <vnf-name></vnf-name>
252 </sdncadapterworkflow:SDNCRequestData>
253 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
257 sdncTopologyActivateRequest =
258 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
259 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
260 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
261 <sdncadapter:RequestHeader>
262 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
263 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
264 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
265 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
266 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
267 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
268 </sdncadapter:RequestHeader>
269 <sdncadapterworkflow:SDNCRequestData>
270 <request-information>
271 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
272 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
273 <source>${msoUtils.xmlEscape(source)}</source>
274 <notification-url></notification-url>
275 <order-number></order-number>
276 <order-version></order-version>
277 </request-information>
278 <service-information>
279 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
280 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
281 <onap-model-information>
282 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
283 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
284 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
285 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
286 </onap-model-information>
287 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
288 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
289 </service-information>
290 <allotted-resource-information>
291 <!-- TODO: to be filled as per the request input -->
292 <allotted-resource-id>${msoUtils.xmlEscape(networkInstanceId)}</allotted-resource-id>
293 <allotted-resource-type></allotted-resource-type>
294 <parent-service-instance-id>$parentServiceInstanceId</parent-service-instance-id>
295 <onap-model-information>
296 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
297 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
298 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
299 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
300 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
301 </onap-model-information>
302 </allotted-resource-information>
303 <connection-attachment-request-input>
304 $netowrkInputParameters
305 </connection-attachment-request-input>
306 </sdncadapterworkflow:SDNCRequestData>
307 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
310 // for SDWANConnectivity and SOTN Connectivity
312 sdncTopologyActivateRequest =
313 """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
314 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
315 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
316 <sdncadapter:RequestHeader>
317 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
318 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
319 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
320 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
321 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
322 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
323 </sdncadapter:RequestHeader>
324 <sdncadapterworkflow:SDNCRequestData>
325 <request-information>
326 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
327 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
328 <source>${msoUtils.xmlEscape(source)}</source>
329 <notification-url></notification-url>
330 <order-number></order-number>
331 <order-version></order-version>
332 </request-information>
333 <service-information>
334 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
335 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
336 <onap-model-information>
337 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
338 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
339 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
340 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
341 </onap-model-information>
342 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
343 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
344 </service-information>
345 <network-information>
346 <!-- TODO: to be filled by response from create -->
347 <network-id>${msoUtils.xmlEscape(networkInstanceId)}</network-id>
348 <onap-model-information>
349 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
350 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
351 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
352 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
353 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
354 </onap-model-information>
355 </network-information>
356 <network-request-input>
357 <network-input-parameters>$netowrkInputParameters</network-input-parameters>
358 </network-request-input>
359 </sdncadapterworkflow:SDNCRequestData>
360 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
364 String sdncTopologyActivateRequesAsString = utils.formatXml(sdncTopologyActivateRequest)
365 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyActivateRequesAsString)
367 } catch (Exception ex) {
368 String exceptionMessage = " Bpmn error encountered in CreateSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
369 logger.debug(exceptionMessage)
370 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
373 logger.info(" ***** Exit prepareSDNCRequest *****")
376 public void postActivateSDNCCall(DelegateExecution execution) {
377 logger.info("started postCreateSDNCCall ")
379 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
380 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
382 logger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
385 public void sendSyncResponse(DelegateExecution execution) {
386 logger.info("started sendsyncResp")
389 String operationStatus = "finished"
390 // RESTResponse for main flow
391 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
392 logger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
393 sendWorkflowResponse(execution, 202, resourceOperationResp)
394 execution.setVariable("sentSyncResponse", true)
396 } catch (Exception ex) {
397 String msg = "Exception in sendSyncResponse:" + ex.getMessage()
399 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
401 logger.info("exited send sync Resp")