X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=models-dao%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fpolicy%2Fmodels%2Fdao%2Fimpl%2FDefaultPfDao.java;h=c6faf21eccbb6ab87f8ec4ab354306109d4c6d2d;hb=389c85c8e7213c10c17896f4c63d94e2b5e9d27a;hp=f7659b2cefb253357c1f346a61f829925b164daa;hpb=09c5d18a9e3b2ae2958d2762bd4277499611d5ec;p=policy%2Fmodels.git diff --git a/models-dao/src/main/java/org/onap/policy/models/dao/impl/DefaultPfDao.java b/models-dao/src/main/java/org/onap/policy/models/dao/impl/DefaultPfDao.java index f7659b2ce..c6faf21ec 100644 --- a/models-dao/src/main/java/org/onap/policy/models/dao/impl/DefaultPfDao.java +++ b/models-dao/src/main/java/org/onap/policy/models/dao/impl/DefaultPfDao.java @@ -1,6 +1,8 @@ /*- * ============LICENSE_START======================================================= - * Copyright (C) 2019 Nordix Foundation. + * Copyright (C) 2019-2021, 2023-2024 Nordix Foundation. + * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved. + * Modifications Copyright (C) 2022 Bell Canada. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,79 +22,38 @@ package org.onap.policy.models.dao.impl; +import jakarta.persistence.EntityManager; +import jakarta.persistence.EntityManagerFactory; +import jakarta.persistence.Persistence; +import jakarta.persistence.TypedQuery; +import jakarta.ws.rs.core.Response; import java.util.Collection; import java.util.Collections; import java.util.List; - -import javax.persistence.EntityManager; -import javax.persistence.EntityManagerFactory; -import javax.persistence.Persistence; -import javax.ws.rs.core.Response; - +import org.apache.commons.lang3.StringUtils; import org.onap.policy.models.base.PfConcept; import org.onap.policy.models.base.PfConceptKey; import org.onap.policy.models.base.PfModelException; import org.onap.policy.models.base.PfModelRuntimeException; import org.onap.policy.models.base.PfReferenceKey; +import org.onap.policy.models.base.PfReferenceTimestampKey; +import org.onap.policy.models.base.PfTimestampKey; +import org.onap.policy.models.base.PfUtils; import org.onap.policy.models.dao.DaoParameters; import org.onap.policy.models.dao.PfDao; +import org.onap.policy.models.dao.PfFilter; +import org.onap.policy.models.dao.PfFilterFactory; +import org.onap.policy.models.dao.PfFilterParametersIntfc; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts - * ({@link PfConcept}). It uses the default JPA implementation in the javax {@link Persistence} class. + * ({@link PfConcept}). It uses the default JPA implementation in the jakarta {@link Persistence} class. */ public class DefaultPfDao implements PfDao { private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class); - // @formatter:off - private static final String NAME = "name"; - private static final String VERSION = "version"; - private static final String PARENT_NAME = "parentname"; - private static final String PARENT_VERSION = "parentversion"; - private static final String LOCAL_NAME = "localname"; - - private static final String TABLE_TOKEN = "__TABLE__"; - - private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c"; - - private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c"; - - private static final String WHERE = " WHERE "; - private static final String AND = " AND "; - - private static final String NAME_FILTER = "c.key.name = :name"; - private static final String VERSION_FILTER = "c.key.version = :version"; - private static final String PARENT_NAME_FILTER = "c.key.parentKeyName = :parentname"; - private static final String PARENT_VERSION_FILTER = "c.key.parentKeyVersion = :parentversion"; - private static final String LOCAL_NAME_FILTER = "c.key.localName = :localname"; - private static final String MAX_VERISON_FILTER = "c.key.version = (SELECT MAX(c.key.version) FROM __TABLE__ c)"; - - private static final String DELETE_BY_CONCEPT_KEY = - DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER; - - private static final String DELETE_BY_REFERENCE_KEY = - DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER; - - private static final String SELECT_ALL_FOR_PARENT = - SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER; - - private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER; - - private static final String SELECT_LATEST_VERSION = - SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + MAX_VERISON_FILTER; - - private static final String SELECT_LATEST_VERSIONS = - "SELECT c FROM __TABLE__ c WHERE c.key.version = (SELECT MAX(c.key.version) FROM __TABLE__ c)"; - - private static final String SELECT_BY_CONCEPT_KEY = - SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER; - - private static final String SELECT_BY_REFERENCE_KEY = - SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER; - // @formatter:on - // Entity manager for JPA private EntityManagerFactory emf = null; @@ -101,17 +62,17 @@ public class DefaultPfDao implements PfDao { if (daoParameters == null || daoParameters.getPersistenceUnit() == null) { LOGGER.error("Policy Framework persistence unit parameter not set"); throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, - "Policy Framework persistence unit parameter not set"); + "Policy Framework persistence unit parameter not set"); } LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit()); try { emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(), - daoParameters.getJdbcProperties()); + daoParameters.getJdbcProperties()); } catch (final Exception ex) { String errorMessage = "Creation of Policy Framework persistence unit \"" - + daoParameters.getPersistenceUnit() + "\" failed"; - LOGGER.warn(errorMessage, ex); + + daoParameters.getPersistenceUnit() + "\" failed"; + LOGGER.warn(errorMessage); throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex); } LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit()); @@ -126,7 +87,7 @@ public class DefaultPfDao implements PfDao { if (emf == null) { LOGGER.warn("Policy Framework DAO has not been initialized"); throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, - "Policy Framework DAO has not been initialized"); + "Policy Framework DAO has not been initialized"); } return emf.createEntityManager(); @@ -144,13 +105,10 @@ public class DefaultPfDao implements PfDao { if (obj == null) { return; } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { mg.getTransaction().begin(); mg.merge(obj); mg.getTransaction().commit(); - } finally { - mg.close(); } } @@ -159,13 +117,10 @@ public class DefaultPfDao implements PfDao { if (obj == null) { return; } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { mg.getTransaction().begin(); mg.remove(mg.contains(obj) ? obj : mg.merge(obj)); mg.getTransaction().commit(); - } finally { - mg.close(); } } @@ -174,18 +129,15 @@ public class DefaultPfDao implements PfDao { if (key == null) { return; } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { // @formatter:off mg.getTransaction().begin(); - mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass) + mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass)) .setParameter(NAME, key.getName()) - .setParameter("version", key.getVersion()) + .setParameter(VERSION, key.getVersion()) .executeUpdate(); mg.getTransaction().commit(); // @formatter:on - } finally { - mg.close(); } } @@ -194,19 +146,34 @@ public class DefaultPfDao implements PfDao { if (key == null) { return; } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { // @formatter:off mg.getTransaction().begin(); - mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass) + mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass)) .setParameter(PARENT_NAME, key.getParentKeyName()) .setParameter(PARENT_VERSION, key.getParentKeyVersion()) .setParameter(LOCAL_NAME, key.getLocalName()) .executeUpdate(); mg.getTransaction().commit(); // @formatter:on - } finally { - mg.close(); + } + } + + @Override + public void delete(final Class someClass, final PfTimestampKey key) { + if (key == null) { + return; + } + try (var mg = getEntityManager()) { + // @formatter:off + mg.getTransaction().begin(); + mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass)) + .setParameter(NAME, key.getName()) + .setParameter(VERSION, key.getVersion()) + .setParameter(TIMESTAMP, key.getTimeStamp()) + .executeUpdate(); + mg.getTransaction().commit(); + // @formatter:on } } @@ -215,15 +182,12 @@ public class DefaultPfDao implements PfDao { if (objs == null || objs.isEmpty()) { return; } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { mg.getTransaction().begin(); for (final T t : objs) { mg.merge(t); } mg.getTransaction().commit(); - } finally { - mg.close(); } } @@ -232,15 +196,12 @@ public class DefaultPfDao implements PfDao { if (objs == null || objs.isEmpty()) { return; } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { mg.getTransaction().begin(); for (final T t : objs) { mg.remove(mg.contains(t) ? t : mg.merge(t)); } mg.getTransaction().commit(); - } finally { - mg.close(); } } @@ -249,38 +210,34 @@ public class DefaultPfDao implements PfDao { if (keys == null || keys.isEmpty()) { return 0; } - int deletedCount = 0; - final EntityManager mg = getEntityManager(); - try { + var deletedCount = 0; + try (var mg = getEntityManager()) { // @formatter:off mg.getTransaction().begin(); for (final PfConceptKey key : keys) { - deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass) + deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass)) .setParameter(NAME, key.getName()) - .setParameter("version", key.getVersion()) + .setParameter(VERSION, key.getVersion()) .executeUpdate(); } mg.getTransaction().commit(); // @formatter:on - } finally { - mg.close(); } return deletedCount; } @Override public int deleteByReferenceKey(final Class someClass, - final Collection keys) { + final Collection keys) { if (keys == null || keys.isEmpty()) { return 0; } - int deletedCount = 0; - final EntityManager mg = getEntityManager(); - try { + var deletedCount = 0; + try (var mg = getEntityManager()) { // @formatter:off mg.getTransaction().begin(); for (final PfReferenceKey key : keys) { - deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass) + deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass)) .setParameter(PARENT_NAME, key.getParentKeyName()) .setParameter(PARENT_VERSION, key.getParentKeyVersion()) .setParameter(LOCAL_NAME, key.getLocalName()) @@ -288,87 +245,82 @@ public class DefaultPfDao implements PfDao { } mg.getTransaction().commit(); // @formatter:on - } finally { - mg.close(); } return deletedCount; } @Override public void deleteAll(final Class someClass) { - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { mg.getTransaction().begin(); - mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate(); + mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass)).executeUpdate(); mg.getTransaction().commit(); - } finally { - mg.close(); } } @Override - public List getFiltered(Class someClass, PfConceptKey key) { - if (key.getName() == null) { + public List getFiltered(final Class someClass, final String name, + final String version) { + if (name == null) { return getAll(someClass); } - if (key.getVersion() == null) { - return getAllVersions(someClass, key.getName()); + if (version == null) { + return getAllVersions(someClass, name); } - T foundConcept = get(someClass, key); + var foundConcept = get(someClass, new PfConceptKey(name, version)); return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept)); } @Override - public T get(final Class someClass, final PfConceptKey key) { - if (someClass == null) { - return null; - } - final EntityManager mg = getEntityManager(); - try { - final T t = mg.find(someClass, key); - if (t != null) { - // This clone is created to force the JPA DAO to recurse down through the object - try { - final T clonedT = someClass.newInstance(); - t.copyTo(clonedT); - return clonedT; - } catch (final Exception e) { - LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e); - return null; - } - } else { - return null; - } - } finally { - mg.close(); + public List getFiltered(final Class someClass, PfFilterParametersIntfc filterParams) { + + try (var mg = getEntityManager()) { + PfFilter filter = new PfFilterFactory().createFilter(someClass); + var filterQueryString = SELECT_FROM_TABLE + + filter.genWhereClause(filterParams) + + filter.genOrderClause(filterParams); + + TypedQuery query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass); + filter.setParams(query, filterParams); + + LOGGER.debug("filterQueryString is \"{}\"", filterQueryString); + return query.getResultList(); } } + @Override + public T get(final Class someClass, final PfConceptKey key) { + return genericGet(someClass, key); + } + @Override public T get(final Class someClass, final PfReferenceKey key) { + return genericGet(someClass, key); + } + + @Override + public T get(final Class someClass, final PfTimestampKey key) { + return genericGet(someClass, key); + } + + @Override + public T get(final Class someClass, final PfReferenceTimestampKey key) { + return genericGet(someClass, key); + } + + private T genericGet(final Class someClass, final Object key) { if (someClass == null) { return null; } - final EntityManager mg = getEntityManager(); - try { - final T t = mg.find(someClass, key); + try (var mg = getEntityManager()) { + final var t = mg.find(someClass, key); if (t != null) { - try { - final T clonedT = someClass.newInstance(); - t.copyTo(clonedT); - return clonedT; - } catch (final Exception e) { - LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e); - return null; - } - } else { - return null; + mg.refresh(t); } - } finally { - mg.close(); + return checkAndReturn(someClass, t); } } @@ -377,11 +329,8 @@ public class DefaultPfDao implements PfDao { if (someClass == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList(); - } finally { - mg.close(); } } @@ -390,71 +339,60 @@ public class DefaultPfDao implements PfDao { if (someClass == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); - try { + try (var mg = getEntityManager()) { // @formatter:off return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass) .setParameter(PARENT_NAME, parentKey.getName()) .setParameter(PARENT_VERSION, parentKey.getVersion()) .getResultList(); // @formatter:on - } finally { - mg.close(); } } @Override - public List getAllVersions(final Class someClass, final String conceptName) { - if (someClass == null || conceptName == null) { + public List getAll(Class someClass, String orderBy, Integer numRecords) { + + if (someClass == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); - try { - // @formatter:off - return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass) - .setParameter(NAME, conceptName) - .getResultList(); - // @formatter:on - } finally { - mg.close(); + try (var mg = getEntityManager()) { + String query = setQueryTable(SELECT_FROM_TABLE, someClass); + + if (StringUtils.isNotBlank(orderBy)) { + query = query.concat(ORDER_BY).concat(orderBy); + } + + return mg.createQuery(query, someClass).setMaxResults(numRecords) + .getResultList(); } } @Override - public List getLatestVersions(final Class someClass) { - if (someClass == null) { + public List getAllVersionsByParent(final Class someClass, final String parentKeyName) { + if (someClass == null || parentKeyName == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); - List ret; - try { + try (var mg = getEntityManager()) { // @formatter:off - return mg.createQuery(setQueryTable(SELECT_LATEST_VERSIONS, someClass), someClass) + return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass) + .setParameter(PARENT_NAME, parentKeyName) .getResultList(); // @formatter:on - } finally { - mg.close(); } } @Override - public T getLatestVersion(final Class someClass, final String conceptName) { + public List getAllVersions(final Class someClass, final String conceptName) { if (someClass == null || conceptName == null) { - return null; + return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); - List ret; - try { + try (var mg = getEntityManager()) { // @formatter:off - ret = mg.createQuery(setQueryTable(SELECT_LATEST_VERSION, someClass), someClass) + return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass) .setParameter(NAME, conceptName) .getResultList(); // @formatter:on - } finally { - mg.close(); } - - return getSingleResult(someClass, conceptName, ret); } @Override @@ -462,17 +400,14 @@ public class DefaultPfDao implements PfDao { if (someClass == null || key == null) { return null; } - final EntityManager mg = getEntityManager(); List ret; - try { + try (var mg = getEntityManager()) { // @formatter:off ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass) .setParameter(NAME, key.getName()) .setParameter(VERSION, key.getVersion()) .getResultList(); // @formatter:on - } finally { - mg.close(); } return getSingleResult(someClass, key.getId(), ret); @@ -483,9 +418,8 @@ public class DefaultPfDao implements PfDao { if (someClass == null || key == null) { return null; } - final EntityManager mg = getEntityManager(); List ret; - try { + try (var mg = getEntityManager()) { // @formatter:off ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass) .setParameter(PARENT_NAME, key.getParentKeyName()) @@ -493,8 +427,6 @@ public class DefaultPfDao implements PfDao { .setParameter(LOCAL_NAME, key.getLocalName()) .getResultList(); // @formatter:on - } finally { - mg.close(); } return getSingleResult(someClass, key.getId(), ret); @@ -502,15 +434,12 @@ public class DefaultPfDao implements PfDao { @Override public T update(final T obj) { - final EntityManager mg = getEntityManager(); T ret; - try { + try (var mg = getEntityManager()) { mg.getTransaction().begin(); ret = mg.merge(obj); mg.flush(); mg.getTransaction().commit(); - } finally { - mg.close(); } return ret; } @@ -520,13 +449,14 @@ public class DefaultPfDao implements PfDao { if (someClass == null) { return 0; } - final EntityManager mg = getEntityManager(); - long size = 0; - try { - size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) - .getSingleResult(); - } finally { - mg.close(); + long size; + try (var mg = getEntityManager()) { + /* + * The invoking code only passes well-known classes into this method, thus + * disabling the sonar about SQL injection. + */ + size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) // NOSONAR + .getSingleResult(); } return size; } @@ -535,29 +465,49 @@ public class DefaultPfDao implements PfDao { * Add the table to a query string. * * @param queryString the query string - * @param tableClass the class name of the table + * @param tableClass the class name of the table * @return the updated query string */ private String setQueryTable(final String queryString, final Class tableClass) { - return queryString.replaceAll(TABLE_TOKEN, tableClass.getSimpleName()); + return queryString.replace(TABLE_TOKEN, tableClass.getSimpleName()); } /** * Check that a query returned one and only one entry and return that entry. * - * @param someClass the class being searched for - * @param conceptName the concept name being searched for - * @param resultList the result list returned by the query + * @param someClass the class being searched for + * @param searchFilter the search filter + * @param resultList the result list returned by the query * @return the single unique result */ - private T getSingleResult(final Class someClass, final String searchFilter, List ret) { - if (ret == null || ret.isEmpty()) { + private T getSingleResult(final Class someClass, final String searchFilter, + List resultList) { + if (resultList == null || resultList.isEmpty()) { return null; } - if (ret.size() > 1) { + if (resultList.size() > 1) { throw new IllegalArgumentException("More than one result was returned query on " + someClass - + " with filter " + searchFilter + ": " + ret); + + " with filter " + searchFilter + ": " + resultList); + } + return resultList.get(0); + } + + /** + * check the result get from database and return the object. + * + * @param the type of the object to get, a subclass of {@link PfConcept} + * @param someClass the class of the object to get, a subclass of {@link PfConcept} + * @param objToCheck the object that was retrieved from the database + * @return the checked object or null + */ + private T checkAndReturn(final Class someClass, final T objToCheck) { + if (objToCheck != null) { + try { + return PfUtils.makeCopy(objToCheck); + } catch (final Exception e) { + LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e); + } } - return ret.get(0); + return null; } }