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