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 static org.apache.commons.lang3.StringUtils.*;
25 import org.apache.commons.lang3.*
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.core.json.JsonUtils
36 import org.onap.so.logger.MsoLogger
41 * This groovy class supports the <class>CreateSDNCCNetworkResource.bpmn</class> process.
42 * flow for SDNC Network Resource Create
44 public class CreateSDNCNetworkResource extends AbstractServiceTaskProcessor {
45 private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, CreateSDNCNetworkResource.class);
47 String Prefix="CRESDNCRES_"
49 ExceptionUtil exceptionUtil = new ExceptionUtil()
51 JsonUtils jsonUtil = new JsonUtils()
53 public void preProcessRequest(DelegateExecution execution){
54 msoLogger.trace("Started preProcessRequest ")
57 //get bpmn inputs from resource request.
58 String requestId = execution.getVariable("mso-request-id")
59 String requestAction = execution.getVariable("requestAction")
60 msoLogger.info("The requestAction is: " + requestAction)
61 String recipeParamsFromRequest = execution.getVariable("recipeParams")
62 msoLogger.info("The recipeParams is: " + recipeParamsFromRequest)
63 String resourceInput = execution.getVariable("resourceInput")
64 msoLogger.info("The resourceInput is: " + 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")
84 //For sdnc, generate svc_action and request_action
85 String sdnc_svcAction = "create"
86 if(StringUtils.containsIgnoreCase(resourceInputObj.getResourceInstanceName(), "overlay")){
87 //This will be resolved in R3.
88 sdnc_svcAction ="activate"
89 operationType = "NCINetwork"
91 if(StringUtils.containsIgnoreCase(resourceInputObj.getResourceInstanceName(), "underlay")){
92 //This will be resolved in R3.
93 operationType ="Network"
95 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
96 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
97 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
98 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
99 execution.setVariable("mso-request-id", requestId)
100 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
101 //TODO Here build networkrequest
103 } catch (BpmnError e) {
105 } catch (Exception ex){
106 msg = "Exception in preProcessRequest " + ex.getMessage()
108 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
112 String customizeResourceParam(String networkInputParametersJson) {
113 List<Map<String, Object>> paramList = new ArrayList();
114 JSONObject jsonObject = new JSONObject(networkInputParametersJson);
115 Iterator iterator = jsonObject.keys();
116 while (iterator.hasNext()) {
117 String key = iterator.next();
118 HashMap<String, String> hashMap = new HashMap();
119 hashMap.put("name", key);
120 hashMap.put("value", jsonObject.get(key))
121 paramList.add(hashMap)
123 Map<String, List<Map<String, Object>>> paramMap = new HashMap();
124 paramMap.put("param", paramList);
126 return new JSONObject(paramMap).toString();
130 * Pre Process the BPMN Flow Request
132 * generate the nsOperationKey
133 * generate the nsParameters
135 public void prepareSDNCRequest (DelegateExecution execution) {
136 msoLogger.trace("Started prepareSDNCRequest ")
140 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
141 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
142 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
143 String createNetworkInput = execution.getVariable(Prefix + "networkRequest")
145 String hdrRequestId = execution.getVariable("mso-request-id")
146 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
147 String source = execution.getVariable("source")
148 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
149 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
150 String serviceType = resourceInputObj.getServiceType()
151 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
152 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
153 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
154 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
155 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
156 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
157 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
158 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
159 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
160 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
161 String resourceInputPrameters = resourceInputObj.getResourceParameters()
162 String networkInputParametersJson = jsonUtil.getJsonValue(resourceInputPrameters, "requestInputs")
163 //here convert json string to xml string
164 String netowrkInputParameters = XML.toString(new JSONObject(customizeResourceParam(networkInputParametersJson)))
165 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
166 String sdncTopologyCreateRequest = ""
170 sdncTopologyCreateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
171 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
172 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
173 <sdncadapter:RequestHeader>
174 <sdncadapter:RequestId>${MsoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
175 <sdncadapter:SvcInstanceId>${MsoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
176 <sdncadapter:SvcAction>${MsoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
177 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
178 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
179 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
180 </sdncadapter:RequestHeader>
181 <sdncadapterworkflow:SDNCRequestData>
182 <request-information>
183 <request-id>${MsoUtils.xmlEscape(hdrRequestId)}</request-id>
184 <request-action>${MsoUtils.xmlEscape(sdnc_requestAction)}</request-action>
185 <source>${MsoUtils.xmlEscape(source)}</source>
186 <notification-url></notification-url>
187 <order-number></order-number>
188 <order-version></order-version>
189 </request-information>
190 <service-information>
191 <service-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-id>
192 <subscription-service-type>${MsoUtils.xmlEscape(serviceType)}</subscription-service-type>
193 <onap-model-information>
194 <model-invariant-uuid>${MsoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
195 <model-uuid>${MsoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
196 <model-version>${MsoUtils.xmlEscape(serviceModelVersion)}</model-version>
197 <model-name>${MsoUtils.xmlEscape(serviceModelName)}</model-name>
198 </onap-model-information>
199 <service-instance-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
200 <global-customer-id>${MsoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
201 </service-information>
202 <subscriber-name>${MsoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
204 <!-- TODO: to be filled as per the request input -->
206 <vnf-type></vnf-type>
207 <onap-model-information>
208 <model-invariant-uuid>${MsoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
209 <model-customization-uuid>${MsoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
210 <model-uuid>${MsoUtils.xmlEscape(modelUuid)}</model-uuid>
211 <model-version>${MsoUtils.xmlEscape(modelVersion)}</model-version>
212 <model-name>${MsoUtils.xmlEscape(modelName)}</model-name>
213 </onap-model-information>
214 </network-information>
215 <vnf-input-parameters>
216 <network-input-parameters>${MsoUtils.xmlEscape(netowrkInputParameters)}</network-input-parameters>
217 </vnf-input-parameters>
219 <request-version></request-version>
220 <vnf-name></vnf-name>
221 <neutron-id></neutron-id>
222 <contrail-network-fqdn></contrail-network-fqdn>
226 <ip-version></ip-version>
227 <subnet-id></subnet-id>
231 </sdncadapterworkflow:SDNCRequestData>
232 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
235 case ~/^SOTNAttachment$/:
236 sdncTopologyCreateRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
237 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
238 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
239 <sdncadapter:RequestHeader>
240 <sdncadapter:RequestId>${MsoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
241 <sdncadapter:SvcInstanceId>${MsoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
242 <sdncadapter:SvcAction>${MsoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
243 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
244 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
245 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
246 </sdncadapter:RequestHeader>
247 <sdncadapterworkflow:SDNCRequestData>
248 <request-information>
249 <request-id>${MsoUtils.xmlEscape(hdrRequestId)}</request-id>
250 <request-action>${MsoUtils.xmlEscape(sdnc_requestAction)}</request-action>
251 <source>${MsoUtils.xmlEscape(source)}</source>
252 <notification-url></notification-url>
253 <order-number></order-number>
254 <order-version></order-version>
255 </request-information>
256 <service-information>
257 <service-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-id>
258 <subscription-service-type>${MsoUtils.xmlEscape(serviceType)}</subscription-service-type>
259 <onap-model-information>
260 <model-invariant-uuid>${MsoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
261 <model-uuid>${MsoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
262 <model-version>${MsoUtils.xmlEscape(serviceModelVersion)}</model-version>
263 <model-name>${MsoUtils.xmlEscape(serviceModelName)}</model-name>
264 </onap-model-information>
265 <service-instance-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
266 <global-customer-id>${MsoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
267 </service-information>
268 <subscriber-name>${MsoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
269 <allotted-resource-information>
270 <!-- TODO: to be filled as per the request input -->
271 <allotted-resource-type></allotted-resource-type>
272 <parent-service-instance-id><parent-service-instance-id>
273 <onap-model-information>
274 <model-invariant-uuid>${MsoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
275 <model-customization-uuid>${MsoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
276 <model-uuid>${MsoUtils.xmlEscape(modelUuid)}</model-uuid>
277 <model-version>${MsoUtils.xmlEscape(modelVersion)}</model-version>
278 <model-name>${MsoUtils.xmlEscape(modelName)}</model-name>
279 </onap-model-information>
280 </allotted-resource-information>
281 <connection-attachment-request-input>
282 <param>${MsoUtils.xmlEscape(netowrkInputParameters)}</param>
283 </connection-attachment-request-input>
284 </sdncadapterworkflow:SDNCRequestData>
285 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
289 sdncTopologyCreateRequest = """<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>network-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 <network-information>
322 <onap-model-information>
323 <model-invariant-uuid>${MsoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
324 <model-customization-uuid>${MsoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
325 <model-uuid>${MsoUtils.xmlEscape(modelUuid)}</model-uuid>
326 <model-version>${MsoUtils.xmlEscape(modelVersion)}</model-version>
327 <model-name>${MsoUtils.xmlEscape(modelName)}</model-name>
328 </onap-model-information>
329 </network-information>
330 <network-request-input>
331 <network-input-parameters>${MsoUtils.xmlEscape(netowrkInputParameters)}</network-input-parameters>
332 </network-request-input>
333 </sdncadapterworkflow:SDNCRequestData>
334 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
337 String sndcTopologyCreateRequesAsString = utils.formatXml(sdncTopologyCreateRequest)
338 msoLogger.debug(sndcTopologyCreateRequesAsString)
339 execution.setVariable("sdncAdapterWorkflowRequest", sndcTopologyCreateRequesAsString)
340 msoLogger.debug("sdncAdapterWorkflowRequest - " + "\n" + sndcTopologyCreateRequesAsString)
342 } catch (Exception ex) {
343 String exceptionMessage = " Bpmn error encountered in CreateSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
344 msoLogger.debug(exceptionMessage)
345 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
348 msoLogger.trace("Exit prepareSDNCRequest ")
351 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
352 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
353 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
354 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
357 public void prepareUpdateBeforeCreateSDNCResource(DelegateExecution execution) {
358 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
359 String operType = resourceInputObj.getOperationType()
360 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
361 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
362 String operationId = resourceInputObj.getOperationId()
363 String progress = "20"
364 String status = "processing"
365 String statusDescription = "SDCN resource creation invoked"
367 execution.getVariable("operationId")
370 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
371 xmlns:ns="http://org.onap.so/requestsdb">
374 <ns:updateResourceOperationStatus>
375 <operType>${MsoUtils.xmlEscape(operType)}</operType>
376 <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
377 <progress>${MsoUtils.xmlEscape(progress)}</progress>
378 <resourceTemplateUUID>${MsoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
379 <serviceId>${MsoUtils.xmlEscape(ServiceInstanceId)}</serviceId>
380 <status>${MsoUtils.xmlEscape(status)}</status>
381 <statusDescription>${MsoUtils.xmlEscape(statusDescription)}</statusDescription>
382 </ns:updateResourceOperationStatus>
384 </soapenv:Envelope>""";
386 setProgressUpdateVariables(execution, body)
390 public void prepareUpdateAfterCreateSDNCResource(execution) {
391 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
392 String operType = resourceInputObj.getOperationType()
393 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
394 String ServiceInstanceId = resourceInputObj.getServiceInstanceId()
395 String operationId = resourceInputObj.getOperationId()
396 String progress = "100"
397 String status = "finished"
398 String statusDescription = "SDCN resource creation completed"
400 execution.getVariable("operationId")
403 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
404 xmlns:ns="http://org.onap.so/requestsdb">
407 <ns:updateResourceOperationStatus>
408 <operType>${MsoUtils.xmlEscape(operType)}</operType>
409 <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
410 <progress>${MsoUtils.xmlEscape(progress)}</progress>
411 <resourceTemplateUUID>${MsoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
412 <serviceId>${MsoUtils.xmlEscape(ServiceInstanceId)}</serviceId>
413 <status>${MsoUtils.xmlEscape(status)}</status>
414 <statusDescription>${MsoUtils.xmlEscape(statusDescription)}</statusDescription>
415 </ns:updateResourceOperationStatus>
417 </soapenv:Envelope>""";
419 setProgressUpdateVariables(execution, body)
422 public void postCreateSDNCCall(DelegateExecution execution){
423 msoLogger.trace("Started prepareSDNCRequest ")
424 String responseCode = execution.getVariable(Prefix + "sdncCreateReturnCode")
425 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
427 msoLogger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
428 msoLogger.trace("Exit prepareSDNCRequest ")
431 public void sendSyncResponse (DelegateExecution execution) {
432 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
433 utils.log("DEBUG", " *** sendSyncResponse *** ", isDebugEnabled)
436 String operationStatus = "finished"
437 // RESTResponse for main flow
438 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
439 utils.log("DEBUG", " sendSyncResponse to APIH:" + "\n" + resourceOperationResp, isDebugEnabled)
440 sendWorkflowResponse(execution, 202, resourceOperationResp)
441 execution.setVariable("sentSyncResponse", true)
443 } catch (Exception ex) {
444 String msg = "Exceptuion in sendSyncResponse:" + ex.getMessage()
445 utils.log("DEBUG", msg, isDebugEnabled)
446 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
448 utils.log("DEBUG"," ***** Exit sendSyncResopnse *****", isDebugEnabled)