2 * ============LICENSE_START=======================================================
\r
4 * ================================================================================
\r
5 * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
\r
6 * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
\r
7 * Modifications Copyright (C) 2020-2023 Nordix Foundation.
\r
8 * Modifications Copyright (C) 2020-2023 Bell Canada. All rights reserved.
\r
9 * ================================================================================
\r
10 * Licensed under the Apache License, Version 2.0 (the "License");
\r
11 * you may not use this file except in compliance with the License.
\r
12 * You may obtain a copy of the License at
\r
14 * http://www.apache.org/licenses/LICENSE-2.0
\r
16 * Unless required by applicable law or agreed to in writing, software
\r
17 * distributed under the License is distributed on an "AS IS" BASIS,
\r
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
19 * See the License for the specific language governing permissions and
\r
20 * limitations under the License.
\r
22 * SPDX-License-Identifier: Apache-2.0
\r
23 * ============LICENSE_END=========================================================
\r
26 package org.onap.policy.api.main.rest;
\r
28 import jakarta.ws.rs.core.Response.Status;
\r
29 import java.util.List;
\r
30 import java.util.UUID;
\r
31 import lombok.RequiredArgsConstructor;
\r
32 import org.onap.policy.api.main.exception.PolicyApiRuntimeException;
\r
33 import org.onap.policy.api.main.rest.genapi.PolicyDesignApi;
\r
34 import org.onap.policy.api.main.rest.provider.healthcheck.HealthCheckProvider;
\r
35 import org.onap.policy.api.main.service.ToscaServiceTemplateService;
\r
36 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
\r
37 import org.onap.policy.common.endpoints.report.HealthCheckReport;
\r
38 import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
\r
39 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
\r
40 import org.onap.policy.models.base.PfModelException;
\r
41 import org.onap.policy.models.base.PfModelRuntimeException;
\r
42 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
\r
43 import org.springframework.context.annotation.Profile;
\r
44 import org.springframework.http.ResponseEntity;
\r
45 import org.springframework.web.bind.annotation.RestController;
\r
48 * Class to provide REST API services.
\r
50 * @author Chenfei Gao (cgao@research.att.com)
\r
53 @RequiredArgsConstructor
\r
55 public class ApiRestController extends CommonRestController implements PolicyDesignApi {
\r
57 private final ToscaServiceTemplateService toscaServiceTemplateService;
\r
58 private final HealthCheckProvider healthCheckProvider;
\r
61 * Retrieves the healthcheck status of the API component.
\r
63 * @return the Response object containing the results of the API operation
\r
66 public ResponseEntity<HealthCheckReport> getHealthCheck(UUID requestId) {
\r
67 final var report = healthCheckProvider.performHealthCheck();
\r
68 return makeResponse(requestId, report, report.getCode());
\r
72 * Retrieves all available policy types.
\r
74 * @return the Response object containing the results of the API operation
\r
77 public ResponseEntity<ToscaServiceTemplate> getAllPolicyTypes(UUID requestId) {
\r
79 ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(null, null);
\r
80 return makeOkResponse(requestId, serviceTemplate);
\r
81 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
82 final var msg = "GET /policytypes";
\r
83 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
88 * Retrieves all versions of a particular policy type.
\r
90 * @param policyTypeId the ID of specified policy type
\r
91 * @return the Response object containing the results of the API operation
\r
94 public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicyType(
\r
95 String policyTypeId,
\r
98 ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, null);
\r
99 return makeOkResponse(requestId, serviceTemplate);
\r
100 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
101 var msg = String.format("GET /policytypes/%s", policyTypeId);
\r
102 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
107 * Retrieves specified version of a particular policy type.
\r
109 * @param policyTypeId the ID of specified policy type
\r
110 * @param versionId the version of specified policy type
\r
111 * @return the Response object containing the results of the API operation
\r
114 public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicyType(
\r
115 String policyTypeId,
\r
119 ToscaServiceTemplate serviceTemplate =
\r
120 toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, versionId);
\r
121 return makeOkResponse(requestId, serviceTemplate);
\r
122 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
123 var msg = String.format("GET /policytypes/%s/versions/%s", policyTypeId, versionId);
\r
124 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
129 * Retrieves latest version of a particular policy type.
\r
131 * @param policyTypeId the ID of specified policy type
\r
132 * @return the Response object containing the results of the API operation
\r
135 public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicyType(
\r
136 String policyTypeId,
\r
139 ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchLatestPolicyTypes(policyTypeId);
\r
140 return makeOkResponse(requestId, serviceTemplate);
\r
141 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
142 var msg = String.format("GET /policytypes/%s/versions/latest", policyTypeId);
\r
143 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
148 * Creates a new policy type.
\r
150 * @param body the body of policy type following TOSCA definition
\r
151 * @return the Response object containing the results of the API operation
\r
154 public ResponseEntity<ToscaServiceTemplate> createPolicyType(
\r
155 ToscaServiceTemplate body,
\r
157 if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
\r
158 NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policytypes", toJson(body));
\r
161 ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.createPolicyType(body);
\r
162 return makeOkResponse(requestId, serviceTemplate);
\r
163 } catch (PfModelRuntimeException pfme) {
\r
164 final var msg = "POST /policytypes";
\r
165 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
170 * Deletes specified version of a particular policy type.
\r
172 * @param policyTypeId the ID of specified policy type
\r
173 * @param versionId the version of specified policy type
\r
174 * @return the Response object containing the results of the API operation
\r
177 public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicyType(
\r
178 String policyTypeId,
\r
182 ToscaServiceTemplate serviceTemplate =
\r
183 toscaServiceTemplateService.deletePolicyType(policyTypeId, versionId);
\r
184 return makeOkResponse(requestId, serviceTemplate);
\r
185 } catch (PfModelRuntimeException pfme) {
\r
186 var msg = String.format("DELETE /policytypes/%s/versions/%s", policyTypeId, versionId);
\r
187 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
192 * Retrieves all versions of a particular policy.
\r
194 * @param policyTypeId the ID of specified policy type
\r
195 * @param policyTypeVersion the version of specified policy type
\r
196 * @return the Response object containing the results of the API operation
\r
199 public ResponseEntity<ToscaServiceTemplate> getAllPolicies(
\r
200 String policyTypeId,
\r
201 String policyTypeVersion,
\r
202 PolicyFetchMode mode,
\r
205 ToscaServiceTemplate serviceTemplate =
\r
206 toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, null, null, mode);
\r
207 return makeOkResponse(requestId, serviceTemplate);
\r
208 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
209 var msg = String.format("GET /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);
\r
210 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
215 * Retrieves all versions of a particular policy.
\r
217 * @param policyTypeId the ID of specified policy type
\r
218 * @param policyTypeVersion the version of specified policy type
\r
219 * @param policyId the ID of specified policy
\r
220 * @return the Response object containing the results of the API operation
\r
223 public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicy(
\r
225 String policyTypeId,
\r
226 String policyTypeVersion,
\r
227 PolicyFetchMode mode,
\r
230 ToscaServiceTemplate serviceTemplate =
\r
231 toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, policyId, null, mode);
\r
232 return makeOkResponse(requestId, serviceTemplate);
\r
233 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
234 var msg = String.format("/policytypes/%s/versions/%s/policies/%s",
\r
235 policyTypeId, policyTypeVersion, policyId);
\r
236 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
241 * Retrieves the specified version of a particular policy.
\r
243 * @param policyTypeId the ID of specified policy type
\r
244 * @param policyTypeVersion the version of specified policy type
\r
245 * @param policyId the ID of specified policy
\r
246 * @param policyVersion the version of specified policy
\r
247 * @return the Response object containing the results of the API operation
\r
250 public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicy(
\r
252 String policyTypeId,
\r
253 String policyTypeVersion,
\r
254 String policyVersion,
\r
255 PolicyFetchMode mode,
\r
258 ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService
\r
259 .fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion, mode);
\r
260 return makeOkResponse(requestId, serviceTemplate);
\r
261 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
262 var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/%s",
\r
263 policyTypeId, policyTypeVersion, policyId, policyVersion);
\r
264 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
269 * Retrieves the latest version of a particular policy.
\r
271 * @param policyTypeId the ID of specified policy type
\r
272 * @param policyTypeVersion the version of specified policy type
\r
273 * @param policyId the ID of specified policy
\r
274 * @return the Response object containing the results of the API operation
\r
277 public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicy(
\r
279 String policyTypeId,
\r
280 String policyTypeVersion,
\r
281 PolicyFetchMode mode,
\r
284 ToscaServiceTemplate serviceTemplate =
\r
285 toscaServiceTemplateService.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId, mode);
\r
286 return makeOkResponse(requestId, serviceTemplate);
\r
287 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
288 var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/latest",
\r
289 policyTypeId, policyTypeVersion, policyId);
\r
290 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
295 * Creates a new policy for a particular policy type and version.
\r
297 * @param policyTypeId the ID of specified policy type
\r
298 * @param policyTypeVersion the version of specified policy type
\r
299 * @param body the body of policy following TOSCA definition
\r
300 * @return the Response object containing the results of the API operation
\r
303 public ResponseEntity<ToscaServiceTemplate> createPolicy(
\r
304 String policyTypeId,
\r
305 String policyTypeVersion,
\r
306 ToscaServiceTemplate body,
\r
308 if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
\r
309 NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST,
\r
310 "/policytypes/" + policyTypeId + "/versions/" + policyTypeVersion + "/policies", toJson(body));
\r
313 ToscaServiceTemplate serviceTemplate =
\r
314 toscaServiceTemplateService.createPolicy(policyTypeId, policyTypeVersion, body);
\r
315 return makeOkResponse(requestId, serviceTemplate);
\r
316 } catch (PfModelRuntimeException pfme) {
\r
317 var msg = String.format("POST /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);
\r
318 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
323 * Deletes the specified version of a particular policy.
\r
325 * @param policyTypeId the ID of specified policy type
\r
326 * @param policyTypeVersion the version of specified policy type
\r
327 * @param policyId the ID of specified policy
\r
328 * @param policyVersion the version of specified policy
\r
329 * @return the Response object containing the results of the API operation
\r
332 public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicy(
\r
333 String policyTypeId,
\r
334 String policyTypeVersion,
\r
336 String policyVersion,
\r
339 ToscaServiceTemplate serviceTemplate =
\r
340 toscaServiceTemplateService.deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);
\r
341 return makeOkResponse(requestId, serviceTemplate);
\r
342 } catch (PfModelRuntimeException pfme) {
\r
343 var msg = String.format("DELETE /policytypes/%s/versions/%s/policies/%s/versions/%s",
\r
344 policyTypeId, policyTypeVersion, policyId, policyVersion);
\r
345 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
350 * Retrieves all the available policies.
\r
352 * @return the Response object containing the results of the API operation
\r
355 public ResponseEntity<ToscaServiceTemplate> getPolicies(
\r
356 PolicyFetchMode mode,
\r
359 ToscaServiceTemplate serviceTemplate =
\r
360 toscaServiceTemplateService.fetchPolicies(null, null, null, null, mode);
\r
361 return makeOkResponse(requestId, serviceTemplate);
\r
362 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
363 final var msg = "GET /policies/ --";
\r
364 if (pfme.getErrorResponse().getResponseCode().equals(Status.NOT_FOUND)) {
\r
365 pfme.getErrorResponse().setErrorMessage(ERROR_MESSAGE_NO_POLICIES_FOUND);
\r
366 pfme.getErrorResponse().setErrorDetails(List.of(ERROR_MESSAGE_NO_POLICIES_FOUND));
\r
368 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
373 * Retrieves the specified version of a particular policy.
\r
375 * @param policyId the Name of specified policy
\r
376 * @param policyVersion the version of specified policy
\r
377 * @return the Response object containing the results of the API operation
\r
380 public ResponseEntity<ToscaServiceTemplate> getSpecificPolicy(
\r
382 String policyVersion,
\r
383 PolicyFetchMode mode,
\r
386 ToscaServiceTemplate serviceTemplate =
\r
387 toscaServiceTemplateService.fetchPolicies(null, null, policyId, policyVersion, mode);
\r
388 return makeOkResponse(requestId, serviceTemplate);
\r
389 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
390 var msg = String.format("GET /policies/%s/versions/%s", policyId, policyVersion);
\r
391 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
396 * Creates one or more new policies in one call.
\r
398 * @param body the body of policy following TOSCA definition
\r
399 * @return the Response object containing the results of the API operation
\r
402 public ResponseEntity<ToscaServiceTemplate> createPolicies(
\r
403 ToscaServiceTemplate body,
\r
405 if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
\r
406 NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policies", toJson(body));
\r
409 ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.createPolicies(body);
\r
410 return makeOkResponse(requestId, serviceTemplate);
\r
411 } catch (PfModelRuntimeException pfme) {
\r
412 final var msg = "POST /policies";
\r
413 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
418 * Deletes the specified version of a particular policy.
\r
420 * @param policyId the ID of specified policy
\r
421 * @param policyVersion the version of specified policy
\r
422 * @return the Response object containing the results of the API operation
\r
425 public ResponseEntity<ToscaServiceTemplate> deleteSpecificPolicy(
\r
427 String policyVersion,
\r
430 ToscaServiceTemplate serviceTemplate =
\r
431 toscaServiceTemplateService.deletePolicy(null, null, policyId, policyVersion);
\r
432 return makeOkResponse(requestId, serviceTemplate);
\r
433 } catch (PfModelRuntimeException pfme) {
\r
434 var msg = String.format("DELETE /policies/%s/versions/%s", policyId, policyVersion);
\r
435 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r