-/*-
- * ============LICENSE_START=======================================================
- * Copyright (C) 2018 Samsung Electronics Co., Ltd. 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 org.onap.policy.common.endpoints.report.HealthCheckReport;
-
-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;
-
-/**
- * Class to provide api REST services.
- *
- */
-@Path("/")
-@Api
-@Produces(MediaType.APPLICATION_JSON)
-@SwaggerDefinition(
- info = @Info(description = "Policy Api Service", version = "v1.0", title = "Policy Api"),
- consumes = { MediaType.APPLICATION_JSON }, produces = { MediaType.APPLICATION_JSON },
- schemes = { SwaggerDefinition.Scheme.HTTP },
- 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();
- }
-}
+/*-\r
+ * ============LICENSE_START=======================================================\r
+ * ONAP Policy API\r
+ * ================================================================================\r
+ * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.\r
+ * Copyright (C) 2019 AT&T Intellectual Property. 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 io.swagger.annotations.Api;\r
+import io.swagger.annotations.ApiOperation;\r
+import io.swagger.annotations.ApiParam;\r
+import io.swagger.annotations.ApiResponse;\r
+import io.swagger.annotations.ApiResponses;\r
+import io.swagger.annotations.Authorization;\r
+import io.swagger.annotations.BasicAuthDefinition;\r
+import io.swagger.annotations.Extension;\r
+import io.swagger.annotations.ExtensionProperty;\r
+import io.swagger.annotations.Info;\r
+import io.swagger.annotations.ResponseHeader;\r
+import io.swagger.annotations.SecurityDefinition;\r
+import io.swagger.annotations.SwaggerDefinition;\r
+import java.util.List;\r
+import java.util.Map;\r
+import java.util.UUID;\r
+import javax.ws.rs.Consumes;\r
+import javax.ws.rs.DELETE;\r
+import javax.ws.rs.GET;\r
+import javax.ws.rs.HeaderParam;\r
+import javax.ws.rs.POST;\r
+import javax.ws.rs.Path;\r
+import javax.ws.rs.PathParam;\r
+import javax.ws.rs.Produces;\r
+import javax.ws.rs.core.Response;\r
+import org.apache.commons.lang3.tuple.Pair;\r
+import org.onap.policy.api.main.rest.provider.HealthCheckProvider;\r
+import org.onap.policy.api.main.rest.provider.PolicyProvider;\r
+import org.onap.policy.api.main.rest.provider.PolicyTypeProvider;\r
+import org.onap.policy.api.main.rest.provider.StatisticsProvider;\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.ToscaPolicy;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
+import org.slf4j.Logger;\r
+import org.slf4j.LoggerFactory;\r
+\r
+/**\r
+ * Class to provide REST API services.\r
+ *\r
+ * @author Chenfei Gao (cgao@research.att.com)\r
+ */\r
+@Path("/policy/api/v1")\r
+@Api(value = "Policy Design API")\r
+@Produces({"application/json", "application/yaml"})\r
+@Consumes({"application/json", "application/yaml"})\r
+@SwaggerDefinition(info = @Info(\r
+ description = "Policy Design API is publicly exposed for clients to Create/Read/Update/Delete"\r
+ + " policy types, policy type implementation and policies which can be recognized"\r
+ + " and executable by incorporated policy engines. It is an"\r
+ + " independent component running rest service that takes all policy design API calls"\r
+ + " from clients and then assign them to different API working functions. Besides"\r
+ + " that, API is also exposed for clients to retrieve healthcheck status of this API"\r
+ + " rest service and the statistics report including the counters of API invocation.",\r
+ version = "1.0.0",\r
+ title = "Policy Design",\r
+ extensions = {\r
+ @Extension(properties = {\r
+ @ExtensionProperty(name = "planned-retirement-date", value = "tbd"),\r
+ @ExtensionProperty(name = "component", value = "Policy Framework")\r
+ })\r
+ }),\r
+ schemes = { SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS },\r
+ securityDefinition = @SecurityDefinition(basicAuthDefinitions = { @BasicAuthDefinition(key = "basicAuth") }))\r
+public class ApiRestController extends CommonRestController {\r
+\r
+ private static final Logger LOGGER = LoggerFactory.getLogger(ApiRestController.class);\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
+ @GET\r
+ @Path("/healthcheck")\r
+ @ApiOperation(value = "Perform a system healthcheck",\r
+ notes = "Returns healthy status of the Policy API component",\r
+ response = HealthCheckReport.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "HealthCheck", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getHealthCheck(\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ updateApiStatisticsCounter(Target.OTHER, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, new HealthCheckProvider().performHealthCheck());\r
+ }\r
+\r
+ /**\r
+ * Retrieves the statistics report of the API component.\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/statistics")\r
+ @ApiOperation(value = "Retrieve current statistics",\r
+ notes = "Returns current statistics including the counters of API invocation",\r
+ response = StatisticsReport.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Statistics", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getStatistics(\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ updateApiStatisticsCounter(Target.OTHER, Result.SUCCESS, HttpMethod.GET);\r
+\r
+ return makeOkResponse(requestId, new StatisticsProvider().fetchCurrentStatistics());\r
+ }\r
+\r
+ /**\r
+ * Retrieves all available policy types.\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes")\r
+ @ApiOperation(value = "Retrieve existing policy types",\r
+ notes = "Returns a list of existing policy types stored in Policy Framework",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "PolicyType", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getAllPolicyTypes(\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(null, null);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes", pfme);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves all versions of a particular policy type.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}")\r
+ @ApiOperation(value = "Retrieve all available versions of a policy type",\r
+ notes = "Returns a list of all available versions for the specified policy type",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "PolicyType", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getAllVersionsOfPolicyType(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(policyTypeId, null);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}", policyTypeId, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{versionId}")\r
+ @ApiOperation(value = "Retrieve one particular version of a policy type",\r
+ notes = "Returns a particular version for the specified policy type",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "PolicyType", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getSpecificVersionOfPolicyType(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("versionId") @ApiParam(value = "Version of policy type", required = true) String versionId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(policyTypeId, versionId);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}/versions/{}", policyTypeId, versionId, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves latest version of a particular policy type.\r
+ *\r
+ * @param policyTypeId the ID of specified policy type\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/latest")\r
+ @ApiOperation(value = "Retrieve latest version of a policy type",\r
+ notes = "Returns latest version for the specified policy type",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "PolicyType", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getLatestVersionOfPolicyType(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchLatestPolicyTypes(policyTypeId);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}/versions/latest", policyTypeId, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Creates a new policy type.\r
+ *\r
+ * @param body the body of policy type following TOSCA definition\r
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @POST\r
+ @Path("/policytypes")\r
+ @ApiOperation(value = "Create a new policy type",\r
+ notes = "Client should provide TOSCA body of the new policy type",\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "PolicyType", },\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 400, message = "Invalid Body"),\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response createPolicyType(\r
+ @ApiParam(value = "Entity body of policy type", required = true) ToscaServiceTemplate body,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
+ NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policytypes", toJson(body));\r
+ }\r
+\r
+ try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyTypeProvider.createPolicyType(body);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.POST);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("POST /policytypes", pfme);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.POST);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @DELETE\r
+ @Path("/policytypes/{policyTypeId}/versions/{versionId}")\r
+ @ApiOperation(value = "Delete one version of a policy type",\r
+ notes = "Rule 1: pre-defined policy types cannot be deleted;"\r
+ + "Rule 2: policy types that are in use (parameterized by a TOSCA policy) cannot be deleted."\r
+ + "The parameterizing TOSCA policies must be deleted first;",\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "PolicyType", },\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 409, message = "Delete Conflict, Rule Violation"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response deleteSpecificVersionOfPolicyType(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("versionId") @ApiParam(value = "Version of policy type", required = true) String versionId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyTypeProvider.deletePolicyType(policyTypeId, versionId);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("DELETE /policytypes/{}/versions/{}", policyTypeId, versionId, pfme);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")\r
+ @ApiOperation(value = "Retrieve all versions of a policy created for a particular policy type version",\r
+ notes = "Returns a list of all versions of specified policy created for the specified policy type version",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getAllPolicies(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ policyProvider.fetchPolicies(policyTypeId, policyTypeVersion, null, null);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}/versions/{}/policies", policyTypeId, policyTypeVersion, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}")\r
+ @ApiOperation(value = "Retrieve all version details of a policy created for a particular policy type version",\r
+ notes = "Returns a list of all version details of the specified policy",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getAllVersionsOfPolicy(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @PathParam("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyProvider\r
+ .fetchPolicies(policyTypeId, policyTypeVersion, policyId, null);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("/policytypes/{}/versions/{}/policies/{}", policyTypeId, policyTypeVersion, policyId,\r
+ pfme);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}")\r
+ @ApiOperation(value = "Retrieve one version of a policy created for a particular policy type version",\r
+ notes = "Returns a particular version of specified policy created for the specified policy type version",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getSpecificVersionOfPolicy(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @PathParam("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
+ @PathParam("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyProvider\r
+ .fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/{}", policyTypeId,\r
+ policyTypeVersion, policyId, policyVersion, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/latest")\r
+ @ApiOperation(value = "Retrieve the latest version of a particular policy",\r
+ notes = "Returns the latest version of specified policy",\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getLatestVersionOfPolicy(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @PathParam("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ policyProvider.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/latest", policyTypeId,\r
+ policyTypeVersion, policyId, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Retrieves deployed versions of a particular policy in pdp groups.\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/deployed")\r
+ @ApiOperation(value = "Retrieve deployed versions of a particular policy in pdp groups",\r
+ notes = "Returns deployed versions of specified policy in pdp groups",\r
+ response = ToscaPolicy.class, responseContainer = "List",\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response getDeployedVersionsOfPolicy(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @PathParam("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ Map<Pair<String, String>, List<ToscaPolicy>> deployedPolicies = policyProvider\r
+ .fetchDeployedPolicies(policyTypeId, policyTypeVersion, policyId);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return makeOkResponse(requestId, deployedPolicies);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/deployed", policyTypeId,\r
+ policyTypeVersion, policyId, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @POST\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")\r
+ @ApiOperation(value = "Create a new policy for a policy type version",\r
+ notes = "Client should provide TOSCA body of the new policy",\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 400, message = "Invalid Body"),\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response createPolicy(\r
+ @PathParam("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId,\r
+ @ApiParam(value = "Entity body of policy", required = true) ToscaServiceTemplate body) {\r
+\r
+ if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
+ NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST,\r
+ "/policytypes/" + policyTypeId + "/versions/" + policyTypeVersion + "/policies",\r
+ toJson(body));\r
+ }\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyProvider\r
+ .createPolicy(policyTypeId, policyTypeVersion, body);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.POST);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("POST /policytypes/{}/versions/{}/policies", policyTypeId, policyTypeVersion, pfme);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.POST);\r
+ return makeErrorResponse(requestId, pfme);\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
+ *\r
+ * @return the Response object containing the results of the API operation\r
+ */\r
+ @DELETE\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}")\r
+ @ApiOperation(value = "Delete a particular version of a policy",\r
+ notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",\r
+ authorizations = @Authorization(value = "basicAuth"),\r
+ tags = { "Policy", },\r
+ response = ToscaServiceTemplate.class,\r
+ responseHeaders = {\r
+ @ResponseHeader(name = "X-MinorVersion",\r
+ description = "Used to request or communicate a MINOR version back from the client"\r
+ + " to the server, and from the server back to the client",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-PatchVersion",\r
+ description = "Used only to communicate a PATCH version in a response for"\r
+ + " troubleshooting purposes only, and will not be provided by"\r
+ + " the client on request",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-LatestVersion",\r
+ description = "Used only to communicate an API's latest version",\r
+ response = String.class),\r
+ @ResponseHeader(name = "X-ONAP-RequestID",\r
+ description = "Used to track REST transactions for logging purpose",\r
+ response = UUID.class)\r
+ },\r
+ extensions = {\r
+ @Extension(name = "interface info", properties = {\r
+ @ExtensionProperty(name = "api-version", value = "1.0.0"),\r
+ @ExtensionProperty(name = "last-mod-release", value = "Dublin")\r
+ })\r
+ })\r
+ @ApiResponses(value = {\r
+ @ApiResponse(code = 401, message = "Authentication Error"),\r
+ @ApiResponse(code = 403, message = "Authorization Error"),\r
+ @ApiResponse(code = 404, message = "Resource Not Found"),\r
+ @ApiResponse(code = 409, message = "Delete Conflict, Rule Violation"),\r
+ @ApiResponse(code = 500, message = "Internal Server Error")\r
+ })\r
+ public Response deleteSpecificVersionOfPolicy(\r
+ @PathParam("policyTypeId") @ApiParam(value = "PolicyType ID", required = true) String policyTypeId,\r
+ @PathParam("policyTypeVersion")\r
+ @ApiParam(value = "Version of policy type", required = true) String policyTypeVersion,\r
+ @PathParam("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
+ @PathParam("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,\r
+ @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
+\r
+ try (PolicyProvider policyProvider = new PolicyProvider()) {\r
+ ToscaServiceTemplate serviceTemplate = policyProvider\r
+ .deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ return makeOkResponse(requestId, serviceTemplate);\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ LOGGER.error("DELETE /policytypes/{}/versions/{}/policies/{}/versions/{}", policyTypeId,\r
+ policyTypeVersion, policyId, policyVersion, pfme);\r
+ return makeErrorResponse(requestId, pfme);\r
+ }\r
+ }\r
+\r
+ private enum Target {\r
+ POLICY, POLICY_TYPE, OTHER\r
+ }\r
+\r
+ private enum Result {\r
+ SUCCESS, FAILURE\r
+ }\r
+\r
+ private enum HttpMethod {\r
+ POST, GET\r
+ }\r
+\r
+ private void updateApiStatisticsCounter(Target target, Result result, HttpMethod http) {\r
+\r
+ ApiStatisticsManager.updateTotalApiCallCount();\r
+\r
+ switch (target) {\r
+ case POLICY:\r
+ updatePolicyStats(result, http);\r
+ break;\r
+ case POLICY_TYPE:\r
+ updatePolicyTypeStats(result, http);\r
+ break;\r
+ default:\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ break;\r
+ }\r
+ }\r
+\r
+ private void updatePolicyStats(Result result, HttpMethod http) {\r
+ if (result == Result.SUCCESS) {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updateTotalPolicyGetCount();\r
+ ApiStatisticsManager.updatePolicyGetSuccessCount();\r
+ } else if (http == HttpMethod.POST) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updateTotalPolicyPostCount();\r
+ ApiStatisticsManager.updatePolicyPostSuccessCount();\r
+ }\r
+ } else {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyGetCount();\r
+ ApiStatisticsManager.updatePolicyGetFailureCount();\r
+ } else {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyPostCount();\r
+ ApiStatisticsManager.updatePolicyPostFailureCount();\r
+ }\r
+ }\r
+ }\r
+\r
+ private void updatePolicyTypeStats(Result result, HttpMethod http) {\r
+ if (result == Result.SUCCESS) {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updateTotalPolicyTypeGetCount();\r
+ ApiStatisticsManager.updatePolicyTypeGetSuccessCount();\r
+ } else if (http == HttpMethod.POST) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updatePolicyTypePostSuccessCount();\r
+ ApiStatisticsManager.updatePolicyTypePostSuccessCount();\r
+ }\r
+ } else {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyTypeGetCount();\r
+ ApiStatisticsManager.updatePolicyTypeGetFailureCount();\r
+ } else {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyTypePostCount();\r
+ ApiStatisticsManager.updatePolicyTypePostFailureCount();\r
+ }\r
+ }\r
+ }\r
+}
\ No newline at end of file