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
|
/*-
* ============LICENSE_START=======================================================
* ONAP Policy API
* ================================================================================
* Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
* Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2020-2023 Nordix Foundation.
* Modifications Copyright (C) 2020-2023 Bell Canada. 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.api.main.rest;
import jakarta.ws.rs.core.Response.Status;
import java.util.List;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.onap.policy.api.main.exception.PolicyApiRuntimeException;
import org.onap.policy.api.main.rest.genapi.PolicyDesignApi;
import org.onap.policy.api.main.rest.provider.healthcheck.HealthCheckProvider;
import org.onap.policy.api.main.service.ToscaServiceTemplateService;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.report.HealthCheckReport;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.base.PfModelRuntimeException;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
import org.springframework.context.annotation.Profile;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST API services.
*
* @author Chenfei Gao (cgao@research.att.com)
*/
@RestController
@RequiredArgsConstructor
@Profile("default")
public class ApiRestController extends CommonRestController implements PolicyDesignApi {
private final ToscaServiceTemplateService toscaServiceTemplateService;
private final HealthCheckProvider healthCheckProvider;
/**
* Retrieves the healthcheck status of the API component.
*
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<HealthCheckReport> getHealthCheck(UUID requestId) {
final var report = healthCheckProvider.performHealthCheck();
return makeResponse(requestId, report, report.getCode());
}
/**
* Retrieves all available policy types.
*
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getAllPolicyTypes(UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(null, null);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
final var msg = "GET /policytypes";
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves all versions of a particular policy type.
*
* @param policyTypeId the ID of specified policy type
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicyType(
String policyTypeId,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, null);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policytypes/%s", policyTypeId);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves specified version of a particular policy type.
*
* @param policyTypeId the ID of specified policy type
* @param versionId the version of specified policy type
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicyType(
String policyTypeId,
String versionId,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, versionId);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policytypes/%s/versions/%s", policyTypeId, versionId);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves latest version of a particular policy type.
*
* @param policyTypeId the ID of specified policy type
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicyType(
String policyTypeId,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchLatestPolicyTypes(policyTypeId);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policytypes/%s/versions/latest", policyTypeId);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Creates a new policy type.
*
* @param body the body of policy type following TOSCA definition
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> createPolicyType(
ToscaServiceTemplate body,
UUID requestId) {
if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policytypes", toJson(body));
}
try {
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.createPolicyType(body);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelRuntimeException pfme) {
final var msg = "POST /policytypes";
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Deletes specified version of a particular policy type.
*
* @param policyTypeId the ID of specified policy type
* @param versionId the version of specified policy type
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicyType(
String policyTypeId,
String versionId,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.deletePolicyType(policyTypeId, versionId);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelRuntimeException pfme) {
var msg = String.format("DELETE /policytypes/%s/versions/%s", policyTypeId, versionId);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves all versions of a particular policy.
*
* @param policyTypeId the ID of specified policy type
* @param policyTypeVersion the version of specified policy type
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getAllPolicies(
String policyTypeId,
String policyTypeVersion,
PolicyFetchMode mode,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, null, null, mode);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves all versions of a particular policy.
*
* @param policyTypeId the ID of specified policy type
* @param policyTypeVersion the version of specified policy type
* @param policyId the ID of specified policy
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicy(
String policyId,
String policyTypeId,
String policyTypeVersion,
PolicyFetchMode mode,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, policyId, null, mode);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("/policytypes/%s/versions/%s/policies/%s",
policyTypeId, policyTypeVersion, policyId);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves the specified version of a particular policy.
*
* @param policyTypeId the ID of specified policy type
* @param policyTypeVersion the version of specified policy type
* @param policyId the ID of specified policy
* @param policyVersion the version of specified policy
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicy(
String policyId,
String policyTypeId,
String policyTypeVersion,
String policyVersion,
PolicyFetchMode mode,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService
.fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion, mode);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/%s",
policyTypeId, policyTypeVersion, policyId, policyVersion);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves the latest version of a particular policy.
*
* @param policyTypeId the ID of specified policy type
* @param policyTypeVersion the version of specified policy type
* @param policyId the ID of specified policy
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicy(
String policyId,
String policyTypeId,
String policyTypeVersion,
PolicyFetchMode mode,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId, mode);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/latest",
policyTypeId, policyTypeVersion, policyId);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Creates a new policy for a particular policy type and version.
*
* @param policyTypeId the ID of specified policy type
* @param policyTypeVersion the version of specified policy type
* @param body the body of policy following TOSCA definition
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> createPolicy(
String policyTypeId,
String policyTypeVersion,
ToscaServiceTemplate body,
UUID requestId) {
if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST,
"/policytypes/" + policyTypeId + "/versions/" + policyTypeVersion + "/policies", toJson(body));
}
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.createPolicy(policyTypeId, policyTypeVersion, body);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelRuntimeException pfme) {
var msg = String.format("POST /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Deletes the specified version of a particular policy.
*
* @param policyTypeId the ID of specified policy type
* @param policyTypeVersion the version of specified policy type
* @param policyId the ID of specified policy
* @param policyVersion the version of specified policy
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicy(
String policyTypeId,
String policyTypeVersion,
String policyId,
String policyVersion,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelRuntimeException pfme) {
var msg = String.format("DELETE /policytypes/%s/versions/%s/policies/%s/versions/%s",
policyTypeId, policyTypeVersion, policyId, policyVersion);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves all the available policies.
*
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getPolicies(
PolicyFetchMode mode,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.fetchPolicies(null, null, null, null, mode);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
final var msg = "GET /policies/ --";
if (pfme.getErrorResponse().getResponseCode().equals(Status.NOT_FOUND)) {
pfme.getErrorResponse().setErrorMessage(ERROR_MESSAGE_NO_POLICIES_FOUND);
pfme.getErrorResponse().setErrorDetails(List.of(ERROR_MESSAGE_NO_POLICIES_FOUND));
}
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Retrieves the specified version of a particular policy.
*
* @param policyId the Name of specified policy
* @param policyVersion the version of specified policy
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> getSpecificPolicy(
String policyId,
String policyVersion,
PolicyFetchMode mode,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.fetchPolicies(null, null, policyId, policyVersion, mode);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelException | PfModelRuntimeException pfme) {
var msg = String.format("GET /policies/%s/versions/%s", policyId, policyVersion);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Creates one or more new policies in one call.
*
* @param body the body of policy following TOSCA definition
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> createPolicies(
ToscaServiceTemplate body,
UUID requestId) {
if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policies", toJson(body));
}
try {
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.createPolicies(body);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelRuntimeException pfme) {
final var msg = "POST /policies";
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
/**
* Deletes the specified version of a particular policy.
*
* @param policyId the ID of specified policy
* @param policyVersion the version of specified policy
* @return the Response object containing the results of the API operation
*/
@Override
public ResponseEntity<ToscaServiceTemplate> deleteSpecificPolicy(
String policyId,
String policyVersion,
UUID requestId) {
try {
ToscaServiceTemplate serviceTemplate =
toscaServiceTemplateService.deletePolicy(null, null, policyId, policyVersion);
return makeOkResponse(requestId, serviceTemplate);
} catch (PfModelRuntimeException pfme) {
var msg = String.format("DELETE /policies/%s/versions/%s", policyId, policyVersion);
throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
}
}
}
|
