models-dao/src/main/java/org/onap/policy/models/dao/impl/DefaultPfDao.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021, 2023 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
   5  *  Modifications Copyright (C) 2022 Bell Canada. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.models.dao.impl;
  24
  25 import jakarta.persistence.EntityManager;
  26 import jakarta.persistence.EntityManagerFactory;
  27 import jakarta.persistence.Persistence;
  28 import jakarta.persistence.TypedQuery;
  29 import jakarta.ws.rs.core.Response;
  30 import java.util.Collection;
  31 import java.util.Collections;
  32 import java.util.List;
  33 import org.apache.commons.lang3.StringUtils;
  34 import org.onap.policy.models.base.PfConcept;
  35 import org.onap.policy.models.base.PfConceptKey;
  36 import org.onap.policy.models.base.PfModelException;
  37 import org.onap.policy.models.base.PfModelRuntimeException;
  38 import org.onap.policy.models.base.PfReferenceKey;
  39 import org.onap.policy.models.base.PfReferenceTimestampKey;
  40 import org.onap.policy.models.base.PfTimestampKey;
  41 import org.onap.policy.models.base.PfUtils;
  42 import org.onap.policy.models.dao.DaoParameters;
  43 import org.onap.policy.models.dao.PfDao;
  44 import org.onap.policy.models.dao.PfFilter;
  45 import org.onap.policy.models.dao.PfFilterFactory;
  46 import org.onap.policy.models.dao.PfFilterParametersIntfc;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 /**
  51  * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts
  52  * ({@link PfConcept}). It uses the default JPA implementation in the jakarta {@link Persistence} class.
  53  */
  54 public class DefaultPfDao implements PfDao {
  55     private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
  56
  57     // @formatter:off
  58     private static final String NAME           = "name";
  59     private static final String VERSION        = "version";
  60     private static final String TIMESTAMP      = "timeStamp";
  61     private static final String PARENT_NAME    = "parentname";
  62     private static final String PARENT_VERSION = "parentversion";
  63     private static final String LOCAL_NAME     = "localname";
  64
  65     private static final String TABLE_TOKEN = "__TABLE__";
  66
  67     private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c";
  68
  69     private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c";
  70
  71     private static final String WHERE      = " WHERE ";
  72     private static final String AND        = " AND ";
  73     private static final String ORDER_BY        = " ORDER BY c.";
  74
  75     private static final String NAME_FILTER            = "c.key.name = :name";
  76     private static final String VERSION_FILTER         = "c.key.version = :version";
  77     private static final String TIMESTAMP_FILTER       = "c.key.timeStamp = :timeStamp";
  78     private static final String PARENT_NAME_FILTER     = "c.key.parentKeyName = :parentname";
  79     private static final String PARENT_VERSION_FILTER  = "c.key.parentKeyVersion = :parentversion";
  80     private static final String LOCAL_NAME_FILTER      = "c.key.localName = :localname";
  81
  82     private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
  83
  84     private static final String DELETE_BY_CONCEPT_KEY =
  85             DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
  86
  87     private static final String DELETE_BY_TIMESTAMP_KEY =
  88             DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER  + AND + TIMESTAMP_FILTER;
  89
  90     private static final String DELETE_BY_REFERENCE_KEY =
  91             DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
  92
  93     private static final String SELECT_ALL_FOR_PARENT =
  94             SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER;
  95
  96     private static final String SELECT_ALL_VERSIONS_FOR_PARENT =
  97             SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER;
  98
  99     private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
 100
 101     private static final String SELECT_BY_CONCEPT_KEY =
 102             SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
 103
 104     private static final String SELECT_BY_REFERENCE_KEY =
 105             SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
 106     // @formatter:on
 107
 108     // Entity manager for JPA
 109     private EntityManagerFactory emf = null;
 110
 111     @Override
 112     public void init(final DaoParameters daoParameters) throws PfModelException {
 113         if (daoParameters == null || daoParameters.getPersistenceUnit() == null) {
 114             LOGGER.error("Policy Framework persistence unit parameter not set");
 115             throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR,
 116                 "Policy Framework persistence unit parameter not set");
 117         }
 118
 119         LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit());
 120         try {
 121             emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(),
 122                 daoParameters.getJdbcProperties());
 123         } catch (final Exception ex) {
 124             String errorMessage = "Creation of Policy Framework persistence unit \""
 125                 + daoParameters.getPersistenceUnit() + "\" failed";
 126             LOGGER.warn(errorMessage);
 127             throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex);
 128         }
 129         LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit());
 130     }
 131
 132     /**
 133      * Gets the entity manager for this DAO.
 134      *
 135      * @return the entity manager
 136      */
 137     protected final synchronized EntityManager getEntityManager() {
 138         if (emf == null) {
 139             LOGGER.warn("Policy Framework DAO has not been initialized");
 140             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
 141                 "Policy Framework DAO has not been initialized");
 142         }
 143
 144         return emf.createEntityManager();
 145     }
 146
 147     @Override
 148     public final void close() {
 149         if (emf != null) {
 150             emf.close();
 151         }
 152     }
 153
 154     @Override
 155     public <T extends PfConcept> void create(final T obj) {
 156         if (obj == null) {
 157             return;
 158         }
 159         try (var mg = getEntityManager()) {
 160             mg.getTransaction().begin();
 161             mg.merge(obj);
 162             mg.getTransaction().commit();
 163         }
 164     }
 165
 166     @Override
 167     public <T extends PfConcept> void delete(final T obj) {
 168         if (obj == null) {
 169             return;
 170         }
 171         try (var mg = getEntityManager()) {
 172             mg.getTransaction().begin();
 173             mg.remove(mg.contains(obj) ? obj : mg.merge(obj));
 174             mg.getTransaction().commit();
 175         }
 176     }
 177
 178     @Override
 179     public <T extends PfConcept> void delete(final Class<T> someClass, final PfConceptKey key) {
 180         if (key == null) {
 181             return;
 182         }
 183         try (var mg = getEntityManager()) {
 184             // @formatter:off
 185             mg.getTransaction().begin();
 186             mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass))
 187                 .setParameter(NAME,    key.getName())
 188                 .setParameter(VERSION, key.getVersion())
 189                 .executeUpdate();
 190             mg.getTransaction().commit();
 191             // @formatter:on
 192         }
 193     }
 194
 195     @Override
 196     public <T extends PfConcept> void delete(final Class<T> someClass, final PfReferenceKey key) {
 197         if (key == null) {
 198             return;
 199         }
 200         try (var mg = getEntityManager()) {
 201             // @formatter:off
 202             mg.getTransaction().begin();
 203             mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass))
 204                 .setParameter(PARENT_NAME,    key.getParentKeyName())
 205                 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
 206                 .setParameter(LOCAL_NAME,     key.getLocalName())
 207                 .executeUpdate();
 208             mg.getTransaction().commit();
 209             // @formatter:on
 210         }
 211     }
 212
 213     @Override
 214     public <T extends PfConcept> void delete(final Class<T> someClass, final PfTimestampKey key) {
 215         if (key == null) {
 216             return;
 217         }
 218         try (var mg = getEntityManager()) {
 219             // @formatter:off
 220             mg.getTransaction().begin();
 221             mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass))
 222                     .setParameter(NAME,    key.getName())
 223                     .setParameter(VERSION, key.getVersion())
 224                     .setParameter(TIMESTAMP, key.getTimeStamp())
 225                     .executeUpdate();
 226             mg.getTransaction().commit();
 227             // @formatter:on
 228         }
 229     }
 230
 231     @Override
 232     public <T extends PfConcept> void createCollection(final Collection<T> objs) {
 233         if (objs == null || objs.isEmpty()) {
 234             return;
 235         }
 236         try (var mg = getEntityManager()) {
 237             mg.getTransaction().begin();
 238             for (final T t : objs) {
 239                 mg.merge(t);
 240             }
 241             mg.getTransaction().commit();
 242         }
 243     }
 244
 245     @Override
 246     public <T extends PfConcept> void deleteCollection(final Collection<T> objs) {
 247         if (objs == null || objs.isEmpty()) {
 248             return;
 249         }
 250         try (var mg = getEntityManager()) {
 251             mg.getTransaction().begin();
 252             for (final T t : objs) {
 253                 mg.remove(mg.contains(t) ? t : mg.merge(t));
 254             }
 255             mg.getTransaction().commit();
 256         }
 257     }
 258
 259     @Override
 260     public <T extends PfConcept> int deleteByConceptKey(final Class<T> someClass, final Collection<PfConceptKey> keys) {
 261         if (keys == null || keys.isEmpty()) {
 262             return 0;
 263         }
 264         var deletedCount = 0;
 265         try (var mg = getEntityManager()) {
 266             // @formatter:off
 267             mg.getTransaction().begin();
 268             for (final PfConceptKey key : keys) {
 269                 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass))
 270                     .setParameter(NAME,    key.getName())
 271                     .setParameter(VERSION, key.getVersion())
 272                     .executeUpdate();
 273             }
 274             mg.getTransaction().commit();
 275             // @formatter:on
 276         }
 277         return deletedCount;
 278     }
 279
 280     @Override
 281     public <T extends PfConcept> int deleteByReferenceKey(final Class<T> someClass,
 282                                                           final Collection<PfReferenceKey> keys) {
 283         if (keys == null || keys.isEmpty()) {
 284             return 0;
 285         }
 286         var deletedCount = 0;
 287         try (var mg = getEntityManager()) {
 288             // @formatter:off
 289             mg.getTransaction().begin();
 290             for (final PfReferenceKey key : keys) {
 291                 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass))
 292                     .setParameter(PARENT_NAME,    key.getParentKeyName())
 293                     .setParameter(PARENT_VERSION, key.getParentKeyVersion())
 294                     .setParameter(LOCAL_NAME,     key.getLocalName())
 295                     .executeUpdate();
 296             }
 297             mg.getTransaction().commit();
 298             // @formatter:on
 299         }
 300         return deletedCount;
 301     }
 302
 303     @Override
 304     public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
 305         try (var mg = getEntityManager()) {
 306             mg.getTransaction().begin();
 307             mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass)).executeUpdate();
 308             mg.getTransaction().commit();
 309         }
 310     }
 311
 312     @Override
 313     public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name,
 314                                                      final String version) {
 315         if (name == null) {
 316             return getAll(someClass);
 317         }
 318
 319         if (version == null) {
 320             return getAllVersions(someClass, name);
 321         }
 322
 323         var foundConcept = get(someClass, new PfConceptKey(name, version));
 324
 325         return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
 326     }
 327
 328     @Override
 329     public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, PfFilterParametersIntfc filterParams) {
 330
 331         try (var mg = getEntityManager()) {
 332             PfFilter filter = new PfFilterFactory().createFilter(someClass);
 333             var filterQueryString = SELECT_FROM_TABLE
 334                 + filter.genWhereClause(filterParams)
 335                 + filter.genOrderClause(filterParams);
 336
 337             TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
 338             filter.setParams(query, filterParams);
 339
 340             LOGGER.debug("filterQueryString is  \"{}\"", filterQueryString);
 341             return query.getResultList();
 342         }
 343     }
 344
 345     @Override
 346     public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
 347         return genericGet(someClass, key);
 348     }
 349
 350     @Override
 351     public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
 352         return genericGet(someClass, key);
 353     }
 354
 355     @Override
 356     public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
 357         return genericGet(someClass, key);
 358     }
 359
 360     @Override
 361     public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceTimestampKey key) {
 362         return genericGet(someClass, key);
 363     }
 364
 365     private <T extends PfConcept> T genericGet(final Class<T> someClass, final Object key) {
 366         if (someClass == null) {
 367             return null;
 368         }
 369         try (var mg = getEntityManager()) {
 370             final var t = mg.find(someClass, key);
 371             if (t != null) {
 372                 mg.refresh(t);
 373             }
 374             return checkAndReturn(someClass, t);
 375         }
 376     }
 377
 378     @Override
 379     public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
 380         if (someClass == null) {
 381             return Collections.emptyList();
 382         }
 383         try (var mg = getEntityManager()) {
 384             return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
 385         }
 386     }
 387
 388     @Override
 389     public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
 390         if (someClass == null) {
 391             return Collections.emptyList();
 392         }
 393         try (var mg = getEntityManager()) {
 394             // @formatter:off
 395             return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
 396                     .setParameter(PARENT_NAME,    parentKey.getName())
 397                     .setParameter(PARENT_VERSION, parentKey.getVersion())
 398                     .getResultList();
 399             // @formatter:on
 400         }
 401     }
 402
 403     @Override
 404     public <T extends PfConcept> List<T> getAll(Class<T> someClass, String orderBy, Integer numRecords) {
 405
 406         if (someClass == null) {
 407             return Collections.emptyList();
 408         }
 409         try (var mg = getEntityManager()) {
 410             String query = setQueryTable(SELECT_FROM_TABLE, someClass);
 411
 412             if (StringUtils.isNotBlank(orderBy)) {
 413                 query = query.concat(ORDER_BY).concat(orderBy);
 414             }
 415
 416             return mg.createQuery(query, someClass).setMaxResults(numRecords)
 417                 .getResultList();
 418         }
 419     }
 420
 421     @Override
 422     public <T extends PfConcept> List<T> getAllVersionsByParent(final Class<T> someClass, final String parentKeyName) {
 423         if (someClass == null || parentKeyName == null) {
 424             return Collections.emptyList();
 425         }
 426         try (var mg = getEntityManager()) {
 427             // @formatter:off
 428             return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass)
 429                     .setParameter(PARENT_NAME, parentKeyName)
 430                     .getResultList();
 431             // @formatter:on
 432         }
 433     }
 434
 435     @Override
 436     public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
 437         if (someClass == null || conceptName == null) {
 438             return Collections.emptyList();
 439         }
 440         try (var mg = getEntityManager()) {
 441             // @formatter:off
 442             return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
 443                     .setParameter(NAME, conceptName)
 444                     .getResultList();
 445             // @formatter:on
 446         }
 447     }
 448
 449     @Override
 450     public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
 451         if (someClass == null || key == null) {
 452             return null;
 453         }
 454         List<T> ret;
 455         try (var mg = getEntityManager()) {
 456             // @formatter:off
 457             ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass)
 458                     .setParameter(NAME,    key.getName())
 459                     .setParameter(VERSION, key.getVersion())
 460                     .getResultList();
 461             // @formatter:on
 462         }
 463
 464         return getSingleResult(someClass, key.getId(), ret);
 465     }
 466
 467     @Override
 468     public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfReferenceKey key) {
 469         if (someClass == null || key == null) {
 470             return null;
 471         }
 472         List<T> ret;
 473         try (var mg = getEntityManager()) {
 474             // @formatter:off
 475             ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass)
 476                     .setParameter(PARENT_NAME,    key.getParentKeyName())
 477                     .setParameter(PARENT_VERSION, key.getParentKeyVersion())
 478                     .setParameter(LOCAL_NAME,     key.getLocalName())
 479                     .getResultList();
 480             // @formatter:on
 481         }
 482
 483         return getSingleResult(someClass, key.getId(), ret);
 484     }
 485
 486     @Override
 487     public <T extends PfConcept> T update(final T obj) {
 488         T ret;
 489         try (var mg = getEntityManager()) {
 490             mg.getTransaction().begin();
 491             ret = mg.merge(obj);
 492             mg.flush();
 493             mg.getTransaction().commit();
 494         }
 495         return ret;
 496     }
 497
 498     @Override
 499     public <T extends PfConcept> long size(final Class<T> someClass) {
 500         if (someClass == null) {
 501             return 0;
 502         }
 503         long size;
 504         try (var mg = getEntityManager()) {
 505             /*
 506              * The invoking code only passes well-known classes into this method, thus
 507              * disabling the sonar about SQL injection.
 508              */
 509             size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) // NOSONAR
 510                 .getSingleResult();
 511         }
 512         return size;
 513     }
 514
 515     /**
 516      * Add the table to a query string.
 517      *
 518      * @param queryString the query string
 519      * @param tableClass  the class name of the table
 520      * @return the updated query string
 521      */
 522     private <T extends PfConcept> String setQueryTable(final String queryString, final Class<T> tableClass) {
 523         return queryString.replace(TABLE_TOKEN, tableClass.getSimpleName());
 524     }
 525
 526     /**
 527      * Check that a query returned one and only one entry and return that entry.
 528      *
 529      * @param someClass    the class being searched for
 530      * @param searchFilter the search filter
 531      * @param resultList   the result list returned by the query
 532      * @return the single unique result
 533      */
 534     private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter,
 535                                                     List<T> resultList) {
 536         if (resultList == null || resultList.isEmpty()) {
 537             return null;
 538         }
 539         if (resultList.size() > 1) {
 540             throw new IllegalArgumentException("More than one result was returned query on " + someClass
 541                 + " with filter " + searchFilter + ": " + resultList);
 542         }
 543         return resultList.get(0);
 544     }
 545
 546     /**
 547      * check the result get from database and return the object.
 548      *
 549      * @param <T>        the type of the object to get, a subclass of {@link PfConcept}
 550      * @param someClass  the class of the object to get, a subclass of {@link PfConcept}
 551      * @param objToCheck the object that was retrieved from the database
 552      * @return the checked object or null
 553      */
 554     private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {
 555         if (objToCheck != null) {
 556             try {
 557                 return PfUtils.makeCopy(objToCheck);
 558             } catch (final Exception e) {
 559                 LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e);
 560             }
 561         }
 562         return null;
 563     }
 564 }