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.Path;\r
import javax.ws.rs.PathParam;\r
import javax.ws.rs.Produces;\r
-import javax.ws.rs.QueryParam;\r
import javax.ws.rs.core.Response;\r
import javax.ws.rs.core.Response.ResponseBuilder;\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.report.HealthCheckReport;\r
-import org.onap.policy.models.tosca.simple.concepts.ToscaServiceTemplate;\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
\r
/**\r
* Class to provide REST API services.\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 addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
.entity(new HealthCheckProvider().performHealthCheck()).build();\r
}\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
return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
.entity(new StatisticsProvider().fetchCurrentStatistics()).build();\r
}\r
})\r
public Response getAllPolicyTypes(\r
@HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyTypeProvider().fetchPolicyTypes(null, null)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyTypeProvider().fetchPolicyTypes(null, null);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyTypeProvider().fetchPolicyTypes(policyTypeId, null)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyTypeProvider()\r
+ .fetchPolicyTypes(policyTypeId, null);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyTypeProvider().fetchPolicyTypes(policyTypeId, versionId)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyTypeProvider()\r
+ .fetchPolicyTypes(policyTypeId, versionId);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyTypeProvider().createPolicyType(body)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyTypeProvider().createPolicyType(body);\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.POST);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.POST);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\r
- * Deletes all versions of a particular policy type.\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}")\r
- @ApiOperation(value = "Delete all versions of a policy type",\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
- 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 = 204, message = "Resources successfully deleted, no content returned",\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
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose",\r
response = UUID.class)\r
- }),\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 deleteAllVersionsOfPolicyType(\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyTypeProvider().deletePolicyTypes(policyTypeId, null)).build();\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
+ },\r
extensions = {\r
@Extension(name = "interface info", properties = {\r
@ExtensionProperty(name = "api-version", value = "1.0.0"),\r
})\r
})\r
@ApiResponses(value = {\r
- @ApiResponse(code = 204, message = "Resource successfully deleted, no content returned",\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
@ApiResponse(code = 401, message = "Authentication Error"),\r
@ApiResponse(code = 403, message = "Authorization Error"),\r
@ApiResponse(code = 404, message = "Resource Not Found"),\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyTypeProvider().deletePolicyTypes(policyTypeId, versionId)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyTypeProvider()\r
+ .deletePolicyType(policyTypeId, versionId);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().fetchPolicies(policyTypeId, policyTypeVersion, null, null)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyProvider()\r
+ .fetchPolicies(policyTypeId, policyTypeVersion, null, null);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().fetchPolicies(policyTypeId, policyTypeVersion, policyId, null)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyProvider()\r
+ .fetchPolicies(policyTypeId, policyTypeVersion, policyId, null);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().fetchPolicies(policyTypeId, policyTypeVersion,\r
- policyId, policyVersion)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyProvider()\r
+ .fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\r
- * Retrieves either latest or deployed version of a particular policy depending on query parameter.\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
* @return the Response object containing the results of the API operation\r
*/\r
@GET\r
- @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions")\r
- @ApiOperation(value = "Retrieve either latest or deployed version of a particular policy depending on query param",\r
- notes = "Returns either latest or deployed version of specified policy depending on query param",\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/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
@ApiResponse(code = 404, message = "Resource Not Found"),\r
@ApiResponse(code = 500, message = "Internal Server Error")\r
})\r
- public Response getEitherLatestOrDeployedVersionOfPolicy(\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
- @QueryParam("type")\r
- @ApiParam(value = "Version that can only be 'latest' or 'deployed'", required = true) String type,\r
@HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().fetchPolicies(policyTypeId, policyTypeVersion, policyId, type)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate =\r
+ new PolicyProvider().fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\r
- * Creates a new policy for a particular policy type and version.\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 body the body of policy following TOSCA definition\r
+ * @param policyId the ID of specified policy\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
+ @GET\r
+ @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/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
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
})\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
+ 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
- @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId,\r
- @ApiParam(value = "Entity body of policy", required = true) ToscaServiceTemplate body) {\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().createPolicy(policyTypeId, policyTypeVersion, body)).build();\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 {\r
+ Map<Pair<String, String>, List<ToscaPolicy>> deployedPolicies = new PolicyProvider()\r
+ .fetchDeployedPolicies(policyTypeId, policyTypeVersion, policyId);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(deployedPolicies).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\r
- * Deletes all versions of a particular policy.\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 policyId the ID of specified policy\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
- @DELETE\r
- @Path("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}")\r
- @ApiOperation(value = "Delete all versions of a policy",\r
- notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",\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
- 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 = 204, message = "Resources successfully deleted, no content returned",\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
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose",\r
response = UUID.class)\r
- }),\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 = 409, message = "Delete Conflict, Rule Violation"),\r
@ApiResponse(code = 500, message = "Internal Server Error")\r
})\r
- public Response deleteAllVersionsOfPolicy(\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
- @PathParam("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
- @HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().deletePolicies(policyTypeId, policyTypeVersion, policyId, null)).build();\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
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyProvider()\r
+ .createPolicy(policyTypeId, policyTypeVersion, body);\r
+ updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.POST);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.POST);\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
/**\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
- 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 = 204, message = "Resource successfully deleted, no content returned",\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
@ResponseHeader(name = "X-ONAP-RequestID",\r
description = "Used to track REST transactions for logging purpose",\r
response = UUID.class)\r
- }),\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
@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
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new PolicyProvider().deletePolicies(policyTypeId, policyTypeVersion,\r
- policyId, policyVersion)).build();\r
+\r
+ try {\r
+ ToscaServiceTemplate serviceTemplate = new PolicyProvider()\r
+ .deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
+ .entity(serviceTemplate).build();\r
+ } catch (PfModelException | PfModelRuntimeException pfme) {\r
+ return addLoggingHeaders(addVersionControlHeaders(\r
+ Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
+ .entity(pfme.getErrorResponse()).build();\r
+ }\r
}\r
\r
private ResponseBuilder addVersionControlHeaders(ResponseBuilder rb) {\r
}\r
return rb.header("X-ONAP-RequestID", requestId);\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
+ if (target == Target.POLICY) {\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
+ } else if (target == Target.POLICY_TYPE) {\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
+ } else {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ }\r
+ }\r
}
\ No newline at end of file
Code Review / policy / api.git / blobdiff