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=42a06acc4c7e4e6a7e00b0097e140ae8c7b32e17;hb=d00c73842c6f8e7bb00b29d2fb5dd63b9cde4bfe;hp=c44d05fe2d4e77e8148fa76db4343fd0bc7b8c4b;hpb=891bffd9f13177d96ad26acdfa7148d09e1d682a;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 c44d05fe2..42a06acc4 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,7 @@ /*- * ============LICENSE_START======================================================= - * Copyright (C) 2019 Nordix Foundation. + * Copyright (C) 2019-2021 Nordix Foundation. + * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. 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,22 +21,30 @@ package org.onap.policy.models.dao.impl; +import java.sql.Timestamp; +import java.time.Instant; import java.util.Collection; import java.util.Collections; import java.util.List; - +import java.util.Map; import javax.persistence.EntityManager; import javax.persistence.EntityManagerFactory; import javax.persistence.Persistence; +import javax.persistence.TypedQuery; import javax.ws.rs.core.Response; - import org.onap.policy.models.base.PfConcept; import org.onap.policy.models.base.PfConceptKey; +import org.onap.policy.models.base.PfGeneratedIdKey; 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.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -49,6 +58,8 @@ public class DefaultPfDao implements PfDao { // @formatter:off private static final String NAME = "name"; private static final String VERSION = "version"; + private static final String TIMESTAMP = "timeStamp"; + private static final String GENERATEDID = "Id"; private static final String PARENT_NAME = "parentname"; private static final String PARENT_VERSION = "parentversion"; private static final String LOCAL_NAME = "localname"; @@ -62,26 +73,43 @@ public class DefaultPfDao implements PfDao { 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 NAME_FILTER = "c.key.name = :name"; + private static final String VERSION_FILTER = "c.key.version = :version"; + private static final String TIMESTAMP_FILTER = "c.key.timeStamp = :timeStamp"; + private static final String TIMESTAMP_FILTER_NOKEY = "c.timeStamp = :timeStamp"; + private static final String GENERATED_ID_FILTER = "c.key.generatedId = :Id"; + 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 CLONE_ERR_MSG = "Could not clone object of class \"{}\""; private static final String DELETE_BY_CONCEPT_KEY = DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER; + private static final String DELETE_BY_TIMESTAMP_KEY = + DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER; + + private static final String DELETE_BY_GENERATED_ID_KEY = + DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + GENERATED_ID_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_FOR_PARENT = + SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER; + private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER; private static final String SELECT_BY_CONCEPT_KEY = SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER; + private static final String SELECT_BY_TIMESTAMP_NOKEY = + SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER_NOKEY; + 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 @@ -104,7 +132,7 @@ public class DefaultPfDao implements PfDao { } catch (final Exception ex) { String errorMessage = "Creation of Policy Framework persistence unit \"" + daoParameters.getPersistenceUnit() + "\" failed"; - LOGGER.warn(errorMessage, ex); + LOGGER.warn(errorMessage); throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex); } LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit()); @@ -137,7 +165,7 @@ public class DefaultPfDao implements PfDao { if (obj == null) { return; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { mg.getTransaction().begin(); mg.merge(obj); @@ -152,7 +180,7 @@ public class DefaultPfDao implements PfDao { if (obj == null) { return; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { mg.getTransaction().begin(); mg.remove(mg.contains(obj) ? obj : mg.merge(obj)); @@ -167,7 +195,7 @@ public class DefaultPfDao implements PfDao { if (key == null) { return; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { // @formatter:off mg.getTransaction().begin(); @@ -187,7 +215,7 @@ public class DefaultPfDao implements PfDao { if (key == null) { return; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { // @formatter:off mg.getTransaction().begin(); @@ -203,12 +231,54 @@ public class DefaultPfDao implements PfDao { } } + @Override + public void delete(final Class someClass, final PfTimestampKey key) { + if (key == null) { + return; + } + final var mg = getEntityManager(); + try { + // @formatter:off + mg.getTransaction().begin(); + mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass), someClass) + .setParameter(NAME, key.getName()) + .setParameter(VERSION, key.getVersion()) + .setParameter(TIMESTAMP, key.getTimeStamp()) + .executeUpdate(); + mg.getTransaction().commit(); + // @formatter:on + } finally { + mg.close(); + } + } + + @Override + public void delete(final Class someClass, final PfGeneratedIdKey key) { + if (key == null) { + return; + } + final var mg = getEntityManager(); + try { + // @formatter:off + mg.getTransaction().begin(); + mg.createQuery(setQueryTable(DELETE_BY_GENERATED_ID_KEY, someClass), someClass) + .setParameter(NAME, key.getName()) + .setParameter(VERSION, key.getVersion()) + .setParameter(GENERATEDID, key.getGeneratedId()) + .executeUpdate(); + mg.getTransaction().commit(); + // @formatter:on + } finally { + mg.close(); + } + } + @Override public void createCollection(final Collection objs) { if (objs == null || objs.isEmpty()) { return; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { mg.getTransaction().begin(); for (final T t : objs) { @@ -225,7 +295,7 @@ public class DefaultPfDao implements PfDao { if (objs == null || objs.isEmpty()) { return; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { mg.getTransaction().begin(); for (final T t : objs) { @@ -242,8 +312,8 @@ public class DefaultPfDao implements PfDao { if (keys == null || keys.isEmpty()) { return 0; } - int deletedCount = 0; - final EntityManager mg = getEntityManager(); + var deletedCount = 0; + final var mg = getEntityManager(); try { // @formatter:off mg.getTransaction().begin(); @@ -267,8 +337,8 @@ public class DefaultPfDao implements PfDao { if (keys == null || keys.isEmpty()) { return 0; } - int deletedCount = 0; - final EntityManager mg = getEntityManager(); + var deletedCount = 0; + final var mg = getEntityManager(); try { // @formatter:off mg.getTransaction().begin(); @@ -289,7 +359,7 @@ public class DefaultPfDao implements PfDao { @Override public void deleteAll(final Class someClass) { - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { mg.getTransaction().begin(); mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate(); @@ -310,57 +380,94 @@ public class DefaultPfDao implements PfDao { return getAllVersions(someClass, name); } - T foundConcept = get(someClass, new PfConceptKey(name, version)); + 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(); + public List getFiltered(final Class someClass, final String name, final String version, + final Instant startTime, final Instant endTime, final Map filterMap, final String sortOrder, + final int getRecordNum) { + final var mg = getEntityManager(); + + var filterQueryString = SELECT_FROM_TABLE + WHERE; + 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; + PfFilter timeStampFilter = new PfFilterFactory().createFilter(someClass); + filterQueryString = timeStampFilter.addFilter(filterQueryString, + name, startTime, endTime, filterMap, sortOrder, getRecordNum); + + + TypedQuery query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass); + + if (filterMap != null) { + for (Map.Entry entry : filterMap.entrySet()) { + query.setParameter(entry.getKey(), entry.getValue()); + } + } + if (name != null) { + query.setParameter(timeStampFilter.getNameParameter(), name); + } + if (startTime != null) { + if (endTime != null) { + query.setParameter("startTime", Timestamp.from(startTime)); + query.setParameter("endTime", Timestamp.from(endTime)); + } else { + query.setParameter("startTime", Timestamp.from(startTime)); } } else { - return null; + if (endTime != null) { + query.setParameter("endTime", Timestamp.from(endTime)); + } } - } finally { + if (getRecordNum > 0) { + query.setMaxResults(getRecordNum); + } + + LOGGER.debug("filterQueryString is \"{}\"", filterQueryString); + return query.getResultList(); + } finally { mg.close(); } } + @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 PfGeneratedIdKey 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(); + final var mg = getEntityManager(); try { - final T t = mg.find(someClass, key); + 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); } + return checkAndReturn(someClass, t); } finally { mg.close(); } @@ -371,7 +478,7 @@ public class DefaultPfDao implements PfDao { if (someClass == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList(); } finally { @@ -384,7 +491,7 @@ public class DefaultPfDao implements PfDao { if (someClass == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { // @formatter:off return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass) @@ -397,12 +504,29 @@ public class DefaultPfDao implements PfDao { } } + @Override + public List getAllVersionsByParent(final Class someClass, final String parentKeyName) { + if (someClass == null || parentKeyName == null) { + return Collections.emptyList(); + } + final var mg = getEntityManager(); + try { + // @formatter:off + return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass) + .setParameter(PARENT_NAME, parentKeyName) + .getResultList(); + // @formatter:on + } finally { + mg.close(); + } + } + @Override public List getAllVersions(final Class someClass, final String conceptName) { if (someClass == null || conceptName == null) { return Collections.emptyList(); } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); try { // @formatter:off return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass) @@ -414,12 +538,34 @@ public class DefaultPfDao implements PfDao { } } + @Override + public List getByTimestamp(final Class someClass, + final PfGeneratedIdKey key, + final Instant timeStamp) { + if (someClass == null || key == null || timeStamp == null) { + return Collections.emptyList(); + } + + final var mg = getEntityManager(); + try { + // @formatter:off + return mg.createQuery(setQueryTable(SELECT_BY_TIMESTAMP_NOKEY, someClass), someClass) + .setParameter(NAME, key.getName()) + .setParameter(VERSION, key.getVersion()) + .setParameter(TIMESTAMP, Timestamp.from(timeStamp)) + .getResultList(); + // @formatter:on + } finally { + mg.close(); + } + } + @Override public T getConcept(final Class someClass, final PfConceptKey key) { if (someClass == null || key == null) { return null; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); List ret; try { // @formatter:off @@ -440,7 +586,7 @@ public class DefaultPfDao implements PfDao { if (someClass == null || key == null) { return null; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); List ret; try { // @formatter:off @@ -459,7 +605,7 @@ public class DefaultPfDao implements PfDao { @Override public T update(final T obj) { - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); T ret; try { mg.getTransaction().begin(); @@ -477,7 +623,7 @@ public class DefaultPfDao implements PfDao { if (someClass == null) { return 0; } - final EntityManager mg = getEntityManager(); + final var mg = getEntityManager(); long size = 0; try { size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class) @@ -496,7 +642,7 @@ public class DefaultPfDao implements PfDao { * @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()); } /** @@ -517,4 +663,23 @@ public class DefaultPfDao implements PfDao { } return ret.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 t 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 null; + } }