models-provider/src/main/java/org/onap/policy/models/provider/impl/DatabasePolicyModelsProviderImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 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.provider.impl;
  22
  23 import java.util.Base64;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Properties;
  27
  28 import javax.ws.rs.core.Response;
  29
  30 import lombok.NonNull;
  31
  32 import org.eclipse.persistence.config.PersistenceUnitProperties;
  33 import org.onap.policy.models.base.PfModelException;
  34 import org.onap.policy.models.base.PfModelRuntimeException;
  35 import org.onap.policy.models.dao.DaoParameters;
  36 import org.onap.policy.models.dao.PfDao;
  37 import org.onap.policy.models.dao.PfDaoFactory;
  38 import org.onap.policy.models.dao.impl.DefaultPfDao;
  39 import org.onap.policy.models.pdp.concepts.Pdp;
  40 import org.onap.policy.models.pdp.concepts.PdpGroup;
  41 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  42 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  43 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  44 import org.onap.policy.models.pdp.persistence.provider.PdpProvider;
  45 import org.onap.policy.models.provider.PolicyModelsProvider;
  46 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  52 import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider;
  53 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
  54 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
  55 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
  56 import org.onap.policy.models.tosca.legacy.provider.LegacyProvider;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 /**
  61  * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
  62  * a relational database.
  63  *
  64  * @author Liam Fallon (liam.fallon@est.tech)
  65  */
  66 public class DatabasePolicyModelsProviderImpl implements PolicyModelsProvider {
  67
  68     private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
  69
  70     private final PolicyModelsProviderParameters parameters;
  71
  72     // Database connection and the DAO for reading and writing Policy Framework concepts
  73     private PfDao pfDao;
  74
  75     /**
  76      * Constructor that takes the parameters.
  77      *
  78      * @param parameters the parameters for the provider
  79      */
  80     public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
  81         this.parameters = parameters;
  82     }
  83
  84     @Override
  85     public void init() throws PfModelException {
  86         LOGGER.debug("opening the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
  87                 parameters.getPersistenceUnit());
  88
  89         if (pfDao != null) {
  90             String errorMessage = "provider is already initialized";
  91             LOGGER.warn(errorMessage);
  92             throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage);
  93         }
  94
  95         // Parameters for the DAO
  96         final DaoParameters daoParameters = new DaoParameters();
  97         daoParameters.setPluginClass(DefaultPfDao.class.getCanonicalName());
  98         daoParameters.setPersistenceUnit(parameters.getPersistenceUnit());
  99
 100         // Decode the password using Base64
 101         String decodedPassword = new String(Base64.getDecoder().decode(parameters.getDatabasePassword()));
 102
 103         // @formatter:off
 104         Properties jdbcProperties = new Properties();
 105         jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER,   parameters.getDatabaseDriver());
 106         jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL,      parameters.getDatabaseUrl());
 107         jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_USER,     parameters.getDatabaseUser());
 108         jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_PASSWORD, decodedPassword);
 109         // @formatter:on
 110
 111         daoParameters.setJdbcProperties(jdbcProperties);
 112
 113         pfDao = new PfDaoFactory().createPfDao(daoParameters);
 114         try {
 115             pfDao = new PfDaoFactory().createPfDao(daoParameters);
 116             pfDao.init(daoParameters);
 117         } catch (Exception exc) {
 118             String errorMessage = "could not create Data Access Object (DAO) using url \"" + parameters.getDatabaseUrl()
 119                     + "\" and persistence unit \"" + parameters.getPersistenceUnit() + "\"";
 120             LOGGER.warn(errorMessage, exc);
 121
 122             this.close();
 123             throw new PfModelException(Response.Status.NOT_ACCEPTABLE, errorMessage, exc);
 124         }
 125     }
 126
 127     @Override
 128     public void close() throws PfModelException {
 129         LOGGER.debug("closing the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
 130                 parameters.getPersistenceUnit());
 131
 132         if (pfDao != null) {
 133             pfDao.close();
 134             pfDao = null;
 135         }
 136
 137         LOGGER.debug("closed the database connection to {} using persistence unit {}", parameters.getDatabaseUrl(),
 138                 parameters.getPersistenceUnit());
 139     }
 140
 141     @Override
 142     public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
 143         assertInitilized();
 144         return new AuthorativeToscaProvider().getPolicyTypes(pfDao, name, version);
 145     }
 146
 147     @Override
 148     public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
 149         assertInitilized();
 150         return new AuthorativeToscaProvider().getPolicyTypeList(pfDao, name, version);
 151     }
 152
 153     @Override
 154     public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
 155         assertInitilized();
 156         return new AuthorativeToscaProvider().getFilteredPolicyTypes(pfDao, filter);
 157     }
 158
 159     @Override
 160     public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
 161             throws PfModelException {
 162         assertInitilized();
 163         return new AuthorativeToscaProvider().getFilteredPolicyTypeList(pfDao, filter);
 164     }
 165
 166     @Override
 167     public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
 168             throws PfModelException {
 169         assertInitilized();
 170         return new AuthorativeToscaProvider().createPolicyTypes(pfDao, serviceTemplate);
 171     }
 172
 173     @Override
 174     public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
 175             throws PfModelException {
 176         assertInitilized();
 177         return new AuthorativeToscaProvider().updatePolicyTypes(pfDao, serviceTemplate);
 178     }
 179
 180     @Override
 181     public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
 182             throws PfModelException {
 183         assertInitilized();
 184         return new AuthorativeToscaProvider().deletePolicyType(pfDao, name, version);
 185     }
 186
 187     @Override
 188     public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
 189         assertInitilized();
 190         return new AuthorativeToscaProvider().getPolicies(pfDao, name, version);
 191     }
 192
 193     @Override
 194     public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
 195         assertInitilized();
 196         return new AuthorativeToscaProvider().getPolicyList(pfDao, name, version);
 197     }
 198
 199     @Override
 200     public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
 201         assertInitilized();
 202         return new AuthorativeToscaProvider().getFilteredPolicies(pfDao, filter);
 203     }
 204
 205     @Override
 206     public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
 207         assertInitilized();
 208         return new AuthorativeToscaProvider().getFilteredPolicyList(pfDao, filter);
 209     }
 210
 211
 212     @Override
 213     public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
 214             throws PfModelException {
 215         assertInitilized();
 216         return new AuthorativeToscaProvider().createPolicies(pfDao, serviceTemplate);
 217     }
 218
 219     @Override
 220     public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
 221             throws PfModelException {
 222         assertInitilized();
 223         return new AuthorativeToscaProvider().updatePolicies(pfDao, serviceTemplate);
 224     }
 225
 226     @Override
 227     public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
 228             throws PfModelException {
 229         assertInitilized();
 230         return new AuthorativeToscaProvider().deletePolicy(pfDao, name, version);
 231     }
 232
 233     @Override
 234     public LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId) throws PfModelException {
 235         assertInitilized();
 236         return new LegacyProvider().getOperationalPolicy(pfDao, policyId);
 237     }
 238
 239     @Override
 240     public LegacyOperationalPolicy createOperationalPolicy(
 241             @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
 242         assertInitilized();
 243         return new LegacyProvider().createOperationalPolicy(pfDao, legacyOperationalPolicy);
 244     }
 245
 246     @Override
 247     public LegacyOperationalPolicy updateOperationalPolicy(
 248             @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
 249         assertInitilized();
 250         return new LegacyProvider().updateOperationalPolicy(pfDao, legacyOperationalPolicy);
 251     }
 252
 253     @Override
 254     public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId) throws PfModelException {
 255         assertInitilized();
 256         return new LegacyProvider().deleteOperationalPolicy(pfDao, policyId);
 257     }
 258
 259     @Override
 260     public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId) throws PfModelException {
 261         assertInitilized();
 262         return new LegacyProvider().getGuardPolicy(pfDao, policyId);
 263     }
 264
 265     @Override
 266     public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(
 267             @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
 268         assertInitilized();
 269         return new LegacyProvider().createGuardPolicy(pfDao, legacyGuardPolicy);
 270     }
 271
 272     @Override
 273     public Map<String, LegacyGuardPolicyOutput> updateGuardPolicy(
 274             @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
 275         assertInitilized();
 276         return new LegacyProvider().updateGuardPolicy(pfDao, legacyGuardPolicy);
 277     }
 278
 279     @Override
 280     public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId)
 281             throws PfModelException {
 282         assertInitilized();
 283         return new LegacyProvider().deleteGuardPolicy(pfDao, policyId);
 284     }
 285
 286     @Override
 287     public List<PdpGroup> getPdpGroups(final String name, final String version) throws PfModelException {
 288         assertInitilized();
 289         return new PdpProvider().getPdpGroups(pfDao, name, version);
 290     }
 291
 292     @Override
 293     public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
 294         assertInitilized();
 295         return new PdpProvider().getFilteredPdpGroups(pfDao, filter);
 296     }
 297
 298     @Override
 299     public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
 300         assertInitilized();
 301         return new PdpProvider().createPdpGroups(pfDao, pdpGroups);
 302     }
 303
 304     @Override
 305     public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
 306         assertInitilized();
 307         return new PdpProvider().updatePdpGroups(pfDao, pdpGroups);
 308     }
 309
 310     @Override
 311     public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion,
 312             @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException {
 313         assertInitilized();
 314         new PdpProvider().updatePdpSubGroup(pfDao, pdpGroupName, pdpGroupVersion, pdpSubGroup);
 315     }
 316
 317     @Override
 318     public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpGroupVersion, @NonNull String pdpSubGroup,
 319             @NonNull Pdp pdp) throws PfModelException {
 320         new PdpProvider().updatePdp(pfDao, pdpGroupName, pdpGroupVersion, pdpSubGroup, pdp);
 321     }
 322
 323     @Override
 324     public PdpGroup deletePdpGroup(@NonNull final String name, @NonNull final String version) throws PfModelException {
 325         assertInitilized();
 326         return new PdpProvider().deletePdpGroup(pfDao, name, version);
 327     }
 328
 329     @Override
 330     public List<PdpStatistics> getPdpStatistics(final String name, final String version) throws PfModelException {
 331         assertInitilized();
 332         return new PdpProvider().getPdpStatistics(pfDao, name, version);
 333     }
 334
 335     @Override
 336     public void updatePdpStatistics(@NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion,
 337             @NonNull final String pdpType, @NonNull final String pdpInstanceId,
 338             @NonNull final PdpStatistics pdpStatistics) throws PfModelException {
 339         assertInitilized();
 340         new PdpProvider().updatePdpStatistics(pfDao, pdpGroupName, pdpGroupVersion, pdpType, pdpInstanceId,
 341                 pdpStatistics);
 342     }
 343
 344     /**
 345      * Check if the model provider is initialized.
 346      */
 347     private void assertInitilized() {
 348         if (pfDao == null) {
 349             String errorMessage = "policy models provider is not initilaized";
 350             LOGGER.warn(errorMessage);
 351             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
 352         }
 353     }
 354 }