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