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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Modifications Copyright (c) 2019 Samsung
* ================================================================================
* 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.onap.so.bpmn.common.scripts
import com.google.common.base.Strings
import org.apache.commons.lang3.StringUtils
import org.camunda.bpm.engine.delegate.DelegateExecution
import org.json.JSONArray
import org.json.JSONObject
import org.onap.logging.ref.slf4j.ONAPLogConstants
import org.onap.so.bpmn.core.UrnPropertiesReader
import org.onap.so.bpmn.core.json.JsonUtils
import org.onap.so.client.HttpClient
import org.onap.so.client.HttpClientFactory
import org.onap.so.logger.ErrorCode
import org.onap.so.logger.MessageEnum
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.onap.so.utils.TargetEntity
import org.springframework.web.util.UriUtils
import javax.ws.rs.core.MediaType
import javax.ws.rs.core.Response
/***
* Utilities for accessing Catalog DB Adapter to retrieve Networks, VNF/VFModules, AllottedResources and complete ServiceResources information
*
*/
class CatalogDbUtils {
private static final Logger logger = LoggerFactory.getLogger( CatalogDbUtils.class);
private HttpClientFactory httpClientFactory
private MsoUtils utils
private JsonUtils jsonUtils
static private String defaultDbAdapterVersion = "v2"
CatalogDbUtils(HttpClientFactory httpClientFactory, JsonUtils jsonUtils) {
this.httpClientFactory = httpClientFactory
this.utils = new MsoUtils()
this.jsonUtils = jsonUtils
}
public JSONArray getAllVnfsByVnfModelCustomizationUuid(DelegateExecution execution, String vnfModelCustomizationUuid, String catalogUtilsVersion) {
JSONArray vnfsList = null
String endPoint = "/serviceVnfs?vnfModelCustomizationUuid=" + UriUtils.encode(vnfModelCustomizationUuid, "UTF-8")
try {
logger.debug("ENDPOINT: " + endPoint)
String catalogDbResponse = getResponseFromCatalogDb(execution, endPoint)
if (catalogDbResponse != null) {
if (!catalogUtilsVersion.equals("v1")) {
JSONObject responseJson = new JSONObject(catalogDbResponse)
vnfsList = responseJson.getJSONArray("serviceVnfs")
}
else {
vnfsList = parseVnfsJson(catalogDbResponse, "serviceVnfs", catalogUtilsVersion)
}
}
}
catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in Querying Catalog DB", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
throw e
}
return vnfsList
}
public JSONObject getServiceResourcesByServiceModelUuid(DelegateExecution execution, String serviceModelUuid, String catalogUtilsVersion) {
JSONObject resources = null
String endPoint = "/serviceResources?serviceModelUuid=" + UriUtils.encode(serviceModelUuid, "UTF-8")
try {
String catalogDbResponse = getResponseFromCatalogDb(execution, endPoint)
if (catalogDbResponse != null) {
if (!catalogUtilsVersion.equals("v1")) {
resources = new JSONObject(catalogDbResponse)
}
else {
resources = parseServiceResourcesJson(catalogDbResponse, catalogUtilsVersion)
}
}
}
catch (Exception e) {
logger.error("Exception in Querying Catalog DB: " + e.message)
throw e
}
return resources
}
public String getServiceResourcesByServiceModelInvariantUuidString(DelegateExecution execution, String serviceModelInvariantUuid) {
String endPoint = "/serviceResources?serviceModelInvariantUuid=" + UriUtils.encode(serviceModelInvariantUuid, "UTF-8")
try {
return getResponseFromCatalogDb(execution, endPoint)
}
catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in Querying Catalog DB", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
throw e
}
}
public JSONObject getServiceResourcesByServiceModelInvariantUuid(DelegateExecution execution, String serviceModelInvariantUuid, String catalogUtilsVersion) {
JSONObject resources = null
String endPoint = "/serviceResources?serviceModelInvariantUuid=" + UriUtils.encode(serviceModelInvariantUuid, "UTF-8")
try {
String catalogDbResponse = getResponseFromCatalogDb(execution, endPoint)
if (catalogDbResponse != null) {
if (!catalogUtilsVersion.equals("v1")) {
resources = new JSONObject(catalogDbResponse)
}
else {
resources = parseServiceResourcesJson(catalogDbResponse, catalogUtilsVersion)
}
}
}
catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in Querying Catalog DB", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
throw e
}
return resources
}
public JSONObject getServiceResourcesByServiceModelInvariantUuidAndServiceModelVersion(DelegateExecution execution, String serviceModelInvariantUuid, String serviceModelVersion, String catalogUtilsVersion) {
JSONObject resources = null
String endPoint = "/serviceResources?serviceModelInvariantUuid=" + UriUtils.encode(serviceModelInvariantUuid, "UTF-8") + "&serviceModelVersion=" + UriUtils.encode(serviceModelVersion, "UTF-8")
try {
String catalogDbResponse = getResponseFromCatalogDb(execution, endPoint)
if (catalogDbResponse != null) {
if (!catalogUtilsVersion.equals("v1")) {
resources = new JSONObject(catalogDbResponse)
}
else {
resources = parseServiceResourcesJson(catalogDbResponse, catalogUtilsVersion)
}
}
}
catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in Querying Catalog DB", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
throw e
}
return resources
}
private JSONArray parseNetworksJson (String catalogDbResponse, String arrayName, String catalogUtilsVersion) {
JSONArray modelInfos = null
logger.debug("parseNetworksJson - catalogUtilsVersion is " + catalogUtilsVersion)
try {
// Create array of jsons
JSONObject responseJson = new JSONObject(catalogDbResponse)
JSONArray networks = responseJson.getJSONArray(arrayName)
modelInfos = new JSONArray()
for (int i = 0; i < networks.length(); i++) {
JSONObject network = networks.getJSONObject(i)
JSONObject modelJson = new JSONObject()
JSONObject modelInfo = buildModelInfo("network", network, catalogUtilsVersion)
modelJson.put("modelInfo", modelInfo)
String networkType = jsonUtils.getJsonValueForKey(network, "networkType")
modelJson.put("networkType", networkType)
switch (catalogUtilsVersion) {
case "v1":
break
default:
String toscaNodeType = jsonUtils.getJsonValueForKey(network, "toscaNodeType")
modelJson.put("toscaNodeType", toscaNodeType)
String networkTechnology = jsonUtils.getJsonValueForKey(network, "networkTechnology")
modelJson.put("networkTechnology", networkTechnology)
String networkRole = jsonUtils.getJsonValueForKey(network, "networkRole")
modelJson.put("networkRole", networkRole)
String networkScope = jsonUtils.getJsonValueForKey(network, "networkScope")
modelJson.put("networkScope", networkScope)
break
}
modelInfos.put(modelJson)
}
String modelInfosString = modelInfos.toString()
logger.debug("Returning networks JSON: " + modelInfosString)
} catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in parsing Catalog DB Response", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
}
return modelInfos
}
private JSONArray parseVnfsJson (String catalogDbResponse, String arrayName, String catalogUtilsVersion) {
JSONArray modelInfos = null
logger.debug("parseVnfsJson - catalogUtilsVersion is " + catalogUtilsVersion)
try {
// Create array of jsons
JSONObject responseJson = new JSONObject(catalogDbResponse)
JSONArray vnfs = responseJson.getJSONArray(arrayName)
modelInfos = new JSONArray()
for (int i = 0; i < vnfs.length(); i++) {
JSONObject vnf = vnfs.getJSONObject(i)
logger.debug(vnf.toString(2))
JSONObject modelInfo = buildModelInfo("vnf", vnf, catalogUtilsVersion)
JSONObject modelJson = new JSONObject()
modelJson.put("modelInfo", modelInfo)
switch(catalogUtilsVersion) {
case "v1":
break
default:
String toscaNodeType = jsonUtils.getJsonValueForKey(vnf, "toscaNodeType")
modelJson.put("toscaNodeType", toscaNodeType)
String nfType = jsonUtils.getJsonValueForKey(vnf, "nfType")
modelJson.put("nfType", nfType)
String nfRole = jsonUtils.getJsonValueForKey(vnf, "nfRole")
modelJson.put("nfRole", nfRole)
String nfCode = jsonUtils.getJsonValueForKey(vnf, "nfCode")
modelJson.put("nfNamingCode", nfCode)
String nfFunction = jsonUtils.getJsonValueForKey(vnf, "nfFunction")
modelJson.put("nfFunction", nfFunction)
String multiStageDesign = jsonUtils.getJsonValueForKey(vnf, "multiStageDesign")
modelJson.put("multiStageDesign", multiStageDesign)
break
}
JSONArray vfModules = null
try {
vfModules = vnf.getJSONArray("vfModules")
} catch (Exception e)
{
logger.debug("Cannot find VF MODULE ARRAY: " + i + ", exception is " + e.message)
}
if (vfModules != null) {
JSONArray vfModuleInfo = new JSONArray()
for (int j = 0; j < vfModules.length(); j++) {
JSONObject vfModule = vfModules.getJSONObject(j)
JSONObject vfModuleModelInfo = buildModelInfo("vfModule", vfModule, catalogUtilsVersion)
JSONObject vfModuleModelJson = new JSONObject()
vfModuleModelJson.put("modelInfo", vfModuleModelInfo)
String vfModuleType = jsonUtils.getJsonValueForKey(vfModule, "type")
vfModuleModelJson.put("vfModuleType", vfModuleType)
vfModuleModelJson.put("isBase", jsonUtils.getJsonBooleanValueForKey(vfModule, "isBase"))
String vfModuleLabel = jsonUtils.getJsonValueForKey(vfModule, "label")
vfModuleModelJson.put("vfModuleLabel", vfModuleLabel)
Integer initialCount = jsonUtils.getJsonIntValueForKey(vfModule, "initialCount")
vfModuleModelJson.put("initialCount", initialCount.intValue())
vfModuleInfo.put(vfModuleModelJson)
}
modelJson.put("vfModules", vfModuleInfo)
}
modelInfos.put(modelJson)
}
String modelInfosString = modelInfos.toString()
logger.debug("Returning vnfs JSON: " + modelInfosString)
} catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in parsing Catalog DB Response", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
}
return modelInfos
}
private JSONArray parseAllottedResourcesJson (String catalogDbResponse, String arrayName, String catalogUtilsVersion) {
JSONArray modelInfos = null
logger.debug("parseAllottedResourcesJson - catalogUtilsVersion is " + catalogUtilsVersion)
try {
// Create array of jsons
JSONObject responseJson = new JSONObject(catalogDbResponse)
JSONArray allottedResources = responseJson.getJSONArray(arrayName)
modelInfos = new JSONArray()
for (int i = 0; i < allottedResources.length(); i++) {
JSONObject allottedResource = allottedResources.getJSONObject(i)
JSONObject modelInfo = buildModelInfo("allottedResource", allottedResource, catalogUtilsVersion)
JSONObject modelJson = new JSONObject()
modelJson.put("modelInfo", modelInfo)
switch(catalogUtilsVersion) {
case "v1":
break
default:
String toscaNodeType = jsonUtils.getJsonValueForKey(allottedResource, "toscaNodeType")
modelJson.put("toscaNodeType", toscaNodeType)
String nfType = jsonUtils.getJsonValueForKey(allottedResource, "nfType")
modelJson.put("nfType", nfType)
String nfRole = jsonUtils.getJsonValueForKey(allottedResource, "nfRole")
modelJson.put("nfRole", nfRole)
String nfCode = jsonUtils.getJsonValueForKey(allottedResource, "nfCode")
modelJson.put("nfNamingCode", nfCode)
String nfFunction = jsonUtils.getJsonValueForKey(allottedResource, "nfFunction")
modelJson.put("nfFunction", nfFunction)
String providingServiceModelName = jsonUtils.getJsonValueForKey(allottedResource, "providingServiceModelName")
modelJson.put("providingServiceModelName", providingServiceModelName)
String providingServiceModelUuid = jsonUtils.getJsonValueForKey(allottedResource, "providingServiceModelUuid")
modelJson.put("providingServiceModelUuid", providingServiceModelUuid)
break
}
modelInfos.put(modelJson)
}
String modelInfosString = modelInfos.toString()
logger.debug("Returning allottedResources JSON: " + modelInfosString)
} catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in parsing Catalog DB Response", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
}
return modelInfos
}
private JSONObject parseServiceResourcesJson (String catalogDbResponse, String catalogUtilsVersion) {
JSONObject serviceResources = new JSONObject()
JSONObject serviceResourcesObject = new JSONObject()
try {
// Create array of jsons
JSONObject responseJson = new JSONObject(catalogDbResponse)
JSONObject serviceResourcesRoot = responseJson.getJSONObject("serviceResources")
JSONObject modelInfo = buildModelInfo("", serviceResourcesRoot, catalogUtilsVersion)
serviceResources.put("modelInfo", modelInfo)
JSONArray vnfsArray = parseVnfsJson(serviceResourcesRoot.toString(), "serviceVnfs", catalogUtilsVersion)
serviceResources.put("serviceVnfs", vnfsArray)
JSONArray networksArray = parseNetworksJson(serviceResourcesRoot.toString(), "serviceNetworks", catalogUtilsVersion)
serviceResources.put("serviceNetworks", networksArray)
JSONArray allottedResourcesArray = parseAllottedResourcesJson(serviceResourcesRoot.toString(), "serviceAllottedResources", catalogUtilsVersion)
serviceResources.put("serviceAllottedResources", allottedResourcesArray)
serviceResourcesObject.put("serviceResources", serviceResources)
logger.debug("Returning serviceResources JSON: " + serviceResourcesObject.toString())
} catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception in parsing Catalog DB Response", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
}
return serviceResourcesObject
}
private JSONObject buildModelInfo(String modelType, JSONObject modelFromDb, String catalogUtilsVersion) {
JSONObject modelInfo = null
try {
modelInfo = new JSONObject()
modelInfo.put("modelType", modelType)
String modelInvariantId = jsonUtils.getJsonValueForKey(modelFromDb, "modelInvariantUuid")
modelInfo.put("modelInvariantId", modelInvariantId)
if(modelType.equalsIgnoreCase("allottedResource") || modelType.equalsIgnoreCase("vnf")){
String modelInstanceName = jsonUtils.getJsonValueForKey(modelFromDb, "modelInstanceName")
modelInfo.put("modelInstanceName", modelInstanceName)
}
if ((!"vfModule".equals(modelType) && !"vnf".equals(modelType)) || !catalogUtilsVersion.equals("v1")) {
String modelVersionId = jsonUtils.getJsonValueForKey(modelFromDb, "modelUuid")
modelInfo.put("modelVersionId", modelVersionId)
}
else {
String modelVersionId = jsonUtils.getJsonValueForKey(modelFromDb, "asdcUuid")
modelInfo.put("modelVersionId", modelVersionId)
}
String modelName = jsonUtils.getJsonValueForKey(modelFromDb, "modelName")
modelInfo.put("modelName", modelName)
String modelVersion = jsonUtils.getJsonValueForKey(modelFromDb, "modelVersion")
modelInfo.put("modelVersion", modelVersion)
if (!"vfModule".equals(modelType)) {
String modelCustomizationName = jsonUtils.getJsonValueForKey(modelFromDb, "modelCustomizationName")
modelInfo.put("modelCustomizationName", modelCustomizationName)
}
String modelCustomizationId = jsonUtils.getJsonValueForKey(modelFromDb, "modelCustomizationUuid")
switch (catalogUtilsVersion) {
case "v1":
modelInfo.put("modelCustomizationId", modelCustomizationId)
break
default:
modelInfo.put("modelCustomizationUuid", modelCustomizationId)
break
}
JSONObject modelJson = new JSONObject()
modelJson.put("modelInfo", modelInfo)
}
catch (Exception e) {
logger.error(Strings.repeat("{} ", 5), MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
"Exception while parsing model information", "BPMN",
ErrorCode.UnknownError.getValue(), e.message);
}
return modelInfo
}
private String getResponseFromCatalogDb (DelegateExecution execution, String endPoint) {
try {
String catalogDbEndpoint = UrnPropertiesReader.getVariable("mso.catalog.db.endpoint",execution)
String queryEndpoint = catalogDbEndpoint + "/" + defaultDbAdapterVersion + endPoint
def responseData = ''
HttpClient client = httpClientFactory.newJsonClient(new URL(queryEndpoint), TargetEntity.CATALOG_DB)
client.addAdditionalHeader(ONAPLogConstants.Headers.REQUEST_ID, UUID.randomUUID().toString())
client.addAdditionalHeader('X-FromAppId', "BPMN")
client.addAdditionalHeader('Accept', MediaType.APPLICATION_JSON)
String basicAuthCred = execution.getVariable("BasicAuthHeaderValueDB")
client.addAdditionalHeader("Authorization", StringUtils.defaultIfEmpty(basicAuthCred, getBasicDBAuthHeader(execution)))
logger.debug('sending GET to Catalog DB endpoint: ' + endPoint)
Response response = client.get()
responseData = response.readEntity(String.class)
if (responseData != null) {
logger.debug("Received data from Catalog DB: " + responseData)
}
logger.debug('Response code:' + response.getStatus())
logger.debug('Response:' + System.lineSeparator() + responseData)
if (response.getStatus() == 200) {
// parse response as needed
return responseData
}
else {
return null
}
}
catch (Exception e) {
logger.debug("ERROR WHILE QUERYING CATALOG DB: " + e.message)
throw e
}
}
/**
* get resource recipe by resource model uuid and action
*/
public JSONObject getResourceRecipe(DelegateExecution execution, String resourceModelUuid, String action) {
String endPoint = "/resourceRecipe?resourceModelUuid=" + UriUtils.encode(resourceModelUuid, "UTF-8")+ "&action=" + UriUtils.encode(action, "UTF-8")
JSONObject responseJson = null
try {
logger.debug("ENDPOINT: " + endPoint)
String catalogDbResponse = getResponseFromCatalogDb(execution, endPoint)
if (catalogDbResponse != null) {
responseJson = new JSONObject(catalogDbResponse)
}
}
catch (Exception e) {
logger.error("Exception in Querying Catalog DB: " + e.message)
throw e
}
return responseJson
}
private String getBasicDBAuthHeader(DelegateExecution execution) {
String encodedString = null
try {
String basicAuthValueDB = UrnPropertiesReader.getVariable("mso.adapters.db.auth", execution)
logger.debug("DEBUG", " Obtained BasicAuth userid password for Catalog DB adapter: " + basicAuthValueDB)
encodedString = utils.getBasicAuth(basicAuthValueDB, UrnPropertiesReader.getVariable("mso.msoKey", execution))
execution.setVariable("BasicAuthHeaderValueDB",encodedString)
} catch (IOException ex) {
String dataErrorMessage = " Unable to encode Catalog DB user/password string - " + ex.getMessage()
logger.error(dataErrorMessage)
}
return encodedString
}
}
|