1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
/*-
* ============LICENSE_START=======================================================
* OPENECOMP - MSO
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.openecomp.mso.bpmn.common.scripts
import static org.apache.commons.lang3.StringUtils.*
import org.apache.commons.lang3.*
import org.camunda.bpm.engine.delegate.BpmnError
import org.camunda.bpm.engine.runtime.Execution
import org.openecomp.mso.rest.APIResponse
import org.springframework.web.util.UriUtils
/**
* This class supports the GenericDeleteService Sub Flow.
* This Generic sub flow can be used by any flow for the
* goal of deleting a Service-Instance or Service-Subscription.
* The calling flow must set the GENDS_type variable as "service-instance"
* or "service-subscription".
*
* If the resource-version is not provided by the calling flow
* then this sub flow will query the service-instance or
* service-subscription, prior to deleting it, in order to
* obtain this resource version. Upon successful completion of
* this sub flow the GENDS_SuccessIndicator will be true. A
* MSOWorkflowException will be thrown if an error occurs within this flow.
*
* Please map variables to the corresponding variable names
* below.
*
* Note - if this sub flow receives a Not Found (404) response
* from AAI at any time this will be considered an acceptable
* response.
*
* Incoming Variables (Service-Instance):
* @param - GENDS_serviceInstanceId
* @param - GENDS_serviceType
* @param - GENDS_globalCustomerId
* @param - GENDS_type
* @param (Optional) - GENDS_resourceVersion
*
* Incoming Variables (Service-Subscription):
* @param - GENDS_serviceType
* @param - GENDS_globalCustomerId
* @param - GENDS_type
* @param (Optional) - GENDS_resourceVersion
*
*
* Outgoing Variables:
* @param - GENDS_SuccessIndicator
* @param - GENDS_FoundIndicator
* @param - WorkflowException
*/
class GenericDeleteService extends AbstractServiceTaskProcessor{
String Prefix = "GENDS_"
ExceptionUtil exceptionUtil = new ExceptionUtil()
/**
* This method validates the incoming variables and
* determines if the resource version was provided
*
* @param - execution
*/
public void preProcessRequest(Execution execution) {
def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
execution.setVariable("prefix",Prefix)
utils.log("DEBUG", " *** STARTED GenericDeleteService PreProcessRequest Process*** ", isDebugEnabled)
execution.setVariable("GENDS_resourceVersionProvidedFlag", true)
execution.setVariable("GENDS_SuccessIndicator", false)
execution.setVariable("GENDS_FoundIndicator", false)
try{
// Get Variables
String globalCustomerId = execution.getVariable("GENDS_globalCustomerId")
String serviceInstanceId = execution.getVariable("GENDS_serviceInstanceId")
String serviceType = execution.getVariable("GENDS_serviceType")
String type = execution.getVariable("GENDS_type")
if(type != null){
utils.log("DEBUG", "Incoming GENDS_type is: " + type, isDebugEnabled)
if(isBlank(globalCustomerId) || isBlank(serviceType)){
utils.log("DEBUG", "Incoming Required Variable is null!", isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 500, "Incoming Required Variable is Missing or Null!")
}else{
utils.log("DEBUG", "Incoming Global Customer Id is: " + globalCustomerId, isDebugEnabled)
utils.log("DEBUG", "Incoming Service Type is: " + serviceType, isDebugEnabled)
if(type.equalsIgnoreCase("service-instance")){
if(isBlank(serviceInstanceId)){
utils.log("DEBUG", "Incoming Required Variable is null!", isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 500, "Incoming Required Variable is Missing or Null!")
}else{
utils.log("DEBUG", "Incoming Service Instance Id is: " + serviceInstanceId, isDebugEnabled)
utils.log("DEBUG", "Preparing Delete Service-Instance Process", isDebugEnabled)
}
}else if(type.equalsIgnoreCase("service-subscription")){
utils.log("DEBUG", "Preparing Delete Service-Subscription Process", isDebugEnabled)
}else{
exceptionUtil.buildAndThrowWorkflowException(execution, 500, "Incoming Type is Invalid. Please Specify Type as service-instance or service-subscription")
}
}
String resourceVersion = execution.getVariable('GENDS_resourceVersion')
if(isBlank(resourceVersion)){
utils.log("DEBUG", "Service Instance Resource Version is NOT Provided", isDebugEnabled)
execution.setVariable("GENDS_resourceVersionProvidedFlag", false)
}else{
utils.log("DEBUG", "Incoming SI Resource Version is: " + resourceVersion, isDebugEnabled)
}
}else{
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Incoming GENDS_type is null. Variable is Required.")
}
}catch(BpmnError b){
utils.log("DEBUG", "Rethrowing MSOWorkflowException", isDebugEnabled)
throw b
}catch(Exception e){
utils.log("ERROR", " Error encountered within GenericDeleteService PreProcessRequest method!" + e, isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Internal Error - Occured in GenericDeleteService PreProcessRequest")
}
utils.log("DEBUG", "*** COMPLETED GenericDeleteService PreProcessRequest Process ***", isDebugEnabled)
}
/**
* This method executes a GET call to AAI for the service instance
* or service-subscription so that the objects's resource-version
* can be obtained.
*
* @param - execution
*/
public void getServiceResourceVersion(Execution execution){
def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
execution.setVariable("prefix",Prefix)
utils.log("DEBUG", " *** STARTED GenericDeleteService GetServiceResourceVersion Process*** ", isDebugEnabled)
try {
String serviceType = execution.getVariable("GENDS_serviceType")
utils.log("DEBUG", " Incoming GENDS_serviceType is: " + serviceType, isDebugEnabled)
String globalCustomerId = execution.getVariable("GENDS_globalCustomerId")
utils.log("DEBUG", "Incoming Global Customer Id is: " + globalCustomerId, isDebugEnabled)
String type = execution.getVariable("GENDS_type")
String serviceEndpoint = ""
if(type.equalsIgnoreCase("service-instance")){
String serviceInstanceId = execution.getVariable("GENDS_serviceInstanceId")
utils.log("DEBUG", " Incoming GENDS_serviceInstanceId is: " + serviceInstanceId, isDebugEnabled)
serviceEndpoint = UriUtils.encode(globalCustomerId,"UTF-8") + "/service-subscriptions/service-subscription/" + UriUtils.encode(serviceType,"UTF-8") + "/service-instances/service-instance/" + UriUtils.encode(serviceInstanceId,"UTF-8")
}else if(type.equalsIgnoreCase("service-subscription")){
serviceEndpoint = UriUtils.encode(globalCustomerId,"UTF-8") + "/service-subscriptions/service-subscription/" + UriUtils.encode(serviceType,"UTF-8")
}
String aai_endpoint = execution.getVariable("URN_aai_endpoint")
AaiUtil aaiUriUtil = new AaiUtil(this)
String aai_uri = aaiUriUtil.getBusinessCustomerUri(execution)
logDebug('AAI URI is: ' + aai_uri, isDebugEnabled)
String serviceAaiPath = "${aai_endpoint}${aai_uri}/" + serviceEndpoint
execution.setVariable("GENDS_serviceAaiPath", serviceAaiPath)
utils.log("DEBUG", "GET Service Instance AAI Path is: " + "\n" + serviceAaiPath, isDebugEnabled)
utils.logAudit("GenericDeleteService GET AAI Path: " + serviceAaiPath)
APIResponse response = aaiUriUtil.executeAAIGetCall(execution, serviceAaiPath)
int responseCode = response.getStatusCode()
execution.setVariable("GENDS_getServiceResponseCode", responseCode)
utils.log("DEBUG", " GET Service Instance response code is: " + responseCode, isDebugEnabled)
utils.logAudit("GET Service Instance response code: " + responseCode)
String aaiResponse = response.getResponseBodyAsString()
aaiResponse = StringEscapeUtils.unescapeXml(aaiResponse)
execution.setVariable("GENDS_getServiceResponse", aaiResponse)
utils.logAudit("GET Service Instance response : " + aaiResponse)
//Process Response
if(responseCode == 200 || responseCode == 202){
utils.log("DEBUG", "GET Service Received a Good Response: \n" + aaiResponse, isDebugEnabled)
execution.setVariable("GENDS_SuccessIndicator", true)
execution.setVariable("GENDS_FoundIndicator", true)
String resourceVersion = utils.getNodeText1(aaiResponse, "resource-version")
execution.setVariable("GENDS_resourceVersion", resourceVersion)
utils.log("DEBUG", type + " Resource Version is: " + resourceVersion, isDebugEnabled)
}else if(responseCode == 404){
utils.log("DEBUG", "GET Service Received a Not Found (404) Response", isDebugEnabled)
execution.setVariable("GENDS_SuccessIndicator", true)
execution.setVariable("WorkflowResponse", " ") // for junits
}
else{
utils.log("DEBUG", " GET Service Received a Bad Response: \n" + aaiResponse, isDebugEnabled)
exceptionUtil.MapAAIExceptionToWorkflowExceptionGeneric(execution, aaiResponse, responseCode)
throw new BpmnError("MSOWorkflowException")
}
}catch(BpmnError b){
utils.log("DEBUG", "Rethrowing MSOWorkflowException", isDebugEnabled)
throw b
}catch(Exception e){
utils.log("DEBUG", " Error encountered within GenericDeleteService GetServiceResourceVersion method!" + e, isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Internal Error - Occured During GetServiceResourceVersion")
}
utils.log("DEBUG", " *** COMPLETED GenericDeleteService GetServiceResourceVersion Process*** ", isDebugEnabled)
}
/**
* This method executes a DELETE call to AAI for the provided
* service-instance or service-subscription.
*
* @param - execution
*/
public void deleteServiceObject(Execution execution){
def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
execution.setVariable("prefix",Prefix)
utils.log("DEBUG", " *** STARTED GenericDeleteService DeleteServiceObject Process*** ", isDebugEnabled)
try {
AaiUtil aaiUriUtil = new AaiUtil(this)
String type = execution.getVariable("GENDS_type")
String serviceAaiPath = execution.getVariable("GENDS_serviceAaiPath")
String serviceEndpoint = ""
if(isEmpty(serviceAaiPath)){
String serviceType = execution.getVariable("GENDS_serviceType")
utils.log("DEBUG", " Incoming GENDS_serviceType is: " + serviceType, isDebugEnabled)
String globalCustomerId = execution.getVariable("GENDS_globalCustomerId")
utils.log("DEBUG", "Incoming Global Customer Id is: " + globalCustomerId, isDebugEnabled)
if(type.equalsIgnoreCase("service-instance")){
String serviceInstanceId = execution.getVariable("GENDS_serviceInstanceId")
utils.log("DEBUG", " Incoming GENDS_serviceInstanceId is: " + serviceInstanceId, isDebugEnabled)
serviceEndpoint = UriUtils.encode(globalCustomerId,"UTF-8") + "/service-subscriptions/service-subscription/" + UriUtils.encode(serviceType,"UTF-8") + "/service-instances/service-instance/" + UriUtils.encode(serviceInstanceId,"UTF-8")
}else if(type.equalsIgnoreCase("service-subscription")){
serviceEndpoint = UriUtils.encode(globalCustomerId,"UTF-8") + "/service-subscriptions/service-subscription/" + UriUtils.encode(serviceType,"UTF-8")
}
String aai_endpoint = execution.getVariable("URN_aai_endpoint")
String aai_uri = aaiUriUtil.getBusinessCustomerUri(execution)
logDebug('AAI URI is: ' + aai_uri, isDebugEnabled)
serviceAaiPath = "${aai_endpoint}${aai_uri}/" + serviceEndpoint
}
String resourceVersion = execution.getVariable("GENDS_resourceVersion")
utils.log("DEBUG", "Incoming Resource Version is: " + resourceVersion, isDebugEnabled)
if(resourceVersion !=null){
serviceAaiPath = serviceAaiPath +'?resource-version=' + UriUtils.encode(resourceVersion,"UTF-8")
}
execution.setVariable("GENDS_deleteServiceAaiPath", serviceAaiPath)
utils.log("DEBUG", "DELETE Service AAI Path is: " + "\n" + serviceAaiPath, isDebugEnabled)
utils.logAudit("DELETE Service AAI Path: " + serviceAaiPath)
APIResponse response = aaiUriUtil.executeAAIDeleteCall(execution, serviceAaiPath)
int responseCode = response.getStatusCode()
execution.setVariable("GENDS_deleteServiceResponseCode", responseCode)
utils.log("DEBUG", " DELETE Service response code is: " + responseCode, isDebugEnabled)
utils.logAudit("DELETE Service Response Code: " + responseCode)
String aaiResponse = response.getResponseBodyAsString()
aaiResponse = StringEscapeUtils.unescapeXml(aaiResponse)
execution.setVariable("GENDS_deleteServiceResponse", aaiResponse)
utils.logAudit("DELETE Service Response: " + aaiResponse)
//Process Response
if(responseCode == 200 || responseCode == 204){
utils.log("DEBUG", " DELETE Service Received a Good Response", isDebugEnabled)
execution.setVariable("GENDS_FoundIndicator", true)
}else if(responseCode == 404){
utils.log("DEBUG", " DELETE Service Received a Not Found (404) Response", isDebugEnabled)
execution.setVariable("GENDS_FoundIndicator", false)
}else{
utils.log("DEBUG", "DELETE Service Received a BAD REST Response: \n" + aaiResponse, isDebugEnabled)
exceptionUtil.MapAAIExceptionToWorkflowExceptionGeneric(execution, aaiResponse, responseCode)
throw new BpmnError("MSOWorkflowException")
}
}catch(BpmnError b){
utils.log("DEBUG", "Rethrowing MSOWorkflowException", isDebugEnabled)
throw b
}catch(Exception e){
utils.log("DEBUG", " Error encountered within GenericDeleteService DeleteServiceObject method!" + e, isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Internal Error - Occured During Delete Service Object")
}
utils.log("DEBUG", " *** COMPLETED GenericDeleteService DeleteServiceObject Process*** ", isDebugEnabled)
}
}
|
