models-tosca/src/main/java/org/onap/policy/models/tosca/simple/provider/SimpleToscaProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2020 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.models.tosca.simple.provider;
  22
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.List;
  26
  27 import javax.ws.rs.core.Response;
  28
  29 import lombok.NonNull;
  30
  31 import org.apache.commons.collections4.CollectionUtils;
  32 import org.onap.policy.models.base.PfConcept;
  33 import org.onap.policy.models.base.PfConceptFilter;
  34 import org.onap.policy.models.base.PfConceptKey;
  35 import org.onap.policy.models.base.PfKey;
  36 import org.onap.policy.models.base.PfModelException;
  37 import org.onap.policy.models.base.PfModelRuntimeException;
  38 import org.onap.policy.models.base.PfValidationResult;
  39 import org.onap.policy.models.dao.PfDao;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
  41 import org.onap.policy.models.tosca.simple.concepts.JpaToscaDataType;
  42 import org.onap.policy.models.tosca.simple.concepts.JpaToscaDataTypes;
  43 import org.onap.policy.models.tosca.simple.concepts.JpaToscaEntityType;
  44 import org.onap.policy.models.tosca.simple.concepts.JpaToscaPolicies;
  45 import org.onap.policy.models.tosca.simple.concepts.JpaToscaPolicy;
  46 import org.onap.policy.models.tosca.simple.concepts.JpaToscaPolicyType;
  47 import org.onap.policy.models.tosca.simple.concepts.JpaToscaPolicyTypes;
  48 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  49 import org.onap.policy.models.tosca.simple.concepts.JpaToscaTopologyTemplate;
  50 import org.onap.policy.models.tosca.utils.ToscaServiceTemplateUtils;
  51 import org.onap.policy.models.tosca.utils.ToscaUtils;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 /**
  56  * This class provides the provision of information on TOSCA concepts in the database to callers.
  57  *
  58  * @author Liam Fallon (liam.fallon@est.tech)
  59  */
  60 public class SimpleToscaProvider {
  61     private static final Logger LOGGER = LoggerFactory.getLogger(SimpleToscaProvider.class);
  62
  63     // Recurring string constants
  64     private static final String DATA_TYPE = "data type ";
  65     private static final String POLICY_TYPE = "policy type ";
  66     private static final String SERVICE_TEMPLATE_NOT_FOUND_IN_DATABASE = "service template not found in database";
  67     private static final String DO_NOT_EXIST = " do not exist";
  68     private static final String NOT_FOUND = " not found";
  69
  70     /**
  71      * Get Service Template.
  72      *
  73      * @param dao the DAO to use to access the database
  74      * @return the service template
  75      * @throws PfModelException on errors getting the service template
  76      */
  77     public JpaToscaServiceTemplate getServiceTemplate(@NonNull final PfDao dao) throws PfModelException {
  78         LOGGER.debug("->getServiceTemplate");
  79
  80         JpaToscaServiceTemplate serviceTemplate = new SimpleToscaServiceTemplateProvider().read(dao);
  81         if (serviceTemplate == null) {
  82             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, SERVICE_TEMPLATE_NOT_FOUND_IN_DATABASE);
  83         }
  84
  85         LOGGER.debug("<-getServiceTemplate: serviceTemplate={}", serviceTemplate);
  86         return serviceTemplate;
  87     }
  88
  89     /**
  90      * Append a service template fragment to the service template in the database.
  91      *
  92      * @param dao the DAO to use to access the database
  93      * @param incomingServiceTemplateFragment the service template containing the definition of the entities to be
  94      *        created
  95      * @return the TOSCA service template in the database after the operation
  96      * @throws PfModelException on errors appending a service template to the template in the database
  97      */
  98     public JpaToscaServiceTemplate appendToServiceTemplate(@NonNull final PfDao dao,
  99         @NonNull final JpaToscaServiceTemplate incomingServiceTemplateFragment) throws PfModelException {
 100         LOGGER.debug("->appendServiceTemplateFragment: incomingServiceTemplateFragment={}",
 101             incomingServiceTemplateFragment);
 102
 103         JpaToscaServiceTemplate dbServiceTemplate = new SimpleToscaServiceTemplateProvider().read(dao);
 104
 105         JpaToscaServiceTemplate serviceTemplateToWrite;
 106         if (dbServiceTemplate == null) {
 107             serviceTemplateToWrite = incomingServiceTemplateFragment;
 108         } else {
 109             serviceTemplateToWrite =
 110                 ToscaServiceTemplateUtils.addFragment(dbServiceTemplate, incomingServiceTemplateFragment);
 111         }
 112
 113         PfValidationResult result = serviceTemplateToWrite.validate(new PfValidationResult());
 114         if (!result.isValid()) {
 115             throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, result.toString());
 116         }
 117
 118         new SimpleToscaServiceTemplateProvider().write(dao, serviceTemplateToWrite);
 119
 120         LOGGER.debug("<-appendServiceTemplateFragment: returnServiceTempalate={}", serviceTemplateToWrite);
 121         return serviceTemplateToWrite;
 122     }
 123
 124     /**
 125      * Get data types.
 126      *
 127      * @param dao the DAO to use to access the database
 128      * @param name the name of the data type to get, set to null to get all policy types
 129      * @param version the version of the data type to get, set to null to get all versions
 130      * @return the data types found
 131      * @throws PfModelException on errors getting data types
 132      */
 133     public JpaToscaServiceTemplate getDataTypes(@NonNull final PfDao dao, final String name, final String version)
 134         throws PfModelException {
 135         LOGGER.debug("->getDataTypes: name={}, version={}", name, version);
 136
 137         final JpaToscaServiceTemplate dbServiceTemplate = getServiceTemplate(dao);
 138
 139         if (!ToscaUtils.doDataTypesExist(dbServiceTemplate)) {
 140             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 141                 "data types for " + name + ":" + version + DO_NOT_EXIST);
 142         }
 143
 144         JpaToscaServiceTemplate serviceTemplate = getCascadedDataTypes(dbServiceTemplate, name, version);
 145
 146         LOGGER.debug("<-getDataTypes: name={}, version={}, serviceTemplate={}", name, version, serviceTemplate);
 147         return serviceTemplate;
 148     }
 149
 150     /**
 151      * Get the cascaded data types for a data type name and version.
 152      *
 153      * @param dbServiceTemplate the service template to search for the cascaded data types
 154      * @param name the data type name we are searching for
 155      * @param version the data type version we are searching for
 156      * @return a service template containing the cascaded data types
 157      * @throws PfModelException on errors getting the data types
 158      */
 159     public JpaToscaServiceTemplate getCascadedDataTypes(@NonNull final JpaToscaServiceTemplate dbServiceTemplate,
 160         final String name, final String version) throws PfModelException {
 161
 162         JpaToscaServiceTemplate serviceTemplate = new JpaToscaServiceTemplate(dbServiceTemplate);
 163         serviceTemplate.setPolicyTypes(null);
 164         serviceTemplate.setTopologyTemplate(null);
 165
 166         ToscaUtils.getEntityTree(serviceTemplate.getDataTypes(), name, version);
 167
 168         if (!ToscaUtils.doDataTypesExist(serviceTemplate)) {
 169             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 170                 "data types for " + name + ":" + version + DO_NOT_EXIST);
 171         }
 172
 173         for (JpaToscaDataType dataType : serviceTemplate.getDataTypes().getConceptMap().values()) {
 174             Collection<PfConceptKey> referencedDataTypeKeys = dataType.getReferencedDataTypes();
 175
 176             for (PfConceptKey referencedDataTypeKey : referencedDataTypeKeys) {
 177                 JpaToscaServiceTemplate dataTypeEntityTreeServiceTemplate = getCascadedDataTypes(dbServiceTemplate,
 178                     referencedDataTypeKey.getName(), referencedDataTypeKey.getVersion());
 179
 180                 serviceTemplate =
 181                     ToscaServiceTemplateUtils.addFragment(serviceTemplate, dataTypeEntityTreeServiceTemplate);
 182             }
 183         }
 184         return serviceTemplate;
 185     }
 186
 187     /**
 188      * Create data types.
 189      *
 190      * @param dao the DAO to use to access the database
 191      * @param incomingServiceTemplate the service template containing the definition of the data types to be created
 192      * @return the TOSCA service template containing the created data types
 193      * @throws PfModelException on errors creating data types
 194      */
 195     public JpaToscaServiceTemplate createDataTypes(@NonNull final PfDao dao,
 196         @NonNull final JpaToscaServiceTemplate incomingServiceTemplate) throws PfModelException {
 197         LOGGER.debug("->createDataTypes: incomingServiceTemplate={}", incomingServiceTemplate);
 198
 199         ToscaUtils.assertDataTypesExist(incomingServiceTemplate);
 200
 201         JpaToscaServiceTemplate writtenServiceTemplate = appendToServiceTemplate(dao, incomingServiceTemplate);
 202
 203         LOGGER.debug("<-createDataTypes: writtenServiceTemplate={}", writtenServiceTemplate);
 204         return incomingServiceTemplate;
 205     }
 206
 207     /**
 208      * Update Data types.
 209      *
 210      * @param dao the DAO to use to access the database
 211      * @param serviceTemplate the service template containing the definition of the data types to be modified
 212      * @return the TOSCA service template containing the modified data types
 213      * @throws PfModelException on errors updating Data types
 214      */
 215     public JpaToscaServiceTemplate updateDataTypes(@NonNull final PfDao dao,
 216         @NonNull final JpaToscaServiceTemplate serviceTemplate) throws PfModelException {
 217         LOGGER.debug("->updateDataTypes: serviceTempalate={}", serviceTemplate);
 218
 219         ToscaUtils.assertDataTypesExist(serviceTemplate);
 220
 221         for (JpaToscaDataType dataType : serviceTemplate.getDataTypes().getAll(null)) {
 222             dao.update(dataType);
 223         }
 224
 225         // Return the created data types
 226         JpaToscaDataTypes returnDataTypes = new JpaToscaDataTypes();
 227
 228         for (PfConceptKey dataTypeKey : serviceTemplate.getDataTypes().getConceptMap().keySet()) {
 229             returnDataTypes.getConceptMap().put(dataTypeKey, dao.get(JpaToscaDataType.class, dataTypeKey));
 230         }
 231
 232         JpaToscaServiceTemplate returnServiceTemplate = new JpaToscaServiceTemplate();
 233         returnServiceTemplate.setDataTypes(returnDataTypes);
 234
 235         LOGGER.debug("<-updateDataTypes: returnServiceTempalate={}", returnServiceTemplate);
 236         return returnServiceTemplate;
 237     }
 238
 239     /**
 240      * Delete Data types.
 241      *
 242      * @param dao the DAO to use to access the database
 243      * @param dataTypeKey the data type key for the Data types to be deleted, if the version of the key is null, all
 244      *        versions of the data type are deleted.
 245      * @return the TOSCA service template containing the data types that were deleted
 246      * @throws PfModelException on errors deleting data types
 247      */
 248     public JpaToscaServiceTemplate deleteDataType(@NonNull final PfDao dao, @NonNull final PfConceptKey dataTypeKey)
 249         throws PfModelException {
 250         LOGGER.debug("->deleteDataType: key={}", dataTypeKey);
 251
 252         JpaToscaServiceTemplate serviceTemplate = getServiceTemplate(dao);
 253
 254         if (!ToscaUtils.doDataTypesExist(serviceTemplate)) {
 255             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, "no data types found");
 256         }
 257
 258         JpaToscaDataType dataType4Deletion = serviceTemplate.getDataTypes().get(dataTypeKey);
 259         if (dataType4Deletion == null) {
 260             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, DATA_TYPE + dataTypeKey.getId() + NOT_FOUND);
 261         }
 262
 263         for (JpaToscaDataType dataType : serviceTemplate.getDataTypes().getAll(null)) {
 264             if (dataType.getReferencedDataTypes().contains(dataTypeKey)) {
 265                 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
 266                     DATA_TYPE + dataTypeKey.getId() + " is in use, it is referenced in data type " + dataType.getId());
 267             }
 268         }
 269
 270         if (ToscaUtils.doPolicyTypesExist(serviceTemplate)) {
 271             for (JpaToscaPolicyType policyType : serviceTemplate.getPolicyTypes().getAll(null)) {
 272                 if (policyType.getReferencedDataTypes().contains(dataTypeKey)) {
 273                     throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, DATA_TYPE + dataTypeKey.getId()
 274                         + " is in use, it is referenced in policy type " + policyType.getId());
 275                 }
 276             }
 277         }
 278
 279         dao.delete(JpaToscaDataType.class, dataTypeKey);
 280
 281         LOGGER.debug("<-deleteDataType: key={}, serviceTempalate={}", dataTypeKey, serviceTemplate);
 282         return serviceTemplate;
 283     }
 284
 285     /**
 286      * Get policy types.
 287      *
 288      * @param dao the DAO to use to access the database
 289      * @param name the name of the policy type to get, set to null to get all policy types
 290      * @param version the version of the policy type to get, set to null to get all versions
 291      * @return the policy types found
 292      * @throws PfModelException on errors getting policy types
 293      */
 294     public JpaToscaServiceTemplate getPolicyTypes(@NonNull final PfDao dao, final String name, final String version)
 295         throws PfModelException {
 296         LOGGER.debug("->getPolicyTypes: name={}, version={}", name, version);
 297
 298         final JpaToscaServiceTemplate dbServiceTemplate = getServiceTemplate(dao);
 299
 300         if (!ToscaUtils.doPolicyTypesExist(dbServiceTemplate)) {
 301             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 302                 "policy types for " + name + ":" + version + DO_NOT_EXIST);
 303         }
 304
 305         JpaToscaServiceTemplate serviceTemplate = getCascadedPolicyTypes(dbServiceTemplate, name, version);
 306
 307         LOGGER.debug("<-getPolicyTypes: name={}, version={}, serviceTemplate={}", name, version, serviceTemplate);
 308         return serviceTemplate;
 309     }
 310
 311     /**
 312      * Get the cascaded policy types for a policy type name and version.
 313      *
 314      * @param dbServiceTemplate the service template to search for the cascaded policy types
 315      * @param name the policy type name we are searching for
 316      * @param version the policy type version we are searching for
 317      * @return a service template containing the cascaded policy types
 318      * @throws PfModelException on errors getting the policy types
 319      */
 320     public JpaToscaServiceTemplate getCascadedPolicyTypes(final JpaToscaServiceTemplate dbServiceTemplate,
 321         final String name, final String version) throws PfModelException {
 322
 323         JpaToscaServiceTemplate serviceTemplate = new JpaToscaServiceTemplate(dbServiceTemplate);
 324
 325         serviceTemplate.setDataTypes(null);
 326         serviceTemplate.setTopologyTemplate(null);
 327
 328         ToscaUtils.getEntityTree(serviceTemplate.getPolicyTypes(), name, version);
 329
 330         if (!ToscaUtils.doPolicyTypesExist(serviceTemplate)) {
 331             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 332                 "policy types for " + name + ":" + version + DO_NOT_EXIST);
 333         }
 334
 335         JpaToscaServiceTemplate dataTypeServiceTemplate = new JpaToscaServiceTemplate(serviceTemplate);
 336         dataTypeServiceTemplate.setPolicyTypes(null);
 337
 338         for (JpaToscaPolicyType policyType : serviceTemplate.getPolicyTypes().getConceptMap().values()) {
 339             Collection<PfConceptKey> referencedDataTypeKeys = policyType.getReferencedDataTypes();
 340
 341             for (PfConceptKey referencedDataTypeKey : referencedDataTypeKeys) {
 342                 JpaToscaServiceTemplate dataTypeEntityTreeServiceTemplate = getCascadedDataTypes(dbServiceTemplate,
 343                     referencedDataTypeKey.getName(), referencedDataTypeKey.getVersion());
 344
 345                 dataTypeServiceTemplate =
 346                     ToscaServiceTemplateUtils.addFragment(dataTypeServiceTemplate, dataTypeEntityTreeServiceTemplate);
 347             }
 348         }
 349
 350         serviceTemplate = ToscaServiceTemplateUtils.addFragment(serviceTemplate, dataTypeServiceTemplate);
 351         return serviceTemplate;
 352     }
 353
 354     /**
 355      * Create policy types.
 356      *
 357      * @param dao the DAO to use to access the database
 358      * @param incomingServiceTemplate the service template containing the definition of the policy types to be created
 359      * @return the TOSCA service template containing the created policy types
 360      * @throws PfModelException on errors creating policy types
 361      */
 362     public JpaToscaServiceTemplate createPolicyTypes(@NonNull final PfDao dao,
 363         @NonNull final JpaToscaServiceTemplate incomingServiceTemplate) throws PfModelException {
 364         LOGGER.debug("->createPolicyTypes: serviceTempalate={}", incomingServiceTemplate);
 365
 366         ToscaUtils.assertPolicyTypesExist(incomingServiceTemplate);
 367
 368         JpaToscaServiceTemplate writtenServiceTemplate = appendToServiceTemplate(dao, incomingServiceTemplate);
 369
 370         LOGGER.debug("<-createPolicyTypes: writtenServiceTemplate={}", writtenServiceTemplate);
 371         return incomingServiceTemplate;
 372     }
 373
 374     /**
 375      * Update policy types.
 376      *
 377      * @param dao the DAO to use to access the database
 378      * @param serviceTemplate the service template containing the definition of the policy types to be modified
 379      * @return the TOSCA service template containing the modified policy types
 380      * @throws PfModelException on errors updating policy types
 381      */
 382     public JpaToscaServiceTemplate updatePolicyTypes(@NonNull final PfDao dao,
 383         @NonNull final JpaToscaServiceTemplate serviceTemplate) throws PfModelException {
 384         LOGGER.debug("->updatePolicyTypes: serviceTempalate={}", serviceTemplate);
 385
 386         ToscaUtils.assertPolicyTypesExist(serviceTemplate);
 387
 388         // Update the data types on the policy type
 389         if (ToscaUtils.doDataTypesExist(serviceTemplate)) {
 390             updateDataTypes(dao, serviceTemplate);
 391         }
 392
 393         for (JpaToscaPolicyType policyType : serviceTemplate.getPolicyTypes().getAll(null)) {
 394             dao.update(policyType);
 395         }
 396
 397         // Return the created policy types
 398         JpaToscaPolicyTypes returnPolicyTypes = new JpaToscaPolicyTypes();
 399
 400         for (PfConceptKey policyTypeKey : serviceTemplate.getPolicyTypes().getConceptMap().keySet()) {
 401             returnPolicyTypes.getConceptMap().put(policyTypeKey, dao.get(JpaToscaPolicyType.class, policyTypeKey));
 402         }
 403
 404         JpaToscaServiceTemplate returnServiceTemplate = new JpaToscaServiceTemplate();
 405         returnServiceTemplate.setPolicyTypes(returnPolicyTypes);
 406
 407         LOGGER.debug("<-updatePolicyTypes: returnServiceTempalate={}", returnServiceTemplate);
 408         return returnServiceTemplate;
 409     }
 410
 411     /**
 412      * Delete policy types.
 413      *
 414      * @param dao the DAO to use to access the database
 415      * @param policyTypeKey the policy type key for the policy types to be deleted, if the version of the key is null,
 416      *        all versions of the policy type are deleted.
 417      * @return the TOSCA service template containing the policy types that were deleted
 418      * @throws PfModelException on errors deleting policy types
 419      */
 420     public JpaToscaServiceTemplate deletePolicyType(@NonNull final PfDao dao, @NonNull final PfConceptKey policyTypeKey)
 421         throws PfModelException {
 422         LOGGER.debug("->deletePolicyType: key={}", policyTypeKey);
 423
 424         JpaToscaServiceTemplate serviceTemplate = getServiceTemplate(dao);
 425
 426         if (!ToscaUtils.doPolicyTypesExist(serviceTemplate)) {
 427             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, "no policy types found");
 428         }
 429
 430         JpaToscaEntityType<? extends ToscaEntity> policyType4Deletion =
 431             serviceTemplate.getPolicyTypes().get(policyTypeKey);
 432         if (policyType4Deletion == null) {
 433             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 434                 POLICY_TYPE + policyTypeKey.getId() + NOT_FOUND);
 435         }
 436
 437         for (JpaToscaPolicyType policyType : serviceTemplate.getPolicyTypes().getAll(null)) {
 438             Collection<JpaToscaEntityType<ToscaEntity>> ancestorList = ToscaUtils
 439                 .getEntityTypeAncestors(serviceTemplate.getPolicyTypes(), policyType, new PfValidationResult());
 440
 441             if (ancestorList.contains(policyType4Deletion)) {
 442                 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, POLICY_TYPE + policyTypeKey.getId()
 443                     + " is in use, it is referenced in policy type " + policyType.getId());
 444             }
 445         }
 446
 447         if (ToscaUtils.doPoliciesExist(serviceTemplate)) {
 448             for (JpaToscaPolicy policy : serviceTemplate.getTopologyTemplate().getPolicies().getAll(null)) {
 449                 if (policyTypeKey.equals(policy.getType())) {
 450                     throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, POLICY_TYPE
 451                         + policyTypeKey.getId() + " is in use, it is referenced in policy " + policy.getId());
 452                 }
 453             }
 454         }
 455
 456         dao.delete(JpaToscaPolicyType.class, policyTypeKey);
 457
 458         JpaToscaServiceTemplate deletedServiceTemplate = new JpaToscaServiceTemplate();
 459         deletedServiceTemplate.setPolicyTypes(new JpaToscaPolicyTypes());
 460         deletedServiceTemplate.getPolicyTypes().getConceptMap().put(policyTypeKey,
 461             serviceTemplate.getPolicyTypes().getConceptMap().get(policyTypeKey));
 462
 463         LOGGER.debug("<-deletePolicyType: key={}, serviceTempalate={}", policyTypeKey, deletedServiceTemplate);
 464         return deletedServiceTemplate;
 465     }
 466
 467     /**
 468      * Get policies.
 469      *
 470      * @param dao the DAO to use to access the database
 471      * @param name the name of the policy to get, set to null to get all policy types
 472      * @param version the version of the policy to get, set to null to get all versions
 473      * @return the policies found
 474      * @throws PfModelException on errors getting policies
 475      */
 476     public JpaToscaServiceTemplate getPolicies(@NonNull final PfDao dao, final String name, final String version)
 477         throws PfModelException {
 478         LOGGER.debug("->getPolicies: name={}, version={}", name, version);
 479
 480         JpaToscaServiceTemplate dbServiceTemplate = getServiceTemplate(dao);
 481
 482         if (!ToscaUtils.doPoliciesExist(dbServiceTemplate)) {
 483             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 484                 "policies for " + name + ":" + version + DO_NOT_EXIST);
 485         }
 486
 487         JpaToscaServiceTemplate returnServiceTemplate = getCascadedPolicies(dbServiceTemplate, name, version);
 488
 489         LOGGER.debug("<-getPolicies: name={}, version={}, serviceTemplate={}", name, version, returnServiceTemplate);
 490         return returnServiceTemplate;
 491     }
 492
 493     /**
 494      * Get the cascaded policies for a policy name and version.
 495      *
 496      * @param dbServiceTemplate the service template to search for the cascaded policy
 497      * @param name the policy name we are searching for
 498      * @param version the policy version we are searching for
 499      * @return a service template containing the cascaded policy
 500      * @throws PfModelException on errors getting the policy
 501      */
 502     public JpaToscaServiceTemplate getCascadedPolicies(final JpaToscaServiceTemplate dbServiceTemplate,
 503         final String name, final String version) throws PfModelException {
 504
 505         JpaToscaServiceTemplate serviceTemplate = new JpaToscaServiceTemplate(dbServiceTemplate);
 506         serviceTemplate.setDataTypes(new JpaToscaDataTypes());
 507         serviceTemplate.setPolicyTypes(new JpaToscaPolicyTypes());
 508
 509         ToscaUtils.getEntityTree(serviceTemplate.getTopologyTemplate().getPolicies(), name, version);
 510
 511         if (!ToscaUtils.doPoliciesExist(serviceTemplate)) {
 512             throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
 513                 "policies for " + name + ":" + version + DO_NOT_EXIST);
 514         }
 515
 516         JpaToscaServiceTemplate returnServiceTemplate = new JpaToscaServiceTemplate(serviceTemplate);
 517         returnServiceTemplate.getTopologyTemplate().setPolicies(new JpaToscaPolicies());
 518
 519         for (JpaToscaPolicy policy : serviceTemplate.getTopologyTemplate().getPolicies().getConceptMap().values()) {
 520             JpaToscaServiceTemplate referencedEntitiesServiceTemplate =
 521                 getCascadedPolicyTypes(dbServiceTemplate, policy.getType().getName(), policy.getType().getVersion());
 522
 523             returnServiceTemplate.getTopologyTemplate().getPolicies().getConceptMap().put(policy.getKey(), policy);
 524             returnServiceTemplate =
 525                 ToscaServiceTemplateUtils.addFragment(returnServiceTemplate, referencedEntitiesServiceTemplate);
 526         }
 527
 528         return returnServiceTemplate;
 529     }
 530
 531     /**
 532      * Create policies.
 533      *
 534      * @param dao the DAO to use to access the database
 535      * @param incomingServiceTemplate the service template containing the definitions of the new policies to be created.
 536      * @return the TOSCA service template containing the policy types that were created
 537      * @throws PfModelException on errors creating policies
 538      */
 539     public JpaToscaServiceTemplate createPolicies(@NonNull final PfDao dao,
 540         @NonNull final JpaToscaServiceTemplate incomingServiceTemplate) throws PfModelException {
 541         LOGGER.debug("->createPolicies: incomingServiceTemplate={}", incomingServiceTemplate);
 542
 543         ToscaUtils.assertPoliciesExist(incomingServiceTemplate);
 544
 545         JpaToscaServiceTemplate writtenServiceTemplate = appendToServiceTemplate(dao, incomingServiceTemplate);
 546
 547         LOGGER.debug("<-createPolicies: writtenServiceTemplate={}", writtenServiceTemplate);
 548         return incomingServiceTemplate;
 549     }
 550
 551     /**
 552      * Update policies.
 553      *
 554      * @param dao the DAO to use to access the database
 555      * @param serviceTemplate the service template containing the definitions of the policies to be updated.
 556      * @return the TOSCA service template containing the policies that were updated
 557      * @throws PfModelException on errors updating policies
 558      */
 559     public JpaToscaServiceTemplate updatePolicies(@NonNull final PfDao dao,
 560         @NonNull final JpaToscaServiceTemplate serviceTemplate) throws PfModelException {
 561         LOGGER.debug("->updatePolicies: serviceTempalate={}", serviceTemplate);
 562
 563         ToscaUtils.assertPoliciesExist(serviceTemplate);
 564
 565         for (JpaToscaPolicy policy : serviceTemplate.getTopologyTemplate().getPolicies().getAll(null)) {
 566             verifyPolicyTypeForPolicy(dao, policy);
 567             dao.update(policy);
 568         }
 569
 570         // Return the created policy types
 571         JpaToscaPolicies returnPolicies = new JpaToscaPolicies();
 572         returnPolicies.setKey(serviceTemplate.getTopologyTemplate().getPolicies().getKey());
 573
 574         for (PfConceptKey policyKey : serviceTemplate.getTopologyTemplate().getPolicies().getConceptMap().keySet()) {
 575             returnPolicies.getConceptMap().put(policyKey, dao.get(JpaToscaPolicy.class, policyKey));
 576         }
 577
 578         serviceTemplate.getTopologyTemplate().setPolicies(returnPolicies);
 579
 580         LOGGER.debug("<-updatePolicies: serviceTemplate={}", serviceTemplate);
 581         return serviceTemplate;
 582     }
 583
 584     /**
 585      * Delete policies.
 586      *
 587      * @param dao the DAO to use to access the database
 588      * @param policyKey the policy key
 589      * @return the TOSCA service template containing the policies that were deleted
 590      * @throws PfModelException on errors deleting policies
 591      */
 592     public JpaToscaServiceTemplate deletePolicy(@NonNull final PfDao dao, @NonNull final PfConceptKey policyKey)
 593         throws PfModelException {
 594         LOGGER.debug("->deletePolicy: key={}", policyKey);
 595
 596         JpaToscaServiceTemplate serviceTemplate = getServiceTemplate(dao);
 597
 598         if (!ToscaUtils.doPoliciesExist(serviceTemplate)) {
 599             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, "no policies found");
 600         }
 601
 602         JpaToscaPolicy policy4Deletion = serviceTemplate.getTopologyTemplate().getPolicies().get(policyKey);
 603         if (policy4Deletion == null) {
 604             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, "policy " + policyKey.getId() + NOT_FOUND);
 605         }
 606
 607         dao.delete(JpaToscaPolicy.class, policyKey);
 608
 609         JpaToscaServiceTemplate deletedServiceTemplate = new JpaToscaServiceTemplate();
 610         deletedServiceTemplate.setTopologyTemplate(new JpaToscaTopologyTemplate());
 611         deletedServiceTemplate.getTopologyTemplate().setPolicies(new JpaToscaPolicies());
 612         deletedServiceTemplate.getTopologyTemplate().getPolicies().getConceptMap().put(policyKey,
 613             serviceTemplate.getTopologyTemplate().getPolicies().getConceptMap().get(policyKey));
 614
 615         LOGGER.debug("<-deletePolicy: key={}, serviceTempalate={}", policyKey, deletedServiceTemplate);
 616         return deletedServiceTemplate;
 617     }
 618
 619     /**
 620      * Verify the policy type for a policy exists.
 621      *
 622      * @param dao the DAO to use to access policy types in the database
 623      * @param policy the policy to check the policy type for
 624      */
 625     private void verifyPolicyTypeForPolicy(final PfDao dao, final JpaToscaPolicy policy) {
 626         PfConceptKey policyTypeKey = policy.getType();
 627
 628         JpaToscaPolicyType policyType = null;
 629
 630         if (PfKey.NULL_KEY_VERSION.equals(policyTypeKey.getVersion())) {
 631             policyType = getLatestPolicyTypeVersion(dao, policyTypeKey.getName());
 632
 633             if (policyType != null) {
 634                 policy.getType().setVersion(policyType.getKey().getVersion());
 635             }
 636         } else {
 637             policyType = dao.get(JpaToscaPolicyType.class, policyTypeKey);
 638         }
 639
 640         if (policyType == null) {
 641             String errorMessage =
 642                 POLICY_TYPE + policyTypeKey.getId() + " for policy " + policy.getId() + " does not exist";
 643             throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, errorMessage);
 644         }
 645     }
 646
 647     /**
 648      * Get the latest version of the policy type for the given policy type name.
 649      *
 650      * @param dao the DAO to use to access policy types in the database
 651      * @param policyTypeName the name of the policy type
 652      * @return the latest policy type
 653      */
 654     private JpaToscaPolicyType getLatestPolicyTypeVersion(final PfDao dao, final String policyTypeName) {
 655         // Policy type version is not specified, get the latest version from the database
 656         List<JpaToscaPolicyType> jpaPolicyTypeList = dao.getFiltered(JpaToscaPolicyType.class, policyTypeName, null);
 657
 658         if (CollectionUtils.isEmpty(jpaPolicyTypeList)) {
 659             return null;
 660         }
 661
 662         // Create a filter to get the latest version of the policy type
 663         PfConceptFilter pfConceptFilter = PfConceptFilter.builder().version(PfConceptFilter.LATEST_VERSION).build();
 664
 665         // FIlter the returned policy type list
 666         List<PfConcept> policyTypeKeyList = new ArrayList<>(jpaPolicyTypeList);
 667         List<PfConcept> filterdPolicyTypeList = pfConceptFilter.filter(policyTypeKeyList);
 668
 669         // We should have one and only one returned entry
 670         if (filterdPolicyTypeList.size() != 1) {
 671             String errorMessage = "search for latest policy type " + policyTypeName + " returned more than one entry";
 672             throw new PfModelRuntimeException(Response.Status.CONFLICT, errorMessage);
 673         }
 674
 675         return (JpaToscaPolicyType) filterdPolicyTypeList.get(0);
 676     }
 677 }