models-dao/src/main/java/org/onap/policy/models/dao/PfDaoFactory.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.dao;
  22
  23 import org.onap.policy.common.utils.validation.Assertions;
  24 import org.onap.policy.models.base.PfModelException;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * This factory class returns a Policy Framework DAO for the configured persistence mechanism. The
  30  * factory uses the plugin class specified in {@link DaoParameters} to instantiate a DAO instance.
  31  */
  32 public class PfDaoFactory {
  33     // Get a reference to the logger
  34     private static final Logger LOGGER = LoggerFactory.getLogger(PfDaoFactory.class);
  35
  36     /**
  37      * Return a Policy Framework DAO for the required Policy Framework DAO plugin class.
  38      *
  39      * @param daoParameters parameters to use to read the database configuration information
  40      * @return the Policy Framework DAO
  41      * @throws PfModelException on invalid JPA plugins
  42      */
  43     public PfDao createPfDao(final DaoParameters daoParameters) throws PfModelException {
  44         Assertions.argumentOfClassNotNull(daoParameters, PfModelException.class,
  45                 "Parameter \"daoParameters\" may not be null");
  46
  47         // Get the class for the DAO using reflection
  48         Object pfDaoObject = null;
  49         try {
  50             pfDaoObject = Class.forName(daoParameters.getPluginClass()).newInstance();
  51         } catch (InstantiationException | IllegalAccessException | ClassNotFoundException e) {
  52             String errorMessage =
  53                     "Policy Framework DAO class not found for DAO plugin \"" + daoParameters.getPluginClass() + "\"";
  54             LOGGER.error(errorMessage, e);
  55             throw new PfModelException(errorMessage, e);
  56         }
  57
  58         // Check the class is a Policy Framework DAO
  59         if (!(pfDaoObject instanceof PfDao)) {
  60             String errorMessage = "Specified DAO plugin class \"" + daoParameters.getPluginClass()
  61                     + "\" does not implement the PfDao interface";
  62             LOGGER.error(errorMessage);
  63             throw new PfModelException(errorMessage);
  64         }
  65
  66         return (PfDao) pfDaoObject;
  67     }
  68 }