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 //TODO Here build networkrequest
126 } catch (BpmnError e) {
128 } catch (Exception ex){
129 msg = "Exception in preProcessRequest " + ex.getMessage()
131 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
135 public void prepareSDNCRequest(DelegateExecution execution) {
136 msoLogger.info(" ***** 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 deleteNetworkInput = 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 resourceInstnaceId = resourceInputObj.getResourceInstancenUuid()
162 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
163 String sdncTopologyDeleteRequest = ""
166 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
167 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
168 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
169 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
170 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
171 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
172 <sdncadapter:RequestHeader>
173 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
174 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
175 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
176 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
177 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
178 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
179 </sdncadapter:RequestHeader>
180 <sdncadapterworkflow:SDNCRequestData>
181 <request-information>
182 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
183 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
184 <source>${msoUtils.xmlEncode(source)}</source>
185 <notification-url></notification-url>
186 <order-number></order-number>
187 <order-version></order-version>
188 </request-information>
189 <service-information>
190 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
191 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
192 <onap-model-information>
193 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
194 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
195 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
196 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
197 </onap-model-information>
198 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
199 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
200 <subscriber-name>${msoUtils.xmlEncode(globalCustomerId)}</subscriber-name>
201 </service-information>
203 <vnf-id>$resourceInstnaceId</vnf-id>
204 <vnf-type></vnf-type>
205 <onap-model-information>
206 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
207 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
208 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
209 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
210 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
211 </onap-model-information>
214 <vnf-input-parameters>
215 </vnf-input-parameters>
216 <request-version></request-version>
217 <vnf-name></vnf-name>
221 </sdncadapterworkflow:SDNCRequestData>
222 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
225 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
226 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
227 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
228 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
229 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
230 <sdncadapter:RequestHeader>
231 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
232 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
233 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
234 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
235 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
236 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
237 </sdncadapter:RequestHeader>
238 <sdncadapterworkflow:SDNCRequestData>
239 <request-information>
240 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
241 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
242 <source>${msoUtils.xmlEncode(source)}</source>
243 <notification-url></notification-url>
244 <order-number></order-number>
245 <order-version></order-version>
246 </request-information>
247 <service-information>
248 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
249 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
250 <onap-model-information>
251 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
252 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
253 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
254 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
255 </onap-model-information>
256 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
257 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
258 <subscriber-name></subscriber-name>
259 </service-information>
260 <allotted-resource-information>
261 <allotted-resource-id>$resourceInstnaceId</allotted-resource-id>
262 <allotted-resource-type></allotted-resource-type>
263 <parent-service-instance-id></parent-service-instance-id>
264 <onap-model-information>
265 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
266 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
267 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
268 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
269 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
270 </onap-model-information>
271 </allotted-resource-information>
272 <connection-attachment-request-input>
273 </connection-attachment-request-input>
274 </sdncadapterworkflow:SDNCRequestData>
275 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
279 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
280 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
281 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
282 <sdncadapter:RequestHeader>
283 <sdncadapter:RequestId>${msoUtils.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
284 <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
285 <sdncadapter:SvcAction>${msoUtils.xmlEncode(sdnc_svcAction)}</sdncadapter:SvcAction>
286 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
287 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
288 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
289 </sdncadapter:RequestHeader>
290 <sdncadapterworkflow:SDNCRequestData>
291 <request-information>
292 <request-id>${msoUtils.xmlEncode(hdrRequestId)}</request-id>
293 <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
294 <source>${msoUtils.xmlEncode(source)}</source>
295 <notification-url></notification-url>
296 <order-number></order-number>
297 <order-version></order-version>
298 </request-information>
299 <service-information>
300 <service-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-id>
301 <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
302 <onap-model-information>
303 <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
304 <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
305 <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
306 <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
307 </onap-model-information>
308 <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
309 <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
310 </service-information>
311 <network-information>
312 <network-id>$resourceInstnaceId</network-id>
313 <onap-model-information>
314 <model-invariant-uuid>${msoUtils.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
315 <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
316 <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
317 <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
318 <model-name>${msoUtils.xmlEncode(modelName)}</model-name>
319 </onap-model-information>
320 </network-information>
321 <network-request-input>
322 <network-input-parameters></network-input-parameters>
323 </network-request-input>
324 </sdncadapterworkflow:SDNCRequestData>
325 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
328 String sdncTopologyDeleteRequesAsString = utils.formatXml(sdncTopologyDeleteRequest)
329 utils.logAudit(sdncTopologyDeleteRequesAsString)
330 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyDeleteRequesAsString)
331 msoLogger.info("sdncAdapterWorkflowRequest - " + "\n" + sdncTopologyDeleteRequesAsString)
333 } catch (Exception ex) {
334 String exceptionMessage = " Bpmn error encountered in DeleteSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
335 msoLogger.debug(exceptionMessage)
336 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
339 msoLogger.info(" ***** Exit prepareSDNCRequest *****")
342 public void prepareUpdateAfterDeActivateSDNCResource(DelegateExecution execution) {
343 ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
344 String operType = resourceInputObj.getOperationType()
345 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
346 String serviceInstanceId = resourceInputObj.getServiceInstanceId()
347 String operationId = resourceInputObj.getOperationId()
348 String progress = "50"
349 String status = "deactivated"
350 String statusDescription = "SDCN resource deactivation completed"
352 //String operationId = execution.getVariable("operationId")
355 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
356 xmlns:ns="http://org.openecomp.mso/requestsdb">
359 <ns:updateResourceOperationStatus>
360 <operType>${msoUtils.xmlEncode(operType)}</operType>
361 <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
362 <progress>${msoUtils.xmlEncode(progress)}</progress>
363 <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
364 <serviceId>${msoUtils.xmlEncode(serviceInstanceId)}</serviceId>
365 <status>${msoUtils.xmlEncode(status)}</status>
366 <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
367 </ns:updateResourceOperationStatus>
369 </soapenv:Envelope>""";
371 setProgressUpdateVariables(execution, body)
374 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
375 def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
376 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
377 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
380 public void postDeactivateSDNCCall(DelegateExecution execution) {
381 msoLogger.info(" ***** Started prepareSDNCRequest *****") 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 = "Exceptuion in sendSyncResponse:" + ex.getMessage()
402 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
404 msoLogger("DEBUG"," ***** Exit sendSyncResopnse *****")