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.logger.MsoLogger
38 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
39 * flow for SDNC Network Resource Activate
41 public class DeActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
42 private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, DeActivateSDNCNetworkResource.class);
43 String Prefix = "DEACTSDNCRES_"
45 ExceptionUtil exceptionUtil = new ExceptionUtil()
47 JsonUtils jsonUtil = new JsonUtils()
49 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
51 public void preProcessRequest(DelegateExecution execution) {
53 msoLogger.info(" ***** Started preProcessRequest *****")
57 //get bpmn inputs from resource request.
58 String requestId = execution.getVariable("mso-request-id")
59 String requestAction = execution.getVariable("requestAction")
60 String recipeParamsFromRequest = execution.getVariable("recipeParams")
61 String resourceInput = execution.getVariable("resourceInput")
62 //Get ResourceInput Object
63 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
64 execution.setVariable(Prefix + "resourceInput", resourceInputObj)
66 //Deal with recipeParams
67 String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
68 String resourceModelName = resourceInputObj.getResourceModelInfo().getModelName()
69 //For sdnc requestAction default is "NetworkInstance"
70 String operationType = "Network"
71 if(!StringUtils.isBlank(recipeParamsFromRequest) && "null" != recipeParamsFromRequest){
72 //the operationType from worflow(first node) is second priority.
73 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
75 if(!StringUtils.isBlank(recipeParamsFromWf)){
76 //the operationType from worflow(first node) is highest priority.
77 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
81 // TODO: based on the resource type decide action and operation type
82 String sdnc_svcAction = "deactivate"
83 switch (resourceInputObj.getResourceModelInfo().getModelName()) {
84 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
85 operationType = "SOTNConnectivity"
88 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
89 operationType = "SOTNAttachment"
92 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
93 operationType = "Site"
96 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
97 operationType = "SDWANDevice"
98 execution.setVariable("isActivateRequired", "true")
101 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
102 operationType = "SDWANConnectivity"
105 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
106 operationType = "SDWANAttachment"
109 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
110 operationType = "SDWANPort"
111 execution.setVariable("isActivateRequired", "true")
118 String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
119 execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
120 execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
121 execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
122 execution.setVariable("mso-request-id", requestId)
123 execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
124 } catch (BpmnError e) {
126 } catch (Exception ex){
127 msg = "Exception in preProcessRequest " + ex.getMessage()
129 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
133 public void prepareSDNCRequest(DelegateExecution execution) {
134 msoLogger.info(" ***** Started prepareSDNCRequest *****")
138 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
139 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
140 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
141 String deleteNetworkInput = execution.getVariable(Prefix + "networkRequest")
143 String hdrRequestId = execution.getVariable("mso-request-id")
144 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
145 String source = execution.getVariable("source")
146 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
147 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
148 String serviceType = resourceInputObj.getServiceType()
149 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
150 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
151 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
152 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
153 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
154 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
155 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
156 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
157 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
158 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
159 String resourceInstnaceId = resourceInputObj.getResourceInstancenUuid()
160 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
161 String sdncTopologyDeleteRequest = ""
164 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
165 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
166 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
167 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
168 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
169 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
170 <sdncadapter:RequestHeader>
171 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
172 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
173 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
174 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
175 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
176 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
177 </sdncadapter:RequestHeader>
178 <sdncadapterworkflow:SDNCRequestData>
179 <request-information>
180 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
181 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
182 <source>${msoUtils.xmlEncode(source)}</source>
183 <notification-url></notification-url>
184 <order-number></order-number>
185 <order-version></order-version>
186 </request-information>
187 <service-information>
188 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
189 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
190 <onap-model-information>
191 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
192 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
193 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
194 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
195 </onap-model-information>
196 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
197 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
198 <subscriber-name>${msoUtils.xmlEncode(globalCustomerId)}</subscriber-name>
199 </service-information>
201 <vnf-id>$resourceInstnaceId</vnf-id>
202 <vnf-type></vnf-type>
203 <onap-model-information>
204 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
205 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
206 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
207 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
208 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
209 </onap-model-information>
212 <vnf-input-parameters>
213 </vnf-input-parameters>
214 <request-version></request-version>
215 <vnf-name></vnf-name>
219 </sdncadapterworkflow:SDNCRequestData>
220 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
223 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
224 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
225 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
226 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
227 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
228 <sdncadapter:RequestHeader>
229 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
230 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
231 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
232 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
233 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
234 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
235 </sdncadapter:RequestHeader>
236 <sdncadapterworkflow:SDNCRequestData>
237 <request-information>
238 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
239 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
240 <source>${msoUtils.xmlEncode(source)}</source>
241 <notification-url></notification-url>
242 <order-number></order-number>
243 <order-version></order-version>
244 </request-information>
245 <service-information>
246 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
247 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
248 <onap-model-information>
249 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
250 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
251 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
252 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
253 </onap-model-information>
254 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
255 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
256 <subscriber-name></subscriber-name>
257 </service-information>
258 <allotted-resource-information>
259 <allotted-resource-id>$resourceInstnaceId</allotted-resource-id>
260 <allotted-resource-type></allotted-resource-type>
261 <parent-service-instance-id></parent-service-instance-id>
262 <onap-model-information>
263 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
264 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
265 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
266 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
267 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
268 </onap-model-information>
269 </allotted-resource-information>
270 <connection-attachment-request-input>
271 </connection-attachment-request-input>
272 </sdncadapterworkflow:SDNCRequestData>
273 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
277 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
278 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
279 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
280 <sdncadapter:RequestHeader>
281 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
282 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
283 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
284 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
285 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
286 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
287 </sdncadapter:RequestHeader>
288 <sdncadapterworkflow:SDNCRequestData>
289 <request-information>
290 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
291 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
292 <source>${msoUtils.xmlEncode(source)}</source>
293 <notification-url></notification-url>
294 <order-number></order-number>
295 <order-version></order-version>
296 </request-information>
297 <service-information>
298 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
299 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
300 <onap-model-information>
301 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
302 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
303 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
304 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
305 </onap-model-information>
306 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
307 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
308 </service-information>
309 <network-information>
310 <network-id>$resourceInstnaceId</network-id>
311 <onap-model-information>
312 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
313 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
314 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
315 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
316 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
317 </onap-model-information>
318 </network-information>
319 <network-request-input>
320 <network-input-parameters></network-input-parameters>
321 </network-request-input>
322 </sdncadapterworkflow:SDNCRequestData>
323 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
326 String sdncTopologyDeleteRequesAsString = utils.formatXml(sdncTopologyDeleteRequest)
327 utils.logAudit(sdncTopologyDeleteRequesAsString)
328 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyDeleteRequesAsString)
329 msoLogger.info("sdncAdapterWorkflowRequest - " + "\n" + sdncTopologyDeleteRequesAsString)
331 } catch (Exception ex) {
332 String exceptionMessage = " Bpmn error encountered in DeleteSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
333 msoLogger.debug(exceptionMessage)
334 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
337 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
340 public void prepareUpdateAfterDeActivateSDNCResource(DelegateExecution execution) {
341 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
342 String operType = resourceInputObj.getOperationType()
343 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
344 String serviceInstanceId = resourceInputObj.getServiceInstanceId()
345 String operationId = resourceInputObj.getOperationId()
346 String progress = "50"
347 String status = "deactivated"
348 String statusDescription = "SDCN resource deactivation completed"
350 //String operationId = execution.getVariable("operationId")
353 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
354 xmlns:ns="http://org.openecomp.mso/requestsdb">
357 <ns:updateResourceOperationStatus>
358 <operType>${msoUtils.xmlEncode(operType)}</operType>
359 <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
360 <progress>${msoUtils.xmlEncode(progress)}</progress>
361 <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
362 <serviceId>${msoUtils.xmlEncode(serviceInstanceId)}</serviceId>
363 <status>${msoUtils.xmlEncode(status)}</status>
364 <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
365 </ns:updateResourceOperationStatus>
367 </soapenv:Envelope>""";
369 setProgressUpdateVariables(execution, body)
372 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
373 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
374 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
375 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
378 public void postDeactivateSDNCCall(DelegateExecution execution) {
379 msoLogger.info(" ***** Started prepareSDNCRequest *****") String responseCode = execution.getVariable(Prefix + "sdncDeleteReturnCode")
380 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
382 msoLogger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
383 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
386 public void sendSyncResponse(DelegateExecution execution) {
387 msoLogger.debug(" *** sendSyncResponse *** ")
390 String operationStatus = "finished"
391 // RESTResponse for main flow
392 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
393 msoLogger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
394 sendWorkflowResponse(execution, 202, resourceOperationResp)
395 execution.setVariable("sentSyncResponse", true)
397 } catch (Exception ex) {
398 String msg = "Exception in sendSyncResponse:" + ex.getMessage()
400 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
402 msoLogger.debug(" ***** Exit sendSyncResponse *****")