* ============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 java.util.ArrayList;\r
import java.util.List;\r
+import java.util.Map.Entry;\r
+\r
import javax.ws.rs.core.Response;\r
-import org.onap.policy.api.main.parameters.ApiParameterGroup;\r
-import org.onap.policy.common.parameters.ParameterService;\r
+\r
import org.onap.policy.models.base.PfModelException;\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
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.ToscaPolicyType;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
\r
*\r
* @author Chenfei Gao (cgao@research.att.com)\r
*/\r
-public class PolicyTypeProvider {\r
-\r
- private PolicyModelsProvider modelsProvider;\r
+public class PolicyTypeProvider extends CommonModelProvider {\r
\r
/**\r
* Default constructor.\r
*/\r
public PolicyTypeProvider() throws PfModelException {\r
-\r
- ApiParameterGroup parameterGroup = ParameterService.get("ApiGroup");\r
- PolicyModelsProviderParameters providerParameters = parameterGroup.getDatabaseProviderParameters();\r
- modelsProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParameters);\r
+ super();\r
}\r
\r
/**\r
public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion)\r
throws PfModelException {\r
\r
- ToscaPolicyTypeFilter policyTypeFilter = ToscaPolicyTypeFilter.builder()\r
- .name(policyTypeId).version(policyTypeVersion).build();\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
+ ToscaServiceTemplate serviceTemplate = getFilteredPolicyTypes(policyTypeId, policyTypeVersion);\r
\r
if (policyTypeId != null && !hasPolicyType(serviceTemplate)) {\r
throw new PfModelException(Response.Status.NOT_FOUND,\r
constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
}\r
\r
- close();\r
return serviceTemplate;\r
}\r
\r
*/\r
public ToscaServiceTemplate fetchLatestPolicyTypes(String policyTypeId) throws PfModelException {\r
\r
- ToscaPolicyTypeFilter policyTypeFilter = ToscaPolicyTypeFilter.builder()\r
- .name(policyTypeId).version(ToscaPolicyTypeFilter.LATEST_VERSION).build();\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
- if (serviceTemplate.getPolicyTypes().isEmpty()) {\r
- throw new PfModelException(Response.Status.NOT_FOUND,\r
- constructResourceNotFoundMessage(policyTypeId, null));\r
+ ToscaServiceTemplate serviceTemplate =\r
+ getFilteredPolicyTypes(policyTypeId, ToscaPolicyTypeFilter.LATEST_VERSION);\r
+ if (!hasPolicyType(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND, constructResourceNotFoundMessage(policyTypeId, null));\r
}\r
\r
- close();\r
return serviceTemplate;\r
}\r
\r
*/\r
public ToscaServiceTemplate createPolicyType(ToscaServiceTemplate body) throws PfModelException {\r
\r
- ToscaServiceTemplate serviceTemplate = modelsProvider.createPolicyTypes(body);\r
-\r
- close();\r
- return serviceTemplate;\r
+ if (!hasPolicyType(body)) {\r
+ throw new PfModelException(Response.Status.BAD_REQUEST,\r
+ "no policy types specified in the service template");\r
+ }\r
+ validatePolicyTypeVersionExist(body);\r
+ return modelsProvider.createPolicyTypes(body);\r
}\r
\r
/**\r
\r
ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
\r
- close();\r
+ if (!hasPolicyType(serviceTemplate)) {\r
+ throw new PfModelException(Response.Status.NOT_FOUND,\r
+ constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
+ }\r
+\r
return serviceTemplate;\r
}\r
\r
/**\r
- * Validates whether specified policy type can be deleted based on the rule that\r
- * policy type parameterized by at least one policies cannot be deleted.\r
+ * Validates whether specified policy type can be deleted based on the rule that policy type parameterized by at\r
+ * least one policies cannot be deleted.\r
*\r
* @param policyTypeId the ID of policy type\r
* @param policyTypeVersion the version of policy type\r
*/\r
private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion) throws PfModelException {\r
\r
- ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
- .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
+ ToscaPolicyFilter policyFilter =\r
+ ToscaPolicyFilter.builder().type(policyTypeId).typeVersion(policyTypeVersion).build();\r
List<ToscaPolicy> policies = modelsProvider.getFilteredPolicyList(policyFilter);\r
if (!policies.isEmpty()) {\r
throw new PfModelException(Response.Status.CONFLICT,\r
- "the policy type has been parameterized by at least one policies");\r
+ constructDeletePolicyTypeViolationMessage(policyTypeId, policyTypeVersion, policies));\r
}\r
}\r
\r
/**\r
- * Constructs returned message for not found resource.\r
+ * Validates that each policy type has a version specified in the payload.\r
*\r
- * @param policyTypeId the ID of policy type\r
- * @param policyTypeVersion the version of policy type\r
+ * @param body the TOSCA service template payload to check against\r
*\r
- * @return constructed message\r
+ * @throws PfModelException the PfModel parsing exception\r
*/\r
- private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion) {\r
+ private void validatePolicyTypeVersionExist(ToscaServiceTemplate body) throws PfModelException {\r
+\r
+ List<String> invalidPolicyTypeNames = new ArrayList<>();\r
+ for (Entry<String, ToscaPolicyType> policyType : body.getPolicyTypes().entrySet()) {\r
+ if (!"tosca.policies.Root".equals(policyType.getValue().getDerivedFrom())\r
+ && policyType.getValue().getVersion() == null) {\r
+ invalidPolicyTypeNames.add(policyType.getKey());\r
+ }\r
+ }\r
\r
- return "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
+ if (!invalidPolicyTypeNames.isEmpty()) {\r
+ String errorMsg = "mandatory 'version' field is missing in policy types: "\r
+ + String.join(", ", invalidPolicyTypeNames);\r
+ throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMsg);\r
+ }\r
}\r
\r
/**\r
- * Checks if service template contains any policy type.\r
+ * Retrieves the specified version of the policy type.\r
*\r
- * @param serviceTemplate the service template to check against\r
+ * @param policyTypeName the name of the policy type\r
+ * @param policyTypeVersion the version of the policy type\r
*\r
- * @return boolean whether service template contains any policy type\r
+ * @return the TOSCA service template containing the specified version of the policy type\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\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
+ private ToscaServiceTemplate getFilteredPolicyTypes(String policyTypeName, String policyTypeVersion)\r
+ throws PfModelException {\r
+\r
+ ToscaPolicyTypeFilter policyTypeFilter =\r
+ ToscaPolicyTypeFilter.builder().name(policyTypeName).version(policyTypeVersion).build();\r
+ return modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
}\r
\r
/**\r
- * Closes the connection to database.\r
+ * Constructs returned message for not found resource.\r
*\r
- * @throws PfModelException the PfModel parsing exception\r
+ * @param policyTypeId the ID of policy type\r
+ * @param policyTypeVersion the version of policy type\r
+ *\r
+ * @return constructed message\r
*/\r
- private void close() throws PfModelException {\r
+ private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion) {\r
\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
- }\r
+ return "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
}\r
}\r
Code Review / policy / api.git / blobdiff