\r
package org.onap.policy.api.main.rest.provider;\r
\r
+import java.util.ArrayList;\r
+import java.util.HashMap;\r
import java.util.List;\r
import java.util.Map;\r
import javax.ws.rs.core.Response;\r
import org.onap.policy.models.base.PfModelException;\r
import org.onap.policy.models.pdp.concepts.PdpGroup;\r
import org.onap.policy.models.pdp.concepts.PdpGroupFilter;\r
+import org.onap.policy.models.pdp.concepts.PdpSubGroup;\r
+import org.onap.policy.models.pdp.enums.PdpState;\r
import org.onap.policy.models.provider.PolicyModelsProvider;\r
import org.onap.policy.models.provider.PolicyModelsProviderFactory;\r
import org.onap.policy.models.provider.PolicyModelsProviderParameters;\r
*\r
* @author Chenfei Gao (cgao@research.att.com)\r
*/\r
-public class PolicyProvider {\r
+public class PolicyProvider implements AutoCloseable {\r
\r
private PolicyModelsProvider modelsProvider;\r
\r
public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion,\r
String policyId, String policyVersion) throws PfModelException {\r
\r
- validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
+ ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
+ .name(policyId).version(policyVersion)\r
+ .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
+ ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicies(policyFilter);\r
\r
- ToscaServiceTemplate serviceTemplate;\r
- if (policyId == null || policyVersion == null) {\r
- ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
- .name(policyId).version(policyVersion)\r
- .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
- serviceTemplate = modelsProvider.getFilteredPolicies(policyFilter);\r
- } else {\r
- serviceTemplate = modelsProvider.getPolicies(policyId, policyVersion);\r
+ if (!hasPolicy(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
}\r
\r
- validatePolicyTypeMatch(policyTypeId, policyTypeVersion, serviceTemplate);\r
-\r
- close();\r
return serviceTemplate;\r
}\r
\r
public ToscaServiceTemplate fetchLatestPolicies(String policyTypeId, String policyTypeVersion,\r
String policyId) throws PfModelException {\r
\r
- validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
-\r
ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
.name(policyId).version(ToscaPolicyFilter.LATEST_VERSION)\r
.type(policyTypeId).typeVersion(policyTypeVersion).build();\r
ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicies(policyFilter);\r
\r
- validatePolicyTypeMatch(policyTypeId, policyTypeVersion, serviceTemplate);\r
+ if (!hasPolicy(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, null));\r
+ }\r
\r
- close();\r
return serviceTemplate;\r
}\r
\r
public Map<Pair<String, String>, List<ToscaPolicy>> fetchDeployedPolicies(\r
String policyTypeId, String policyTypeVersion, String policyId) throws PfModelException {\r
\r
- validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
-\r
- ToscaPolicyIdentifier policyIdentifier = new ToscaPolicyIdentifier();\r
- policyIdentifier.setName(policyId);\r
- PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder()\r
- .policyType(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion))\r
- .policy(policyIdentifier).build();\r
+ List<ToscaPolicyTypeIdentifier> policyTypes = new ArrayList<>();\r
+ policyTypes.add(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion));\r
+ PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder().policyTypeList(policyTypes)\r
+ .groupState(PdpState.ACTIVE).pdpState(PdpState.ACTIVE).build();\r
List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);\r
\r
- //TODO: I don't know how to get policies matching policyId that are deployed in those PDP groups\r
+ if (pdpGroups.isEmpty()) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructDeploymentNotFoundMessage(policyTypeId, policyTypeVersion, policyId));\r
+ }\r
+\r
+ Map<Pair<String, String>, List<ToscaPolicy>> deployedPolicyMap =\r
+ constructDeployedPolicyMap(pdpGroups, policyId);\r
+ if (deployedPolicyMap.isEmpty()) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructDeploymentNotFoundMessage(policyTypeId, policyTypeVersion, policyId));\r
+ }\r
\r
- close();\r
- return null;\r
+ return deployedPolicyMap;\r
}\r
\r
/**\r
validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
validatePolicyTypeMatch(policyTypeId, policyTypeVersion, body);\r
\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.createPolicies(body);\r
-\r
- close();\r
- return serviceTemplate;\r
+ return modelsProvider.createPolicies(body);\r
}\r
\r
/**\r
public ToscaServiceTemplate deletePolicy(String policyTypeId, String policyTypeVersion,\r
String policyId, String policyVersion) throws PfModelException {\r
\r
- validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
-\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.getPolicies(policyId, policyVersion);\r
-\r
- validatePolicyTypeMatch(policyTypeId, policyTypeVersion, serviceTemplate);\r
validateDeleteEligibility(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
\r
- ToscaServiceTemplate deletedServiceTemplate = modelsProvider.deletePolicy(policyId, policyVersion);\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
- close();\r
- return deletedServiceTemplate;\r
+ return serviceTemplate;\r
}\r
\r
/**\r
*/\r
private void validatePolicyTypeExist(String policyTypeId, String policyTypeVersion) throws PfModelException {\r
\r
- try {\r
- modelsProvider.getPolicyTypes(policyTypeId, policyTypeVersion);\r
- } catch (Exception e) {\r
- throw new PfModelException(Response.Status.NOT_FOUND, "specified policy type does not exist", e);\r
+ ToscaServiceTemplate serviceTemplate = modelsProvider.getPolicyTypes(policyTypeId, policyTypeVersion);\r
+ if (!hasPolicyType(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist");\r
}\r
}\r
\r
\r
List<Map<String, ToscaPolicy>> policies = serviceTemplate.getToscaTopologyTemplate().getPolicies();\r
for (Map<String, ToscaPolicy> policy : policies) {\r
- if (policy.size() != 1) {\r
+ if (policy.size() > 1) {\r
throw new PfModelException(Response.Status.BAD_REQUEST,\r
"one policy block contains more than one policies");\r
}\r
ToscaPolicy policyContent = policy.values().iterator().next();\r
- if (!policyTypeId.equalsIgnoreCase(policyContent.getType())\r
- || !policyTypeVersion.equalsIgnoreCase(policyContent.getTypeVersion())) {\r
- throw new PfModelException(Response.Status.BAD_REQUEST, "policy type does not match");\r
+ if (!policyTypeId.equalsIgnoreCase(policyContent.getType())) {\r
+ throw new PfModelException(Response.Status.BAD_REQUEST, "policy type id does not match");\r
+ }\r
+ if (policyContent.getTypeVersion() != null\r
+ && !policyTypeVersion.equalsIgnoreCase(policyContent.getTypeVersion())) {\r
+ throw new PfModelException(Response.Status.BAD_REQUEST, "policy type version does not match");\r
}\r
}\r
}\r
private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion,\r
String policyId, String policyVersion) throws PfModelException {\r
\r
+ List<ToscaPolicyTypeIdentifier> policyTypes = new ArrayList<>();\r
+ policyTypes.add(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion));\r
+ List<ToscaPolicyIdentifier> policies = new ArrayList<>();\r
+ policies.add(new ToscaPolicyIdentifier(policyId, policyVersion));\r
PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder()\r
- .policyType(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion))\r
- .policy(new ToscaPolicyIdentifier(policyId, policyVersion)).build();\r
+ .policyTypeList(policyTypes).policyList(policies).build();\r
\r
List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);\r
+\r
if (!pdpGroups.isEmpty()) {\r
- throw new PfModelException(Response.Status.CONFLICT, "the policy has been deployed in pdp group");\r
+ throw new PfModelException(Response.Status.CONFLICT,\r
+ constructDeleteRuleViolationMessage(policyId, policyVersion, pdpGroups));\r
}\r
}\r
\r
/**\r
- * Closes the connection to database.\r
+ * Constructs returned message for policy delete rule violation.\r
+ *\r
+ * @param policyId the ID of policy\r
+ * @param policyVersion the version of policy\r
+ * @param pdpGroups the list of pdp groups\r
+ *\r
+ * @return the constructed message\r
+ */\r
+ private String constructDeleteRuleViolationMessage(\r
+ String policyId, String policyVersion, List<PdpGroup> pdpGroups) {\r
+\r
+ List<String> pdpGroupNameVersionList = new ArrayList<>();\r
+ for (PdpGroup pdpGroup : pdpGroups) {\r
+ pdpGroupNameVersionList.add(pdpGroup.getName() + ":" + pdpGroup.getVersion());\r
+ }\r
+ String deployedPdpGroups = String.join(",", pdpGroupNameVersionList);\r
+ return "policy with ID " + policyId + ":" + policyVersion\r
+ + " cannot be deleted as it is deployed in pdp groups " + deployedPdpGroups;\r
+ }\r
+\r
+ /**\r
+ * Constructs the map of deployed pdp groups and deployed policies.\r
+ *\r
+ * @param pdpGroups the list of pdp groups that contain the specified policy\r
+ * @param policyId the ID of policy\r
+ *\r
+ * @return the constructed map of pdp groups and deployed policies\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- private void close() throws PfModelException {\r
- try {\r
- modelsProvider.close();\r
- } catch (Exception e) {\r
- throw new PfModelException(\r
- Response.Status.INTERNAL_SERVER_ERROR, "error closing connection to database", e);\r
+ private Map<Pair<String, String>, List<ToscaPolicy>> constructDeployedPolicyMap(\r
+ List<PdpGroup> pdpGroups, String policyId) throws PfModelException {\r
+\r
+ Map<Pair<String, String>, List<ToscaPolicy>> deployedPolicyMap = new HashMap<>();\r
+ for (PdpGroup pdpGroup : pdpGroups) {\r
+ List<ToscaPolicyIdentifier> policyIdentifiers = new ArrayList<>();\r
+ for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {\r
+ for (ToscaPolicyIdentifier policyIdentifier : pdpSubGroup.getPolicies()) {\r
+ if (policyId.equalsIgnoreCase(policyIdentifier.getName())) {\r
+ policyIdentifiers.add(policyIdentifier);\r
+ }\r
+ }\r
+ }\r
+ List<ToscaPolicy> deployedPolicies = new ArrayList<>();\r
+ if (!policyIdentifiers.isEmpty()) {\r
+ for (ToscaPolicyIdentifier policyIdentifier : policyIdentifiers) {\r
+ deployedPolicies.addAll(\r
+ modelsProvider.getPolicyList(policyIdentifier.getName(), policyIdentifier.getVersion()));\r
+ }\r
+ }\r
+ if (!deployedPolicies.isEmpty()) {\r
+ deployedPolicyMap.put(Pair.of(pdpGroup.getName(), pdpGroup.getVersion()), deployedPolicies);\r
+ }\r
+ }\r
+ return deployedPolicyMap;\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,\r
+ String policyId, String policyVersion) {\r
+\r
+ return "policy with ID " + policyId + ":" + policyVersion\r
+ + " and type " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
+ }\r
+\r
+ /**\r
+ * Constructs returned message for not found policy deployment.\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 constructDeploymentNotFoundMessage(String policyTypeId, String policyTypeVersion,\r
+ String policyId) {\r
+\r
+ return "could not find policy with ID " + policyId + " and type "\r
+ + policyTypeId + ":" + policyTypeVersion + " deployed in any pdp group";\r
+ }\r
+\r
+ /**\r
+ * Checks if service template contains any policy.\r
+ *\r
+ * @param serviceTemplate the service template to check against\r
+ *\r
+ * @return boolean whether service template contains any policy\r
+ */\r
+ private boolean hasPolicy(ToscaServiceTemplate serviceTemplate) {\r
+\r
+ if (serviceTemplate.getToscaTopologyTemplate().getPolicies() == null) {\r
+ return false;\r
+ } else if (serviceTemplate.getToscaTopologyTemplate().getPolicies().isEmpty()) {\r
+ return false;\r
+ } else if (serviceTemplate.getToscaTopologyTemplate().getPolicies().get(0).isEmpty()) {\r
+ return false;\r
+ } else {\r
+ return true;\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Checks if service template contains any policy type.\r
+ *\r
+ * @param serviceTemplate the service template to check against\r
+ *\r
+ * @return boolean whether service template contains any policy type\r
+ */\r
+ private boolean hasPolicyType(ToscaServiceTemplate serviceTemplate) {\r
+\r
+ if (serviceTemplate.getPolicyTypes() == null) {\r
+ return false;\r
+ } else if (serviceTemplate.getPolicyTypes().isEmpty()) {\r
+ return false;\r
+ } else if (serviceTemplate.getPolicyTypes().get(0).isEmpty()) {\r
+ return false;\r
+ } else {\r
+ return true;\r
}\r
}\r
+\r
+ /**\r
+ * Closes the connection to database.\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
+ */\r
+ @Override\r
+ public void close() throws PfModelException {\r
+\r
+ modelsProvider.close();\r
+ }\r
}\r
Code Review / policy / api.git / blobdiff