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.logger.MsoLogger
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.camunda.bpm.engine.delegate.DelegateExecution
32 import org.onap.so.bpmn.core.json.JsonUtils
33 import org.onap.so.bpmn.common.scripts.ExceptionUtil
34 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
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 DeActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
43 private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, DeActivateSDNCNetworkResource.class);
44 String Prefix = "DEACTSDNCRES_"
46 ExceptionUtil exceptionUtil = new ExceptionUtil()
48 JsonUtils jsonUtil = new JsonUtils()
50 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
52 MsoUtils msoUtils = new MsoUtils()
54 public void preProcessRequest(DelegateExecution execution) {
56 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
57 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 resourceModelName = resourceInputObj.getResourceModelInfo().getModelName()
73 //For sdnc requestAction default is "NetworkInstance"
74 String operationType = "Network"
75 if(!StringUtils.isBlank(recipeParamsFromRequest) && "null" != 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")
85 // TODO: based on the resource type decide action and operation type
86 String sdnc_svcAction = "deactivate"
87 switch (resourceInputObj.getResourceModelInfo().getModelName()) {
88 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
89 operationType = "SOTNConnectivity"
92 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
93 operationType = "SOTNAttachment"
96 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
97 operationType = "Site"
100 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
101 operationType = "SDWANDevice"
102 execution.setVariable("isActivateRequired", "true")
105 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
106 operationType = "SDWANConnectivity"
109 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
110 operationType = "SDWANAttachment"
113 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
114 operationType = "SDWANPort"
115 execution.setVariable("isActivateRequired", "true")
122 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
123 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
124 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
125 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
126 execution.setVariable("mso-request-id", requestId)
127 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
128 //TODO Here build networkrequest
130 } catch (BpmnError e) {
132 } catch (Exception ex){
133 msg = "Exception in preProcessRequest " + ex.getMessage()
135 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
139 public void prepareSDNCRequest(DelegateExecution execution) {
140 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
141 msoLogger.info(" ***** Started prepareSDNCRequest *****")
145 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
146 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
147 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
148 String deleteNetworkInput = execution.getVariable(Prefix + "networkRequest")
150 String hdrRequestId = execution.getVariable("mso-request-id")
151 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
152 String source = execution.getVariable("source")
153 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
154 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
155 String serviceType = resourceInputObj.getServiceType()
156 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
157 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
158 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
159 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
160 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
161 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
162 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
163 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
164 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
165 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
166 String resourceInstnaceId = resourceInputObj.getResourceInstancenUuid()
167 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
168 String sdncTopologyDeleteRequest = ""
171 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
172 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
173 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
174 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
175 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
176 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
177 <sdncadapter:RequestHeader>
178 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
179 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
180 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
181 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
182 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
183 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
184 </sdncadapter:RequestHeader>
185 <sdncadapterworkflow:SDNCRequestData>
186 <request-information>
187 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
188 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
189 <source>${msoUtils.xmlEncode(source)}</source>
190 <notification-url></notification-url>
191 <order-number></order-number>
192 <order-version></order-version>
193 </request-information>
194 <service-information>
195 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
196 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
197 <onap-model-information>
198 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
199 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
200 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
201 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
202 </onap-model-information>
203 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
204 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
205 <subscriber-name>${msoUtils.xmlEncode(globalCustomerId)}</subscriber-name>
206 </service-information>
208 <vnf-id>$resourceInstnaceId</vnf-id>
209 <vnf-type></vnf-type>
210 <onap-model-information>
211 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
212 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
213 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
214 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
215 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
216 </onap-model-information>
219 <vnf-input-parameters>
220 </vnf-input-parameters>
221 <request-version></request-version>
222 <vnf-name></vnf-name>
226 </sdncadapterworkflow:SDNCRequestData>
227 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
230 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
231 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
232 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
233 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
234 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
235 <sdncadapter:RequestHeader>
236 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
237 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
238 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
239 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
240 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
241 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
242 </sdncadapter:RequestHeader>
243 <sdncadapterworkflow:SDNCRequestData>
244 <request-information>
245 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
246 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
247 <source>${msoUtils.xmlEncode(source)}</source>
248 <notification-url></notification-url>
249 <order-number></order-number>
250 <order-version></order-version>
251 </request-information>
252 <service-information>
253 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
254 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
255 <onap-model-information>
256 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
257 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
258 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
259 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
260 </onap-model-information>
261 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
262 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
263 <subscriber-name></subscriber-name>
264 </service-information>
265 <allotted-resource-information>
266 <allotted-resource-id>$resourceInstnaceId</allotted-resource-id>
267 <allotted-resource-type></allotted-resource-type>
268 <parent-service-instance-id></parent-service-instance-id>
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>
276 </allotted-resource-information>
277 <connection-attachment-request-input>
278 </connection-attachment-request-input>
279 </sdncadapterworkflow:SDNCRequestData>
280 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
284 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
285 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
286 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
287 <sdncadapter:RequestHeader>
288 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
289 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
290 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
291 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
292 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
293 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
294 </sdncadapter:RequestHeader>
295 <sdncadapterworkflow:SDNCRequestData>
296 <request-information>
297 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
298 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
299 <source>${msoUtils.xmlEncode(source)}</source>
300 <notification-url></notification-url>
301 <order-number></order-number>
302 <order-version></order-version>
303 </request-information>
304 <service-information>
305 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
306 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
307 <onap-model-information>
308 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
309 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
310 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
311 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
312 </onap-model-information>
313 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
314 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
315 </service-information>
316 <network-information>
317 <network-id>$resourceInstnaceId</network-id>
318 <onap-model-information>
319 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
320 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
321 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
322 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
323 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
324 </onap-model-information>
325 </network-information>
326 <network-request-input>
327 <network-input-parameters></network-input-parameters>
328 </network-request-input>
329 </sdncadapterworkflow:SDNCRequestData>
330 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
333 String sdncTopologyDeleteRequesAsString = utils.formatXml(sdncTopologyDeleteRequest)
334 utils.logAudit(sdncTopologyDeleteRequesAsString)
335 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyDeleteRequesAsString)
336 msoLogger.info("sdncAdapterWorkflowRequest - " + "\n" + sdncTopologyDeleteRequesAsString)
338 } catch (Exception ex) {
339 String exceptionMessage = " Bpmn error encountered in DeleteSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
340 msoLogger.debug(exceptionMessage)
341 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
344 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
347 public void prepareUpdateAfterDeActivateSDNCResource(DelegateExecution execution) {
348 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
349 String operType = resourceInputObj.getOperationType()
350 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
351 String serviceInstanceId = resourceInputObj.getServiceInstanceId()
352 String operationId = resourceInputObj.getOperationId()
353 String progress = "50"
354 String status = "deactivated"
355 String statusDescription = "SDCN resource deactivation completed"
357 //String operationId = execution.getVariable("operationId")
360 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
361 xmlns:ns="http://org.openecomp.mso/requestsdb">
364 <ns:updateResourceOperationStatus>
365 <operType>${msoUtils.xmlEncode(operType)}</operType>
366 <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
367 <progress>${msoUtils.xmlEncode(progress)}</progress>
368 <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
369 <serviceId>${msoUtils.xmlEncode(serviceInstanceId)}</serviceId>
370 <status>${msoUtils.xmlEncode(status)}</status>
371 <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
372 </ns:updateResourceOperationStatus>
374 </soapenv:Envelope>""";
376 setProgressUpdateVariables(execution, body)
379 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
380 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
381 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
382 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
385 public void postDeactivateSDNCCall(DelegateExecution execution) {
386 def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
387 msoLogger.info(" ***** Started prepareSDNCRequest *****") String responseCode = execution.getVariable(Prefix + "sdncDeleteReturnCode")
388 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
390 msoLogger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
391 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
394 public void sendSyncResponse(DelegateExecution execution) {
395 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
396 msoLogger.debug(" *** sendSyncResponse *** ")
399 String operationStatus = "finished"
400 // RESTResponse for main flow
401 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
402 msoLogger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
403 sendWorkflowResponse(execution, 202, resourceOperationResp)
404 execution.setVariable("sentSyncResponse", true)
406 } catch (Exception ex) {
407 String msg = "Exceptuion in sendSyncResponse:" + ex.getMessage()
409 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
411 msoLogger("DEBUG"," ***** Exit sendSyncResopnse *****")