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
|
/*-
* ============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.adapters.catalogdb;
/*
Create an initial query to retrieve a VNF Resource definition (including a list of possible module types)
within the context of a given service. Input is a vnf resource model customization ID (new field for 1702),
or a composite key (from 1610) of service name, service version, vnf instance name
Returns a structure (JSON?) containing VNF RESOURCE attributes, plus a list of VF Module structures.
Query a NETWORK_RESOURCE from the MSO Catalog, based on a networkModelCustomizationUUID (new for 1702),
a network type (unique type identifier in 1610), or based on network role within a service.
Create Adapter framework for access to Catalog DB, including connection management,
login/password access, transaction logic, etc. This can be modeled after the Request DB Adapter
Update the MSO Catalog DB schema to include the new fields defined in this user story.
Note that the resourceModelCustomizationUUID (or vfModuleModelCustomizationUUID) will be unique keys (indexes)
on the VNF_RESOURCE and VF_MODULE tables respectively.
The previously constructed "vnf-type" and "vf-module-type" field may continue to be populated,
but should no longer be needed and can deprecate in future release.
For migration, a new randomly generated UUID field may be generated for the *ModelCustomizationUUID" fields
until such time that the model is redistributed from ASDC.
All other fields Check with Mike Z for appropriate value for the vfModuleLabel.
We might be able to derive it's value from the current vnf-type (using the "middle" piece that identifies the module type).
min and initial counts can be 0. max can be null to indicate no maximum.
Once the network-level distribution artifacts are defined, similar updates can be made to the NETWORK_RESOURCE table.
*/
import java.util.Map;
import java.util.List;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HEAD;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.GenericEntity;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.xml.ws.Holder;
import org.apache.http.HttpStatus;
import org.openecomp.mso.logger.MessageEnum;
import org.openecomp.mso.logger.MsoLogger;
import org.openecomp.mso.adapters.catalogdb.catalogrest.CatalogQueryException;
import org.openecomp.mso.adapters.catalogdb.catalogrest.CatalogQueryExceptionCategory;
import org.openecomp.mso.adapters.catalogdb.catalogrest.CatalogQuery;
import org.openecomp.mso.adapters.catalogdb.catalogrest.QueryServiceVnfs;
import org.openecomp.mso.adapters.catalogdb.catalogrest.QueryServiceNetworks;
import org.openecomp.mso.adapters.catalogdb.catalogrest.QueryServiceMacroHolder;
import org.openecomp.mso.adapters.catalogdb.catalogrest.QueryAllottedResourceCustomization;
import org.openecomp.mso.db.catalog.CatalogDatabase;
import org.openecomp.mso.db.catalog.beans.VnfResource;
import org.openecomp.mso.db.catalog.beans.NetworkResourceCustomization;
import org.openecomp.mso.db.catalog.beans.ServiceMacroHolder;
import org.openecomp.mso.db.catalog.beans.AllottedResourceCustomization;
/**
* This class services calls to the REST interface for VF Modules (http://host:port/ecomp/mso/catalog/v1)
* Both XML and JSON can be produced/consumed. Set Accept: and Content-Type: headers appropriately. XML is the default.
* Requests respond synchronously only
*/
@Path("/{version: v[0-9]+}")
public class CatalogDbAdapterRest {
private static MsoLogger LOGGER = MsoLogger.getMsoLogger (MsoLogger.Catalog.RA);
private static final boolean IS_ARRAY = true;
public Response respond(String version, int respStatus, boolean isArray, CatalogQuery qryResp) {
return Response
.status(respStatus)
//.entity(new GenericEntity<QueryServiceVnfs>(qryResp) {})
.entity(qryResp.toJsonString(version, isArray))
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)
.build();
}
@HEAD
@GET
@Path("healthcheck")
@Produces(MediaType.TEXT_HTML)
public Response healthcheck (
@PathParam("version") String version
) {
String CHECK_HTML = "<!DOCTYPE html><html><head><meta charset=\"ISO-8859-1\"><title>Health Check</title></head><body>Application "+ version+ " ready</body></html>";
return Response.ok().entity(CHECK_HTML).build();
}
/*
* GET {http-catalog-adapter-root}/v1/serviceVnfs?vnfModelCustomizationUuid=<vnf-model-customization-uuid>
* URL:http://localhost:8080/ecomp/mso/catalog/v1/getVfModuleType?vnfType=Test/vSAMP10&vfModuleType=vSAMP10::base::module-0
* RESP:
* {"queryVfModule":{"version":1,"asdcUuid":"MANUAL RECORD","created":{"nanos":0},"description":"vSAMP10","environmentId":15184,"id":2312,"isBase":1,"modelName":"vSAMP10::base::module-0","modelVersion":1,"templateId":15123,"type":"Test\/vSAMP10::vSAMP10::base::module-0","vnfResourceId":15187}}
*/
@GET
@Path("vnfs/{vnfModelCustomizationUuid}")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceVnfs (
@PathParam("version") String version,
@PathParam("vnfModelCustomizationUuid") String vnfUuid
) {
return serviceVnfsImpl (version, !IS_ARRAY, vnfUuid, null, null, null, null);
}
@GET
@Path("serviceVnfs")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceVnfs(
@PathParam("version") String version,
@QueryParam("vnfModelCustomizationUuid") String vnfUuid,
@QueryParam("serviceModelUuid") String smUuid,
@QueryParam("serviceModelInvariantUuid") String smiUuid,
@QueryParam("serviceModelVersion") String smVer,
@QueryParam("serviceModelName") String smName
) {
return serviceVnfsImpl (version, IS_ARRAY, vnfUuid, smUuid, smiUuid, smVer, smName);
}
public Response serviceVnfsImpl(String version, boolean isArray, String vnfUuid, String smUuid, String smiUuid, String smVer, String smName) {
QueryServiceVnfs qryResp;
int respStatus = HttpStatus.SC_OK;
String uuid = "";
List<VnfResource> ret;
try (CatalogDatabase db = new CatalogDatabase()) {
if (vnfUuid != null && !vnfUuid.equals("")) {
uuid = vnfUuid;
LOGGER.debug ("Query serviceVnfs getAllVnfsByVnfModelCustomizationUuid vnfModelCustomizationUuid: " + uuid);
ret = db.getAllVnfsByVnfModelCustomizationUuid(uuid);
}
else if (smUuid != null && !smUuid.equals("")) {
uuid = smUuid;
LOGGER.debug ("Query serviceVnfs getAllVnfsByServiceModelUuid serviceModelUuid: " + uuid);
ret = db.getAllVnfsByServiceModelUuid(uuid);
}
else if (smiUuid != null && !smiUuid.equals("")) {
uuid = smiUuid;
if (smVer != null && !smVer.equals("")) {
LOGGER.debug ("Query serviceVnfs getAllNetworksByServiceModelInvariantUuid serviceModelInvariantUuid: " + uuid+ " serviceModelVersion: "+ smVer);
ret = db.getAllVnfsByServiceModelInvariantUuid(uuid, smVer);
}
else {
LOGGER.debug ("Query serviceVnfs getAllNetworksByServiceModelInvariantUuid serviceModelUuid: " + uuid);
ret = db.getAllVnfsByServiceModelInvariantUuid(uuid);
}
}
else if (smName != null && !smName.equals("")) {
if (smVer != null && !smVer.equals("")) {
LOGGER.debug ("Query serviceVnfs getAllVnfsByServiceName serviceModelInvariantName: " + smName+ " serviceModelVersion: "+ smVer);
ret = db.getAllVnfsByServiceName(smName, smVer);
}
else {
LOGGER.debug ("Query serviceVnfs getAllVnfsByServiceName serviceModelName: " + smName);
ret = db.getAllVnfsByServiceName(smName);
}
}
else if (smName != null && !smName.equals("")) {
if (smVer != null && !smVer.equals("")) {
LOGGER.debug ("Query serviceVnfs getAllVnfsByServiceName serviceModelInvariantName: " + smName+ " serviceModelVersion: "+ smVer);
ret = db.getAllVnfsByServiceName(smName, smVer);
}
else {
LOGGER.debug ("Query serviceVnfs getAllVnfsByServiceName serviceModelName: " + smName);
ret = db.getAllVnfsByServiceName(smName);
}
}
else {
throw(new Exception("no matching parameters"));
}
if (ret == null || ret.isEmpty()) {
LOGGER.debug ("serviceVnfs not found");
respStatus = HttpStatus.SC_NOT_FOUND;
qryResp = new QueryServiceVnfs();
} else {
LOGGER.debug ("serviceVnfs found");
qryResp = new QueryServiceVnfs(ret);
LOGGER.debug ("serviceVnfs qryResp="+ qryResp);
}
LOGGER.debug ("Query serviceVnfs exit");
return respond(version, respStatus, isArray, qryResp);
} catch (Exception e) {
LOGGER.error (MessageEnum.RA_QUERY_VNF_ERR, uuid, "", "queryServiceVnfs", MsoLogger.ErrorCode.BusinessProcesssError, "Exception - queryServiceVnfs", e);
CatalogQueryException excResp = new CatalogQueryException(e.getMessage(), CatalogQueryExceptionCategory.INTERNAL, Boolean.FALSE, null);
return Response
.status(HttpStatus.SC_INTERNAL_SERVER_ERROR)
.entity(new GenericEntity<CatalogQueryException>(excResp) {})
.build();
}
}
@GET
@Path("networks/{networkModelCustomizationUuid}")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceNetworks (
@PathParam("version") String version,
@PathParam("networkModelCustomizationUuid") String nUuid
) {
return serviceNetworksImpl (version, !IS_ARRAY, nUuid, null, null, null, null);
}
@GET
@Path("serviceNetworks")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceNetworks (
@PathParam("version") String version,
@QueryParam("networkModelCustomizationUuid") String nUuid,
@QueryParam("networkType") String nType,
@QueryParam("serviceModelUuid") String smUuid,
@QueryParam("serviceModelInvariantUuid") String smiUuid,
@QueryParam("serviceModelVersion") String smVer
) {
return serviceNetworksImpl (version, IS_ARRAY, nUuid, nType, smUuid, smiUuid, smVer);
}
public Response serviceNetworksImpl (String version, boolean isArray, String nUuid, String nType, String smUuid, String smiUuid, String smVer) {
QueryServiceNetworks qryResp;
int respStatus = HttpStatus.SC_OK;
String uuid = "";
List<NetworkResourceCustomization> ret;
try (CatalogDatabase db = new CatalogDatabase()) {
if (nUuid != null && !nUuid.equals("")) {
uuid = nUuid;
LOGGER.debug ("Query serviceNetworks getAllNetworksByNetworkModelCustomizationUuid networkModelCustomizationUuid: " + uuid);
ret = db.getAllNetworksByNetworkModelCustomizationUuid(uuid);
}
else if (smUuid != null && !smUuid.equals("")) {
uuid = smUuid;
LOGGER.debug ("Query serviceNetworks getAllNetworksByServiceModelUuid serviceModelUuid: " + uuid);
ret = db.getAllNetworksByServiceModelUuid(uuid);
}
else if (nType != null && !nType.equals("")) {
uuid = nType;
LOGGER.debug ("Query serviceNetworks getAllNetworksByNetworkType serviceModelUuid: " + uuid);
ret = db.getAllNetworksByNetworkType(uuid);
}
else if (smiUuid != null && !smiUuid.equals("")) {
uuid = smiUuid;
if (smVer != null && !smVer.equals("")) {
LOGGER.debug ("Query serviceNetworks getAllNetworksByServiceModelInvariantUuid serviceModelInvariantUuid: " + uuid+ " serviceModelVersion: "+ smVer);
ret = db.getAllNetworksByServiceModelInvariantUuid(uuid, smVer);
}
else {
LOGGER.debug ("Query serviceNetworks getAllNetworksByServiceModelInvariantUuid serviceModelUuid: " + uuid);
ret = db.getAllNetworksByServiceModelInvariantUuid(uuid);
}
}
else {
throw(new Exception("no matching parameters"));
}
if (ret == null || ret.isEmpty()) {
LOGGER.debug ("serviceNetworks not found");
respStatus = HttpStatus.SC_NOT_FOUND;
qryResp = new QueryServiceNetworks();
} else {
LOGGER.debug ("serviceNetworks found");
qryResp = new QueryServiceNetworks(ret);
LOGGER.debug ("serviceNetworks qryResp="+ qryResp);
}
LOGGER.debug ("Query serviceNetworks exit");
return respond(version, respStatus, isArray, qryResp);
} catch (Exception e) {
LOGGER.error (MessageEnum.RA_QUERY_VNF_ERR, uuid, "", "queryServiceNetworks", MsoLogger.ErrorCode.BusinessProcesssError, "Exception - queryServiceNetworks", e);
CatalogQueryException excResp = new CatalogQueryException(e.getMessage(), CatalogQueryExceptionCategory.INTERNAL, Boolean.FALSE, null);
return Response
.status(HttpStatus.SC_INTERNAL_SERVER_ERROR)
.entity(new GenericEntity<CatalogQueryException>(excResp) {})
.build();
}
}
@GET
@Path("serviceResources")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceResources(
@PathParam("version") String version,
@QueryParam("serviceModelUuid") String smUuid,
@QueryParam("serviceModelInvariantUuid") String smiUuid,
@QueryParam("serviceModelVersion") String smVer) {
QueryServiceMacroHolder qryResp;
int respStatus = HttpStatus.SC_OK;
String uuid = "";
ServiceMacroHolder ret;
try (CatalogDatabase db = new CatalogDatabase()) {
if (smUuid != null && !smUuid.equals("")) {
uuid = smUuid;
LOGGER.debug ("Query serviceMacroHolder getAllResourcesByServiceModelUuid serviceModelUuid: " + uuid);
ret = db.getAllResourcesByServiceModelUuid(uuid);
}
else if (smiUuid != null && !smiUuid.equals("")) {
uuid = smiUuid;
if (smVer != null && !smVer.equals("")) {
LOGGER.debug ("Query serviceMacroHolder getAllResourcesByServiceModelInvariantUuid serviceModelInvariantUuid: " + uuid+ " serviceModelVersion: "+ smVer);
ret = db.getAllResourcesByServiceModelInvariantUuid(uuid, smVer);
}
else {
LOGGER.debug ("Query serviceMacroHolder getAllResourcesByServiceModelInvariantUuid serviceModelUuid: " + uuid);
ret = db.getAllResourcesByServiceModelInvariantUuid(uuid);
}
}
else {
throw(new Exception("no matching parameters"));
}
if (ret == null) {
LOGGER.debug ("serviceMacroHolder not found");
respStatus = HttpStatus.SC_NOT_FOUND;
qryResp = new QueryServiceMacroHolder();
} else {
LOGGER.debug ("serviceMacroHolder found");
qryResp = new QueryServiceMacroHolder(ret);
LOGGER.debug ("serviceMacroHolder qryResp="+ qryResp);
}
LOGGER.debug ("Query serviceMacroHolder exit");
return respond(version, respStatus, IS_ARRAY, qryResp);
} catch (Exception e) {
LOGGER.error (MessageEnum.RA_QUERY_VNF_ERR, uuid, "", "queryServiceMacroHolder", MsoLogger.ErrorCode.BusinessProcesssError, "Exception - queryServiceMacroHolder", e);
CatalogQueryException excResp = new CatalogQueryException(e.getMessage(), CatalogQueryExceptionCategory.INTERNAL, Boolean.FALSE, null);
return Response
.status(HttpStatus.SC_INTERNAL_SERVER_ERROR)
.entity(new GenericEntity<CatalogQueryException>(excResp) {})
.build();
}
}
@GET
@Path("allottedResources/{arModelCustomizationUuid}")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceAllottedResources (
@PathParam("version") String version,
@PathParam("arModelCustomizationUuid") String aUuid
) {
return serviceAllottedResourcesImpl(version, !IS_ARRAY, aUuid, null, null, null);
}
@GET
@Path("serviceAllottedResources")
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response serviceAllottedResources(
@PathParam("version") String version,
@QueryParam("serviceModelUuid") String smUuid,
@QueryParam("serviceModelInvariantUuid") String smiUuid,
@QueryParam("serviceModelVersion") String smVer,
@QueryParam("arModelCustomizationUuid") String aUuid
) {
return serviceAllottedResourcesImpl(version, IS_ARRAY, aUuid, smUuid, smiUuid, smVer);
}
public Response serviceAllottedResourcesImpl(String version, boolean isArray, String aUuid, String smUuid, String smiUuid, String smVer) {
QueryAllottedResourceCustomization qryResp;
int respStatus = HttpStatus.SC_OK;
String uuid = "";
List<AllottedResourceCustomization > ret;
try (CatalogDatabase db = new CatalogDatabase()) {
if (smUuid != null && !smUuid.equals("")) {
uuid = smUuid;
LOGGER.debug ("Query AllottedResourceCustomization getAllAllottedResourcesByServiceModelUuid serviceModelUuid: " + uuid);
ret = db.getAllAllottedResourcesByServiceModelUuid(uuid);
}
else if (smiUuid != null && !smiUuid.equals("")) {
uuid = smiUuid;
if (smVer != null && !smVer.equals("")) {
LOGGER.debug ("Query AllottedResourceCustomization getAllAllottedResourcesByServiceModelInvariantUuid serviceModelInvariantUuid: " + uuid+ " serviceModelVersion: "+ smVer);
ret = db.getAllAllottedResourcesByServiceModelInvariantUuid(uuid, smVer);
}
else {
LOGGER.debug ("Query AllottedResourceCustomization getAllAllottedResourcesByServiceModelInvariantUuid serviceModelUuid: " + uuid);
ret = db.getAllAllottedResourcesByServiceModelInvariantUuid(uuid);
}
}
else if (aUuid != null && !aUuid.equals("")) {
uuid = aUuid;
LOGGER.debug ("Query AllottedResourceCustomization getAllAllottedResourcesByArModelCustomizationUuid serviceModelUuid: " + uuid);
ret = db.getAllAllottedResourcesByArModelCustomizationUuid(uuid);
}
else {
throw(new Exception("no matching parameters"));
}
if (ret == null || ret.isEmpty()) {
LOGGER.debug ("AllottedResourceCustomization not found");
respStatus = HttpStatus.SC_NOT_FOUND;
qryResp = new QueryAllottedResourceCustomization();
} else {
LOGGER.debug ("AllottedResourceCustomization found");
qryResp = new QueryAllottedResourceCustomization(ret);
LOGGER.debug ("AllottedResourceCustomization qryResp="+ qryResp);
}
LOGGER.debug ("Query AllottedResourceCustomization exit");
return respond(version, respStatus, isArray, qryResp);
} catch (Exception e) {
LOGGER.error (MessageEnum.RA_QUERY_VNF_ERR, uuid, "", "queryAllottedResourceCustomization", MsoLogger.ErrorCode.BusinessProcesssError, "Exception - queryAllottedResourceCustomization", e);
CatalogQueryException excResp = new CatalogQueryException(e.getMessage(), CatalogQueryExceptionCategory.INTERNAL, Boolean.FALSE, null);
return Response
.status(HttpStatus.SC_INTERNAL_SERVER_ERROR)
.entity(new GenericEntity<CatalogQueryException>(excResp) {})
.build();
}
}
}
|