-/*-
- * ============LICENSE_START=======================================================
- * ONAP Policy API
- * ================================================================================
- * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
- * Copyright (C) 2019 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.api.main.rest;
-
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.Info;
-import io.swagger.annotations.SwaggerDefinition;
-import io.swagger.annotations.Tag;
-import javax.ws.rs.GET;
-import javax.ws.rs.Path;
-import javax.ws.rs.Produces;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import org.onap.policy.common.endpoints.report.HealthCheckReport;
-
-/**
- * Class to provide REST API services.
- */
-@Path("/")
-@Api
-@Produces(MediaType.APPLICATION_JSON)
-@SwaggerDefinition(
- info = @Info(description = "Policy Api Service", version = "v2.0", title = "Policy Api"),
- consumes = { MediaType.APPLICATION_JSON }, produces = { MediaType.APPLICATION_JSON },
- schemes = { SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS },
- tags = { @Tag(name = "policy-api", description = "Policy Api Service Operations") })
-public class ApiRestController {
-
- @GET
- @Path("healthcheck")
- @Produces(MediaType.APPLICATION_JSON)
- @ApiOperation(value = "Perform a system healthcheck",
- notes = "Provides healthy status of the Policy Api component", response = HealthCheckReport.class)
- public Response healthcheck() {
- return Response.status(Response.Status.OK).entity(new HealthCheckProvider().performHealthCheck()).build();
- }
-
- @GET
- @Path("statistics")
- @Produces(MediaType.APPLICATION_JSON)
- @ApiOperation(value = "Fetch current statistics",
- notes = "Provides current statistics of the Policy API component",
- response = StatisticsReport.class)
- public Response statistics() {
- return Response.status(Response.Status.OK).entity(new StatisticsProvider().fetchCurrentStatistics()).build();
- }
-}
+/*-\r
+ * ============LICENSE_START=======================================================\r
+ * ONAP Policy API\r
+ * ================================================================================\r
+ * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.\r
+ * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.\r
+ * Modifications Copyright (C) 2020-2023 Nordix Foundation.\r
+ * Modifications Copyright (C) 2020-2023 Bell Canada. All rights reserved.\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ *\r
+ * SPDX-License-Identifier: Apache-2.0\r
+ * ============LICENSE_END=========================================================\r
+ */\r
+\r
+package org.onap.policy.api.main.rest;\r
+\r
+import jakarta.ws.rs.core.Response.Status;\r
+import java.util.List;\r
+import java.util.UUID;\r
+import lombok.RequiredArgsConstructor;\r
+import org.onap.policy.api.main.exception.PolicyApiRuntimeException;\r
+import org.onap.policy.api.main.rest.genapi.PolicyDesignApi;\r
+import org.onap.policy.api.main.rest.provider.healthcheck.HealthCheckProvider;\r
+import org.onap.policy.api.main.service.ToscaServiceTemplateService;\r
+import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;\r
+import org.onap.policy.common.endpoints.report.HealthCheckReport;\r
+import org.onap.policy.common.endpoints.utils.NetLoggerUtil;\r
+import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;\r
+import org.onap.policy.models.base.PfModelException;\r
+import org.onap.policy.models.base.PfModelRuntimeException;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
+import org.springframework.context.annotation.Profile;\r
+import org.springframework.http.ResponseEntity;\r
+import org.springframework.web.bind.annotation.RestController;\r
+\r
+/**\r
+ * Class to provide REST API services.\r
+ *\r
+ * @author Chenfei Gao (cgao@research.att.com)\r
+ */\r
+@RestController\r
+@RequiredArgsConstructor\r
+@Profile("default")\r
+public class ApiRestController extends CommonRestController implements PolicyDesignApi {\r
+\r
+ private final ToscaServiceTemplateService toscaServiceTemplateService;\r
+ private final HealthCheckProvider healthCheckProvider;\r
+\r
+ /**\r
+ * Retrieves the healthcheck status of the API component.\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<HealthCheckReport> getHealthCheck(UUID requestId) {\r
+ final var report = healthCheckProvider.performHealthCheck();\r
+ return makeResponse(requestId, report, report.getCode());\r
+ }\r
+\r
+ /**\r
+ * Retrieves all available policy types.\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getAllPolicyTypes(UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(null, null);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ final var msg = "GET /policytypes";\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves all versions of a particular policy type.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicyType(\r
+ String policyTypeId,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, null);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policytypes/%s", policyTypeId);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves specified version of a particular policy type.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param versionId the version of specified policy type\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicyType(\r
+ String policyTypeId,\r
+ String versionId,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, versionId);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policytypes/%s/versions/%s", policyTypeId, versionId);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves latest version of a particular policy type.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicyType(\r
+ String policyTypeId,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchLatestPolicyTypes(policyTypeId);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policytypes/%s/versions/latest", policyTypeId);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Creates a new policy type.\r
+ *\r
+ * @param body the body of policy type following TOSCA definition\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> createPolicyType(\r
+ ToscaServiceTemplate body,\r
+ UUID requestId) {\r
+ if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
+ NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policytypes", toJson(body));\r
+ }\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.createPolicyType(body);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelRuntimeException pfme) {\r
+ final var msg = "POST /policytypes";\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Deletes specified version of a particular policy type.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param versionId the version of specified policy type\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicyType(\r
+ String policyTypeId,\r
+ String versionId,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.deletePolicyType(policyTypeId, versionId);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelRuntimeException pfme) {\r
+ var msg = String.format("DELETE /policytypes/%s/versions/%s", policyTypeId, versionId);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves all versions of a particular policy.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param policyTypeVersion the version of specified policy type\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getAllPolicies(\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, null, null, mode);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves all versions of a particular policy.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param policyTypeVersion the version of specified policy type\r
+ * @param policyId the ID of specified policy\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicy(\r
+ String policyId,\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, policyId, null, mode);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("/policytypes/%s/versions/%s/policies/%s",\r
+ policyTypeId, policyTypeVersion, policyId);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves the specified version of a particular policy.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param policyTypeVersion the version of specified policy type\r
+ * @param policyId the ID of specified policy\r
+ * @param policyVersion the version of specified policy\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicy(\r
+ String policyId,\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ String policyVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService\r
+ .fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion, mode);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/%s",\r
+ policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves the latest version of a particular policy.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param policyTypeVersion the version of specified policy type\r
+ * @param policyId the ID of specified policy\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicy(\r
+ String policyId,\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId, mode);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/latest",\r
+ policyTypeId, policyTypeVersion, policyId);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Creates a new policy for a particular policy type and version.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param policyTypeVersion the version of specified policy type\r
+ * @param body the body of policy following TOSCA definition\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> createPolicy(\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ ToscaServiceTemplate body,\r
+ UUID requestId) {\r
+ if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
+ NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST,\r
+ "/policytypes/" + policyTypeId + "/versions/" + policyTypeVersion + "/policies", toJson(body));\r
+ }\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.createPolicy(policyTypeId, policyTypeVersion, body);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelRuntimeException pfme) {\r
+ var msg = String.format("POST /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Deletes the specified version of a particular policy.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ * @param policyTypeVersion the version of specified policy type\r
+ * @param policyId the ID of specified policy\r
+ * @param policyVersion the version of specified policy\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicy(\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ String policyId,\r
+ String policyVersion,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelRuntimeException pfme) {\r
+ var msg = String.format("DELETE /policytypes/%s/versions/%s/policies/%s/versions/%s",\r
+ policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves all the available policies.\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getPolicies(\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.fetchPolicies(null, null, null, null, mode);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ final var msg = "GET /policies/ --";\r
+ if (pfme.getErrorResponse().getResponseCode().equals(Status.NOT_FOUND)) {\r
+ pfme.getErrorResponse().setErrorMessage(ERROR_MESSAGE_NO_POLICIES_FOUND);\r
+ pfme.getErrorResponse().setErrorDetails(List.of(ERROR_MESSAGE_NO_POLICIES_FOUND));\r
+ }\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves the specified version of a particular policy.\r
+ *\r
+ * @param policyId the Name of specified policy\r
+ * @param policyVersion the version of specified policy\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getSpecificPolicy(\r
+ String policyId,\r
+ String policyVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.fetchPolicies(null, null, policyId, policyVersion, mode);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ var msg = String.format("GET /policies/%s/versions/%s", policyId, policyVersion);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Creates one or more new policies in one call.\r
+ *\r
+ * @param body the body of policy following TOSCA definition\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> createPolicies(\r
+ ToscaServiceTemplate body,\r
+ UUID requestId) {\r
+ if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
+ NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policies", toJson(body));\r
+ }\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.createPolicies(body);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelRuntimeException pfme) {\r
+ final var msg = "POST /policies";\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Deletes the specified version of a particular policy.\r
+ *\r
+ * @param policyId the ID of specified policy\r
+ * @param policyVersion the version of specified policy\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> deleteSpecificPolicy(\r
+ String policyId,\r
+ String policyVersion,\r
+ UUID requestId) {\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ toscaServiceTemplateService.deletePolicy(null, null, policyId, policyVersion);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelRuntimeException pfme) {\r
+ var msg = String.format("DELETE /policies/%s/versions/%s", policyId, policyVersion);\r
+ throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);\r
+ }\r
+ }\r
+}\r