main/src/main/java/org/onap/policy/api/main/startstop/ApiDatabaseInitializer.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy API
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019-2020 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.api.main.startstop;
  25
  26 import java.util.LinkedHashMap;
  27 import java.util.LinkedList;
  28 import java.util.List;
  29 import org.onap.policy.api.main.exception.PolicyApiException;
  30 import org.onap.policy.api.main.parameters.ApiParameterGroup;
  31 import org.onap.policy.common.utils.coder.CoderException;
  32 import org.onap.policy.common.utils.coder.StandardYamlCoder;
  33 import org.onap.policy.common.utils.resources.ResourceUtils;
  34 import org.onap.policy.models.base.PfModelException;
  35 import org.onap.policy.models.base.PfModelRuntimeException;
  36 import org.onap.policy.models.provider.PolicyModelsProvider;
  37 import org.onap.policy.models.provider.PolicyModelsProviderFactory;
  38 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
  39 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaTopologyTemplate;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * This class creates initial policy types in the database.
  46  *
  47  * @author Chenfei Gao (cgao@research.att.com)
  48  */
  49 public class ApiDatabaseInitializer {
  50
  51     private static final Logger LOGGER = LoggerFactory.getLogger(ApiDatabaseInitializer.class);
  52
  53     private static final StandardYamlCoder coder = new StandardYamlCoder();
  54     private PolicyModelsProviderFactory factory;
  55
  56     /**
  57      * Constructs the object.
  58      */
  59     public ApiDatabaseInitializer() {
  60         factory = new PolicyModelsProviderFactory();
  61     }
  62
  63     /**
  64      * Initializes database by preloading policy types and policies.
  65      *
  66      * @param apiParameterGroup the apiParameterGroup parameters
  67      * @throws PolicyApiException in case of errors.
  68      */
  69     public void initializeApiDatabase(final ApiParameterGroup apiParameterGroup) throws PolicyApiException {
  70
  71         try (PolicyModelsProvider databaseProvider =
  72                 factory.createPolicyModelsProvider(apiParameterGroup.getDatabaseProviderParameters())) {
  73
  74             if (alreadyExists(databaseProvider)) {
  75                 LOGGER.warn("DB already contains policy data - skipping preload");
  76                 return;
  77             }
  78
  79             ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
  80             serviceTemplate.setDataTypes(new LinkedHashMap<>());
  81             serviceTemplate.setPolicyTypes(new LinkedHashMap<>());
  82             serviceTemplate.setToscaDefinitionsVersion("tosca_simple_yaml_1_1_0");
  83
  84             ToscaServiceTemplate createdPolicyTypes = preloadServiceTemplate(serviceTemplate,
  85                     apiParameterGroup.getPreloadPolicyTypes(), databaseProvider::createPolicyTypes);
  86             preloadServiceTemplate(createdPolicyTypes,
  87                     apiParameterGroup.getPreloadPolicies(), databaseProvider::createPolicies);
  88         } catch (final PolicyApiException | PfModelException | CoderException exp) {
  89             throw new PolicyApiException(exp);
  90         }
  91     }
  92
  93     private boolean alreadyExists(PolicyModelsProvider databaseProvider) throws PfModelException {
  94         try {
  95             ToscaServiceTemplate serviceTemplate =
  96                             databaseProvider.getFilteredPolicyTypes(ToscaPolicyTypeFilter.builder().build());
  97             if (!serviceTemplate.getPolicyTypes().isEmpty()) {
  98                 return true;
  99             }
 100
 101         } catch (PfModelRuntimeException e) {
 102             LOGGER.trace("DB does not yet contain policy types", e);
 103         }
 104
 105         return false;
 106     }
 107
 108     private ToscaServiceTemplate preloadServiceTemplate(ToscaServiceTemplate serviceTemplate,
 109             List<String> entities, FunctionWithEx<ToscaServiceTemplate, ToscaServiceTemplate> getter)
 110                     throws PolicyApiException, CoderException, PfModelException {
 111
 112         for (String entity : entities) {
 113             String entityAsStringYaml = ResourceUtils.getResourceAsString(entity);
 114             if (entityAsStringYaml == null) {
 115                 LOGGER.warn("Preloading entity cannot be found: {}", entity);
 116                 continue;
 117             }
 118
 119             ToscaServiceTemplate singleEntity =
 120                     coder.decode(entityAsStringYaml,  ToscaServiceTemplate.class);
 121             if (singleEntity == null) {
 122                 throw new PolicyApiException("Error deserializaing entity from file: " + entity);
 123             }
 124
 125             // Consolidate data types and policy types
 126             if (singleEntity.getDataTypes() != null) {
 127                 serviceTemplate.getDataTypes().putAll(singleEntity.getDataTypes());
 128             }
 129             if (singleEntity.getPolicyTypes() != null) {
 130                 serviceTemplate.getPolicyTypes().putAll(singleEntity.getPolicyTypes());
 131             }
 132
 133             // Consolidate policies
 134             ToscaTopologyTemplate topologyTemplate = singleEntity.getToscaTopologyTemplate();
 135             if (topologyTemplate != null && topologyTemplate.getPolicies() != null) {
 136                 serviceTemplate.setToscaTopologyTemplate(new ToscaTopologyTemplate());
 137                 serviceTemplate.getToscaTopologyTemplate().setPolicies(new LinkedList<>());
 138                 serviceTemplate.getToscaTopologyTemplate().getPolicies()
 139                     .addAll(singleEntity.getToscaTopologyTemplate().getPolicies());
 140             }
 141         }
 142         // Preload the specified entities
 143         ToscaServiceTemplate createdServiceTemplate = getter.apply(serviceTemplate);
 144         LOGGER.debug("Created initial tosca service template in DB - {}", createdServiceTemplate);
 145         return createdServiceTemplate;
 146     }
 147
 148     @FunctionalInterface
 149     protected interface FunctionWithEx<T, R> {
 150         public R apply(T value) throws PfModelException;
 151     }
 152 }