* ============LICENSE_START=======================================================\r
* ONAP Policy API\r
* ================================================================================\r
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.\r
+ * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.\r
+ * Modifications Copyright (C) 2020 Nordix Foundation.\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
\r
package org.onap.policy.api.main.rest.provider;\r
\r
-import org.onap.policy.models.tosca.simple.concepts.ToscaServiceTemplate;\r
+import java.util.ArrayList;\r
+import java.util.List;\r
+import java.util.Map;\r
+\r
+import javax.ws.rs.core.Response;\r
+\r
+import org.apache.commons.lang3.tuple.Pair;\r
+import org.onap.policy.models.base.PfConceptKey;\r
+import org.onap.policy.models.base.PfModelException;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
\r
/**\r
* Class to provide all kinds of policy operations.\r
*\r
* @author Chenfei Gao (cgao@research.att.com)\r
*/\r
-public class PolicyProvider {\r
+public class PolicyProvider extends CommonModelProvider {\r
\r
- private static final String DELETE_OK = "Successfully deleted";\r
+ /**\r
+ * Default constructor.\r
+ */\r
+ public PolicyProvider() throws PfModelException {\r
+ super();\r
+ }\r
\r
/**\r
* Retrieves a list of policies matching specified ID and version of both policy type and policy.\r
* @param policyVersion the version of policy\r
*\r
* @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion,\r
- String policyId, String policyVersion) {\r
- // placeholder\r
- return new ToscaServiceTemplate();\r
+ public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) throws PfModelException {\r
+\r
+ ToscaServiceTemplate serviceTemplate =\r
+ getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+\r
+ if (!hasPolicy(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
+ }\r
+\r
+ return serviceTemplate;\r
}\r
\r
/**\r
- * Creates a new policy for a policy type ID and version.\r
+ * Retrieves a list of policies with the latest versions that match specified policy type id and version.\r
*\r
* @param policyTypeId the ID of policy type\r
* @param policyTypeVersion the version of policy type\r
+ * @param policyId the ID of the policy\r
+ *\r
+ * @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
+ */\r
+ public ToscaServiceTemplate fetchLatestPolicies(String policyTypeId, String policyTypeVersion, String policyId)\r
+ throws PfModelException {\r
+\r
+ ToscaServiceTemplate serviceTemplate =\r
+ getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, ToscaPolicyFilter.LATEST_VERSION);\r
+\r
+ if (!hasPolicy(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, null));\r
+ }\r
+\r
+ return serviceTemplate;\r
+ }\r
+\r
+ /**\r
+ * Retrieves a list of deployed policies in each pdp group.\r
+ *\r
+ * @param policyTypeId the ID of policy type\r
+ * @param policyTypeVersion the version of policy type\r
+ * @param policyId the ID of the policy\r
+ *\r
+ * @return a list of deployed policies in each pdp group\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
+ */\r
+ public Map<Pair<String, String>, List<ToscaPolicy>> fetchDeployedPolicies(String policyTypeId,\r
+ String policyTypeVersion, String policyId) throws PfModelException {\r
+\r
+ return collectDeployedPolicies(policyId, new PfConceptKey(policyTypeId, policyTypeVersion),\r
+ modelsProvider::getPolicyList, List::addAll, new ArrayList<>(5));\r
+ }\r
+\r
+ /**\r
+ * Creates one or more new policies for the same policy type ID and version.\r
+ *\r
+ * @param policyTypeId the ID of policy type\r
+ * @param policyTypeVersion the version of policy type\r
+ * @param body the entity body of polic(ies)\r
+ *\r
+ * @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
+ */\r
+ public ToscaServiceTemplate createPolicy(String policyTypeId, String policyTypeVersion, ToscaServiceTemplate body)\r
+ throws PfModelException {\r
+\r
+ return modelsProvider.createPolicies(body);\r
+ }\r
+\r
+ /**\r
+ * Creates one or more new policies.\r
+ *\r
* @param body the entity body of policy\r
*\r
* @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate createPolicy(String policyTypeId, String policyTypeVersion,\r
- ToscaServiceTemplate body) {\r
- // placeholder\r
- return new ToscaServiceTemplate();\r
+ public ToscaServiceTemplate createPolicies(ToscaServiceTemplate body) throws PfModelException {\r
+ return modelsProvider.createPolicies(body);\r
}\r
\r
/**\r
- * Deletes the policies matching specified ID and version of both policy type and policy.\r
+ * Deletes the policy matching specified ID and version of both policy type and policy.\r
*\r
* @param policyTypeId the ID of policy type\r
* @param policyTypeVersion the version of policy type\r
* @param policyId the ID of policy\r
* @param policyVersion the version of policy\r
*\r
- * @return a string message indicating the operation results\r
+ * @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
*/\r
- public String deletePolicies(String policyTypeId, String policyTypeVersion,\r
- String policyId, String policyVersion) {\r
- // placeholder\r
- return DELETE_OK;\r
+ public ToscaServiceTemplate deletePolicy(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) throws PfModelException {\r
+\r
+ ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicy(policyId, policyVersion);\r
+\r
+ if (!hasPolicy(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
+ }\r
+\r
+ return serviceTemplate;\r
+ }\r
+\r
+ /**\r
+ * Retrieves the specified version of the policy.\r
+ *\r
+ * @param policyTypeName the name of the policy type\r
+ * @param policyTypeVersion the version of the policy type\r
+ * @param policyName the name of the policy\r
+ * @param policyVersion the version of the policy\r
+ *\r
+ * @return the TOSCA service template containing the specified version of the policy\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
+ */\r
+ private ToscaServiceTemplate getFilteredPolicies(String policyTypeName, String policyTypeVersion, String policyName,\r
+ String policyVersion) throws PfModelException {\r
+\r
+ ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder().name(policyName).version(policyVersion)\r
+ .type(policyTypeName).typeVersion(policyTypeVersion).build();\r
+ return modelsProvider.getFilteredPolicies(policyFilter);\r
+ }\r
+\r
+ /**\r
+ * Constructs returned message for not found resource.\r
+ *\r
+ * @param policyTypeId the ID of policy type\r
+ * @param policyTypeVersion the version of policy type\r
+ * @param policyId the ID of policy\r
+ * @param policyVersion the version of policy\r
+ *\r
+ * @return constructed message\r
+ */\r
+ private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) {\r
+\r
+ return "policy with ID " + policyId + ":" + policyVersion + " and type " + policyTypeId + ":"\r
+ + policyTypeVersion + " does not exist";\r
}\r
-}
\ No newline at end of file
+}\r
Code Review / policy / api.git / blobdiff