2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (c) 2019 Samsung
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.so.bpmn.infrastructure.scripts
25 import org.apache.commons.lang3.StringUtils
26 import org.camunda.bpm.engine.delegate.BpmnError
27 import org.camunda.bpm.engine.delegate.DelegateExecution
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.onap.so.bpmn.common.scripts.ExceptionUtil
32 import org.onap.so.bpmn.common.scripts.MsoUtils
33 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
34 import org.onap.so.bpmn.core.json.JsonUtils
35 import org.onap.so.bpmn.core.UrnPropertiesReader
36 import org.slf4j.Logger
37 import org.slf4j.LoggerFactory
40 * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
41 * flow for SDNC Network Resource Activate
43 public class DeActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
44 private static final Logger logger = LoggerFactory.getLogger( DeActivateSDNCNetworkResource.class);
45 String Prefix = "DEACTSDNCRES_"
47 ExceptionUtil exceptionUtil = new ExceptionUtil()
49 JsonUtils jsonUtil = new JsonUtils()
51 SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
53 MsoUtils msoUtils = new MsoUtils()
55 public void preProcessRequest(DelegateExecution execution) {
57 logger.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 } catch (BpmnError e) {
130 } catch (Exception ex){
131 msg = "Exception in preProcessRequest " + ex.getMessage()
133 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
137 public void prepareSDNCRequest(DelegateExecution execution) {
138 logger.info(" ***** Started prepareSDNCRequest *****")
142 String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
143 String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
144 String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
145 String deleteNetworkInput = execution.getVariable(Prefix + "networkRequest")
147 String hdrRequestId = execution.getVariable("mso-request-id")
148 String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
149 String source = execution.getVariable("source")
150 String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
151 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
152 String serviceType = resourceInputObj.getServiceType()
153 String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
154 String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
155 String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
156 String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
157 String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
158 String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
159 String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
160 String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
161 String modelName = resourceInputObj.getResourceModelInfo().getModelName()
162 String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
163 String resourceInstnaceId = resourceInputObj.getResourceInstancenUuid()
164 // 1. prepare assign topology via SDNC Adapter SUBFLOW call
165 String sdncTopologyDeleteRequest = ""
168 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
169 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
170 case ~/[\w\s\W]*SiteVF[\w\s\W]*/:
171 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
172 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
173 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
174 <sdncadapter:RequestHeader>
175 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
176 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
177 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
178 <sdncadapter:SvcOperation>vnf-topology-operation</sdncadapter:SvcOperation>
179 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
180 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
181 </sdncadapter:RequestHeader>
182 <sdncadapterworkflow:SDNCRequestData>
183 <request-information>
184 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
185 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
186 <source>${msoUtils.xmlEscape(source)}</source>
187 <notification-url></notification-url>
188 <order-number></order-number>
189 <order-version></order-version>
190 </request-information>
191 <service-information>
192 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
193 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
194 <onap-model-information>
195 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
196 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
197 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
198 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
199 </onap-model-information>
200 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
201 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
202 <subscriber-name>${msoUtils.xmlEscape(globalCustomerId)}</subscriber-name>
203 </service-information>
205 <vnf-id>$resourceInstnaceId</vnf-id>
206 <vnf-type></vnf-type>
207 <onap-model-information>
208 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
209 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
210 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
211 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
212 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
213 </onap-model-information>
216 <vnf-input-parameters>
217 </vnf-input-parameters>
218 <request-version></request-version>
219 <vnf-name></vnf-name>
223 </sdncadapterworkflow:SDNCRequestData>
224 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
227 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
228 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
229 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
230 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
231 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
232 <sdncadapter:RequestHeader>
233 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
234 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
235 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
236 <sdncadapter:SvcOperation>connection-attachment-topology-operation</sdncadapter:SvcOperation>
237 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
238 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
239 </sdncadapter:RequestHeader>
240 <sdncadapterworkflow:SDNCRequestData>
241 <request-information>
242 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
243 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
244 <source>${msoUtils.xmlEscape(source)}</source>
245 <notification-url></notification-url>
246 <order-number></order-number>
247 <order-version></order-version>
248 </request-information>
249 <service-information>
250 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
251 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
252 <onap-model-information>
253 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
254 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
255 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
256 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
257 </onap-model-information>
258 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
259 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
260 <subscriber-name></subscriber-name>
261 </service-information>
262 <allotted-resource-information>
263 <allotted-resource-id>$resourceInstnaceId</allotted-resource-id>
264 <allotted-resource-type></allotted-resource-type>
265 <parent-service-instance-id></parent-service-instance-id>
266 <onap-model-information>
267 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
268 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
269 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
270 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
271 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
272 </onap-model-information>
273 </allotted-resource-information>
274 <connection-attachment-request-input>
275 </connection-attachment-request-input>
276 </sdncadapterworkflow:SDNCRequestData>
277 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
281 sdncTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
282 xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
283 xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
284 <sdncadapter:RequestHeader>
285 <sdncadapter:RequestId>${msoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
286 <sdncadapter:SvcInstanceId>${msoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
287 <sdncadapter:SvcAction>${msoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
288 <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
289 <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
290 <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
291 </sdncadapter:RequestHeader>
292 <sdncadapterworkflow:SDNCRequestData>
293 <request-information>
294 <request-id>${msoUtils.xmlEscape(hdrRequestId)}</request-id>
295 <request-action>${msoUtils.xmlEscape(sdnc_requestAction)}</request-action>
296 <source>${msoUtils.xmlEscape(source)}</source>
297 <notification-url></notification-url>
298 <order-number></order-number>
299 <order-version></order-version>
300 </request-information>
301 <service-information>
302 <service-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-id>
303 <subscription-service-type>${msoUtils.xmlEscape(serviceType)}</subscription-service-type>
304 <onap-model-information>
305 <model-invariant-uuid>${msoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
306 <model-uuid>${msoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
307 <model-version>${msoUtils.xmlEscape(serviceModelVersion)}</model-version>
308 <model-name>${msoUtils.xmlEscape(serviceModelName)}</model-name>
309 </onap-model-information>
310 <service-instance-id>${msoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
311 <global-customer-id>${msoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
312 </service-information>
313 <network-information>
314 <network-id>$resourceInstnaceId</network-id>
315 <onap-model-information>
316 <model-invariant-uuid>${msoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
317 <model-customization-uuid>${msoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
318 <model-uuid>${msoUtils.xmlEscape(modelUuid)}</model-uuid>
319 <model-version>${msoUtils.xmlEscape(modelVersion)}</model-version>
320 <model-name>${msoUtils.xmlEscape(modelName)}</model-name>
321 </onap-model-information>
322 </network-information>
323 <network-request-input>
324 <network-input-parameters></network-input-parameters>
325 </network-request-input>
326 </sdncadapterworkflow:SDNCRequestData>
327 </aetgt:SDNCAdapterWorkflowRequest>""".trim()
330 String sdncTopologyDeleteRequesAsString = utils.formatXml(sdncTopologyDeleteRequest)
331 utils.logAudit(sdncTopologyDeleteRequesAsString)
332 execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyDeleteRequesAsString)
333 logger.info("sdncAdapterWorkflowRequest - " + "\n" + sdncTopologyDeleteRequesAsString)
335 } catch (Exception ex) {
336 String exceptionMessage = " Bpmn error encountered in DeleteSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
337 logger.debug(exceptionMessage)
338 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
341 logger.info(" ***** Exit prepareSDNCRequest *****")
344 public void prepareUpdateAfterDeActivateSDNCResource(DelegateExecution execution) {
345 ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
346 String operType = resourceInputObj.getOperationType()
347 String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
348 String serviceInstanceId = resourceInputObj.getServiceInstanceId()
349 String operationId = resourceInputObj.getOperationId()
350 String progress = "50"
351 String status = "deactivated"
352 String statusDescription = "SDCN resource deactivation completed"
354 //String operationId = execution.getVariable("operationId")
357 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
358 xmlns:ns="http://org.onap.so/requestsdb">
361 <ns:updateResourceOperationStatus>
362 <operType>${msoUtils.xmlEscape(operType)}</operType>
363 <operationId>${msoUtils.xmlEscape(operationId)}</operationId>
364 <progress>${msoUtils.xmlEscape(progress)}</progress>
365 <resourceTemplateUUID>${msoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
366 <serviceId>${msoUtils.xmlEscape(serviceInstanceId)}</serviceId>
367 <status>${msoUtils.xmlEscape(status)}</status>
368 <statusDescription>${msoUtils.xmlEscape(statusDescription)}</statusDescription>
369 </ns:updateResourceOperationStatus>
371 </soapenv:Envelope>""";
373 setProgressUpdateVariables(execution, body)
376 private void setProgressUpdateVariables(DelegateExecution execution, String body) {
377 def dbAdapterEndpoint = UrnPropertiesReader.getVariable("mso.adapters.openecomp.db.endpoint", execution)
378 execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
379 execution.setVariable("CVFMI_updateResOperStatusRequest", body)
382 public void postDeactivateSDNCCall(DelegateExecution execution) {
383 logger.info(" ***** Started prepareSDNCRequest *****")
384 String responseCode = execution.getVariable(Prefix + "sdncDeleteReturnCode")
385 String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
387 logger.info("response from sdnc, response code :" + responseCode + " response object :" + responseObj)
388 logger.info(" ***** Exit prepareSDNCRequest *****")
391 public void sendSyncResponse(DelegateExecution execution) {
392 logger.debug(" *** sendSyncResponse *** ")
395 String operationStatus = "finished"
396 // RESTResponse for main flow
397 String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
398 logger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
399 sendWorkflowResponse(execution, 202, resourceOperationResp)
400 execution.setVariable("sentSyncResponse", true)
402 } catch (Exception ex) {
403 String msg = "Exception in sendSyncResponse:" + ex.getMessage()
405 exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
407 logger.debug(" ***** Exit sendSyncResponse *****")