* ============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.concepts.ToscaServiceTemplate;\r
+import org.onap.policy.models.base.PfModelException;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
\r
/**\r
* Class to provide all kinds of policy type operations.\r
+ *\r
+ * @author Chenfei Gao (cgao@research.att.com)\r
*/\r
-public class PolicyTypeProvider {\r
+public class PolicyTypeProvider extends CommonModelProvider {\r
\r
- private static final String POST_OK = "Successfully created";\r
- private static final String DELETE_OK = "Successfully deleted";\r
+ /**\r
+ * Default constructor.\r
+ */\r
+ public PolicyTypeProvider() throws PfModelException {\r
+ super();\r
+ }\r
\r
/**\r
* Retrieves a list of policy types matching specified policy type ID and version.\r
* @param policyTypeId the ID of policy type\r
* @param policyTypeVersion the version of policy type\r
*\r
- * @return the ToscaPolicyTypeList object containing a list of policy types matching specified fields\r
+ * @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
+ */\r
+ public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion)\r
+ throws PfModelException {\r
+\r
+ return getFilteredPolicyTypes(policyTypeId, policyTypeVersion);\r
+ }\r
+\r
+ /**\r
+ * Retrieves a list of policy types with the latest versions.\r
+ *\r
+ * @param policyTypeId the ID of policy type\r
+ *\r
+ * @return the ToscaServiceTemplate object\r
+ *\r
+ * @throws PfModelException the PfModel parsing exception\r
*/\r
- public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion) {\r
- // placeholder\r
- // something like return new PolicyModelProvider().getPolicyTypes(<blah>);\r
- return new ToscaServiceTemplate();\r
+ public ToscaServiceTemplate fetchLatestPolicyTypes(String policyTypeId) throws PfModelException {\r
+\r
+ return getFilteredPolicyTypes(policyTypeId, ToscaPolicyTypeFilter.LATEST_VERSION);\r
}\r
\r
/**\r
*\r
* @param body the entity body of policy type\r
*\r
- * @return a string message indicating the operation results\r
+ * @return the ToscaServiceTemplate object\r
+ * @throws PfModelException the PfModel parsing exception\r
*/\r
- public String createPolicyType(ToscaServiceTemplate body) {\r
- // placeholder\r
- // something like return new PolicyModelProvider().createPolicyTypes(<blah>);\r
- return POST_OK;\r
+ public ToscaServiceTemplate createPolicyType(ToscaServiceTemplate body) throws PfModelException {\r
+\r
+ return modelsProvider.createPolicyTypes(body);\r
}\r
\r
/**\r
- * Delete the policy types matching specified policy type ID and version.\r
+ * Delete the policy type matching specified policy type ID and version.\r
*\r
* @param policyTypeId the ID of policy type\r
* @param policyTypeVersion the version of policy type\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 deletePolicyTypes(String policyTypeId, String policyTypeVersion) {\r
- // placeholder\r
- // something like return new PolicyModelProvider().deletePolicyTypes(<blah>);\r
- return DELETE_OK;\r
+ public ToscaServiceTemplate deletePolicyType(String policyTypeId, String policyTypeVersion)\r
+ throws PfModelException {\r
+\r
+ return modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
+ }\r
+\r
+ /**\r
+ * Retrieves the specified version of the policy type.\r
+ *\r
+ * @param policyTypeName the name of the policy type\r
+ * @param policyTypeVersion the version of the policy type\r
+ *\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 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