main/src/main/java/org/onap/policy/api/main/rest/provider/PolicyTypeProvider.java

   1 /*-\r
   2  * ============LICENSE_START=======================================================\r
   3  * ONAP Policy API\r
   4  * ================================================================================\r
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  *\r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  *\r
  19  * SPDX-License-Identifier: Apache-2.0\r
  20  * ============LICENSE_END=========================================================\r
  21  */\r
  22 \r
  23 package org.onap.policy.api.main.rest.provider;\r
  24 \r
  25 import java.util.List;\r
  26 import javax.ws.rs.core.Response;\r
  27 import org.onap.policy.api.main.parameters.ApiParameterGroup;\r
  28 import org.onap.policy.common.parameters.ParameterService;\r
  29 import org.onap.policy.models.base.PfModelException;\r
  30 import org.onap.policy.models.provider.PolicyModelsProvider;\r
  31 import org.onap.policy.models.provider.PolicyModelsProviderFactory;\r
  32 import org.onap.policy.models.provider.PolicyModelsProviderParameters;\r
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;\r
  34 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;\r
  35 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;\r
  36 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
  37 \r
  38 /**\r
  39  * Class to provide all kinds of policy type operations.\r
  40  *\r
  41  * @author Chenfei Gao (cgao@research.att.com)\r
  42  */\r
  43 public class PolicyTypeProvider {\r
  44 \r
  45     private PolicyModelsProvider modelsProvider;\r
  46 \r
  47     /**\r
  48      * Default constructor.\r
  49      */\r
  50     public PolicyTypeProvider() throws PfModelException {\r
  51 \r
  52         ApiParameterGroup parameterGroup = ParameterService.get("ApiGroup");\r
  53         PolicyModelsProviderParameters providerParameters = parameterGroup.getDatabaseProviderParameters();\r
  54         modelsProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParameters);\r
  55     }\r
  56 \r
  57     /**\r
  58      * Retrieves a list of policy types matching specified policy type ID and version.\r
  59      *\r
  60      * @param policyTypeId the ID of policy type\r
  61      * @param policyTypeVersion the version of policy type\r
  62      *\r
  63      * @return the ToscaServiceTemplate object\r
  64      *\r
  65      * @throws PfModelException the PfModel parsing exception\r
  66      */\r
  67     public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion)\r
  68             throws PfModelException {\r
  69 \r
  70         ToscaPolicyTypeFilter policyTypeFilter = ToscaPolicyTypeFilter.builder()\r
  71                 .name(policyTypeId).version(policyTypeVersion).build();\r
  72         ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
  73 \r
  74         if (policyTypeId != null && !hasPolicyType(serviceTemplate)) {\r
  75             throw new PfModelException(Response.Status.NOT_FOUND,\r
  76                     constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
  77         }\r
  78 \r
  79         close();\r
  80         return serviceTemplate;\r
  81     }\r
  82 \r
  83     /**\r
  84      * Retrieves a list of policy types with the latest versions.\r
  85      *\r
  86      * @param policyTypeId the ID of policy type\r
  87      *\r
  88      * @return the ToscaServiceTemplate object\r
  89      *\r
  90      * @throws PfModelException the PfModel parsing exception\r
  91      */\r
  92     public ToscaServiceTemplate fetchLatestPolicyTypes(String policyTypeId) throws PfModelException {\r
  93 \r
  94         ToscaPolicyTypeFilter policyTypeFilter = ToscaPolicyTypeFilter.builder()\r
  95                 .name(policyTypeId).version(ToscaPolicyTypeFilter.LATEST_VERSION).build();\r
  96         ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
  97         if (serviceTemplate.getPolicyTypes().isEmpty()) {\r
  98             throw new PfModelException(Response.Status.NOT_FOUND,\r
  99                     constructResourceNotFoundMessage(policyTypeId, null));\r
 100         }\r
 101 \r
 102         close();\r
 103         return serviceTemplate;\r
 104     }\r
 105 \r
 106     /**\r
 107      * Creates a new policy type.\r
 108      *\r
 109      * @param body the entity body of policy type\r
 110      *\r
 111      * @return the ToscaServiceTemplate object\r
 112      * @throws PfModelException the PfModel parsing exception\r
 113      */\r
 114     public ToscaServiceTemplate createPolicyType(ToscaServiceTemplate body) throws PfModelException {\r
 115 \r
 116         ToscaServiceTemplate serviceTemplate = modelsProvider.createPolicyTypes(body);\r
 117 \r
 118         close();\r
 119         return serviceTemplate;\r
 120     }\r
 121 \r
 122     /**\r
 123      * Delete the policy type matching specified policy type ID and version.\r
 124      *\r
 125      * @param policyTypeId the ID of policy type\r
 126      * @param policyTypeVersion the version of policy type\r
 127      *\r
 128      * @return the ToscaServiceTemplate object\r
 129      *\r
 130      * @throws PfModelException the PfModel parsing exception\r
 131      */\r
 132     public ToscaServiceTemplate deletePolicyType(String policyTypeId, String policyTypeVersion)\r
 133             throws PfModelException {\r
 134 \r
 135         validateDeleteEligibility(policyTypeId, policyTypeVersion);\r
 136 \r
 137         ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
 138 \r
 139         close();\r
 140         return serviceTemplate;\r
 141     }\r
 142 \r
 143     /**\r
 144      * Validates whether specified policy type can be deleted based on the rule that\r
 145      * policy type parameterized by at least one policies cannot be deleted.\r
 146      *\r
 147      * @param policyTypeId the ID of policy type\r
 148      * @param policyTypeVersion the version of policy type\r
 149      *\r
 150      * @throws PfModelException the PfModel parsing exception\r
 151      */\r
 152     private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion) throws PfModelException {\r
 153 \r
 154         ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
 155                 .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
 156         List<ToscaPolicy> policies = modelsProvider.getFilteredPolicyList(policyFilter);\r
 157         if (!policies.isEmpty()) {\r
 158             throw new PfModelException(Response.Status.CONFLICT,\r
 159                     "the policy type has been parameterized by at least one policies");\r
 160         }\r
 161     }\r
 162 \r
 163     /**\r
 164      * Constructs returned message for not found resource.\r
 165      *\r
 166      * @param policyTypeId the ID of policy type\r
 167      * @param policyTypeVersion the version of policy type\r
 168      *\r
 169      * @return constructed message\r
 170      */\r
 171     private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion) {\r
 172 \r
 173         return "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
 174     }\r
 175 \r
 176     /**\r
 177      * Checks if service template contains any policy type.\r
 178      *\r
 179      * @param serviceTemplate the service template to check against\r
 180      *\r
 181      * @return boolean whether service template contains any policy type\r
 182      */\r
 183     private boolean hasPolicyType(ToscaServiceTemplate serviceTemplate) {\r
 184 \r
 185         if (serviceTemplate.getPolicyTypes() == null) {\r
 186             return false;\r
 187         } else if (serviceTemplate.getPolicyTypes().isEmpty()) {\r
 188             return false;\r
 189         } else if (serviceTemplate.getPolicyTypes().get(0).isEmpty()) {\r
 190             return false;\r
 191         } else {\r
 192             return true;\r
 193         }\r
 194     }\r
 195 \r
 196     /**\r
 197      * Closes the connection to database.\r
 198      *\r
 199      * @throws PfModelException the PfModel parsing exception\r
 200      */\r
 201     private void close() throws PfModelException {\r
 202 \r
 203         try {\r
 204             modelsProvider.close();\r
 205         } catch (Exception e) {\r
 206             throw new PfModelException(\r
 207                     Response.Status.INTERNAL_SERVER_ERROR, "error closing connection to database", e);\r
 208         }\r
 209     }\r
 210 }\r