* ONAP Policy API\r
* ================================================================================\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
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 java.util.Map.Entry;\r
+\r
import javax.ws.rs.core.Response;\r
\r
import org.apache.commons.lang3.tuple.Pair;\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion,\r
- String policyId, String policyVersion) throws PfModelException {\r
+ public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate = getFilteredPolicies(\r
- policyTypeId, policyTypeVersion, policyId, policyVersion);\r
+ ToscaServiceTemplate serviceTemplate =\r
+ getFilteredPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
\r
if (!hasPolicy(serviceTemplate)) {\r
throw new PfModelException(Response.Status.NOT_FOUND,\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate fetchLatestPolicies(String policyTypeId, String policyTypeVersion,\r
- String policyId) throws PfModelException {\r
+ public ToscaServiceTemplate fetchLatestPolicies(String policyTypeId, String policyTypeVersion, String policyId)\r
+ throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate = getFilteredPolicies(\r
- policyTypeId, policyTypeVersion, policyId, ToscaPolicyFilter.LATEST_VERSION);\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
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- public Map<Pair<String, String>, List<ToscaPolicy>> fetchDeployedPolicies(\r
- String policyTypeId, String policyTypeVersion, String policyId) throws PfModelException {\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
* @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate createPolicy(String policyTypeId, String policyTypeVersion,\r
- ToscaServiceTemplate body) throws PfModelException {\r
+ public ToscaServiceTemplate createPolicy(String policyTypeId, String policyTypeVersion, ToscaServiceTemplate body)\r
+ throws PfModelException {\r
\r
- validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
- validatePolicyTypeMatch(policyTypeId, policyTypeVersion, body);\r
- validatePolicyVersion(body);\r
return modelsProvider.createPolicies(body);\r
}\r
\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
public ToscaServiceTemplate createPolicies(ToscaServiceTemplate body) throws PfModelException {\r
-\r
- validatePolicyVersion(body);\r
return modelsProvider.createPolicies(body);\r
}\r
\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate deletePolicy(String policyTypeId, String policyTypeVersion,\r
- String policyId, String policyVersion) throws PfModelException {\r
+ public ToscaServiceTemplate deletePolicy(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) throws PfModelException {\r
\r
validateDeleteEligibility(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
\r
return serviceTemplate;\r
}\r
\r
- /**\r
- * Validates whether policy type exists.\r
- *\r
- * @param policyTypeId the ID of policy type\r
- * @param policyTypeVersion the version of policy type\r
- *\r
- * @throws PfModelException the PfModel parsing exception\r
- */\r
- private void validatePolicyTypeExist(String policyTypeId, String policyTypeVersion) throws PfModelException {\r
-\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
- * Validates the match between policy type specified in path and the one specified in type of policy.\r
- *\r
- * @param policyTypeId the ID of policy type\r
- * @param policyTypeVersion the version of policy type\r
- * @param serviceTemplate the ToscaServiceTemplate to validate\r
- *\r
- * @throws PfModelException the PfModel parsing exception\r
- */\r
- private void validatePolicyTypeMatch(String policyTypeId, String policyTypeVersion,\r
- ToscaServiceTemplate serviceTemplate) throws PfModelException {\r
-\r
- List<Map<String, ToscaPolicy>> policies = serviceTemplate.getToscaTopologyTemplate().getPolicies();\r
- for (Map<String, ToscaPolicy> policy : policies) {\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
- 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
-\r
/**\r
* Validates whether specified policy can be deleted based on the rule that deployed policy cannot be deleted.\r
*\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion,\r
- String policyId, String policyVersion) throws PfModelException {\r
+ private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) throws PfModelException {\r
\r
+ // TODO: Remove this method when delete validation is implemented in the tosca provider\r
List<ToscaPolicyTypeIdentifier> policyTypes = new ArrayList<>(1);\r
policyTypes.add(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion));\r
List<ToscaPolicyIdentifier> policies = new ArrayList<>(1);\r
policies.add(new ToscaPolicyIdentifier(policyId, policyVersion));\r
- PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder()\r
- .policyTypeList(policyTypes).policyList(policies).build();\r
+ PdpGroupFilter pdpGroupFilter =\r
+ PdpGroupFilter.builder().policyTypeList(policyTypes).policyList(policies).build();\r
\r
List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);\r
\r
}\r
}\r
\r
- /**\r
- * Validates the provided policy version in the payload.\r
- *\r
- * @param body the provided TOSCA service template which contains the policies\r
- *\r
- * @throws PfModelException the PfModel parsing exception\r
- */\r
- private void validatePolicyVersion(ToscaServiceTemplate body) throws PfModelException {\r
-\r
- validatePolicyVersionExist(body);\r
- validateNoDuplicateVersionInDb(body);\r
- validateNoDuplicateVersionInPl(body);\r
- }\r
-\r
- /**\r
- * Validates the existence of at least one policies in the provided payload.\r
- *\r
- * @param body the TOSCA service template payload to check against\r
- *\r
- * @throws PfModelException the PfModel parsing exception\r
- */\r
- private void validatePolicyVersionExist(ToscaServiceTemplate body) throws PfModelException {\r
-\r
- List<String> invalidPolicyNames = new ArrayList<>(body.getToscaTopologyTemplate().getPolicies().size());\r
- for (Map<String, ToscaPolicy> policy : body.getToscaTopologyTemplate().getPolicies()) {\r
- ToscaPolicy policyContent = policy.values().iterator().next();\r
- if (policyContent.getVersion() == null) {\r
- invalidPolicyNames.add(policy.keySet().iterator().next());\r
- }\r
- }\r
-\r
- if (!invalidPolicyNames.isEmpty()) {\r
- String errMsg = "mandatory 'version' field is missing in policies: "\r
- + String.join(", ", invalidPolicyNames);\r
- throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);\r
- }\r
- }\r
-\r
- /**\r
- * Validates there is no duplicate policy version stored in the database.\r
- *\r
- * @param body the TOSCA service template payload to check against\r
- *\r
- * @throws PfModelException the PfModel parsing exception\r
- */\r
- private void validateNoDuplicateVersionInDb(ToscaServiceTemplate body) throws PfModelException {\r
-\r
- Map<String, String> invalidPolicies = new HashMap<>();\r
- for (Map<String, ToscaPolicy> policy: body.getToscaTopologyTemplate().getPolicies()) {\r
- ToscaPolicy policyContent = policy.values().iterator().next();\r
- String policyName = policy.keySet().iterator().next();\r
- String policyVersion = policyContent.getVersion();\r
- String policyTypeName = policyContent.getType();\r
- String policyTypeVersion = policyContent.getTypeVersion();\r
- ToscaServiceTemplate serviceTemplate =\r
- getFilteredPolicies(policyTypeName, policyTypeVersion, policyName, policyVersion);\r
- if (hasPolicy(serviceTemplate)) {\r
- String latestVersion = getFilteredPolicies(policyTypeName, policyTypeVersion,\r
- policyName, ToscaPolicyFilter.LATEST_VERSION).getToscaTopologyTemplate().getPoliciesAsMap()\r
- .values().iterator().next().getVersion();\r
- invalidPolicies.put(String.join(":", policyName, policyVersion), latestVersion);\r
- }\r
- }\r
-\r
- if (!invalidPolicies.isEmpty()) {\r
- List<String> duplicateVersions = new ArrayList<>(5);\r
- for (Entry<String, String> invalidPolicy : invalidPolicies.entrySet()) {\r
- String eachDuplicateVersion = "policy " + invalidPolicy.getKey()\r
- + " already exists; its latest version is " + invalidPolicy.getValue();\r
- duplicateVersions.add(eachDuplicateVersion);\r
- }\r
- throw new PfModelException(Response.Status.NOT_ACCEPTABLE, String.join("\n", duplicateVersions));\r
- }\r
- }\r
-\r
- /**\r
- * Validates there is no duplicate policy version in the provided payload if multiple policies are present.\r
- *\r
- * @param body the TOSCA service template payload to check against\r
- *\r
- * @throws PfModelException the PfModel parsing exception\r
- */\r
- private void validateNoDuplicateVersionInPl(ToscaServiceTemplate body) throws PfModelException {\r
-\r
- List<Map<String, ToscaPolicy>> policies = body.getToscaTopologyTemplate().getPolicies();\r
- List<String> duplicateVersions = new ArrayList<>();\r
- for (int i = 0; i < policies.size() - 1; i++) {\r
- for (int j = i + 1; j < policies.size(); j++) {\r
- if (hasSameNameVersion(policies.get(i), policies.get(j))) {\r
- String nameVersion = policies.get(i).keySet().iterator().next() + ":"\r
- + policies.get(i).values().iterator().next().getVersion();\r
- duplicateVersions.add(nameVersion);\r
- }\r
- }\r
- }\r
-\r
- if (!duplicateVersions.isEmpty()) {\r
- String errMsg = "the same version of policies '" + String.join(", ", duplicateVersions)\r
- + "' appear multiple times in the payload";\r
- throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errMsg);\r
- }\r
- }\r
-\r
- /**\r
- * Checks if two policies have the same name and version.\r
- *\r
- * @param policy1 the first policy\r
- * @param policy2 the second policy\r
- *\r
- * @return the boolean flag to indicate the result\r
- */\r
- private boolean hasSameNameVersion(Map<String, ToscaPolicy> policy1, Map<String, ToscaPolicy> policy2) {\r
-\r
- return (policy1.keySet().iterator().next().equals(policy2.keySet().iterator().next())\r
- && policy1.values().iterator().next().getVersion().equals(\r
- policy2.values().iterator().next().getVersion()));\r
- }\r
-\r
/**\r
* Retrieves the specified version of the policy.\r
*\r
*\r
* @throws PfModelException the PfModel parsing exception\r
*/\r
- private ToscaServiceTemplate getFilteredPolicies(String policyTypeName, String policyTypeVersion,\r
- String policyName, String policyVersion) throws PfModelException {\r
+ private ToscaServiceTemplate getFilteredPolicies(String policyTypeName, String policyTypeVersion, String policyName,\r
+ String policyVersion) throws PfModelException {\r
\r
- ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
- .name(policyName).version(policyVersion)\r
+ ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder().name(policyName).version(policyVersion)\r
.type(policyTypeName).typeVersion(policyTypeVersion).build();\r
return modelsProvider.getFilteredPolicies(policyFilter);\r
}\r
*\r
* @return constructed message\r
*/\r
- private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion,\r
- String policyId, String policyVersion) {\r
+ private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion, String policyId,\r
+ String policyVersion) {\r
\r
- return "policy with ID " + policyId + ":" + policyVersion\r
- + " and type " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
+ return "policy with ID " + policyId + ":" + policyVersion + " and type " + policyTypeId + ":"\r
+ + policyTypeVersion + " does not exist";\r
}\r
}\r
Code Review / policy / api.git / blobdiff