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