Merge "Handling Policy deploy/undeploy audit models"
[policy/models.git] / models-dao / src / main / java / org / onap / policy / models / dao / impl / DefaultPfDao.java
index ef86c17..336abf7 100644 (file)
@@ -32,8 +32,10 @@ import javax.persistence.EntityManagerFactory;
 import javax.persistence.Persistence;
 import javax.persistence.TypedQuery;
 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.PfGeneratedIdKey;
 import org.onap.policy.models.base.PfModelException;
 import org.onap.policy.models.base.PfModelRuntimeException;
 import org.onap.policy.models.base.PfReferenceKey;
@@ -42,6 +44,8 @@ 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;
 
@@ -56,6 +60,7 @@ public class DefaultPfDao implements PfDao {
     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";
@@ -68,19 +73,17 @@ public class DefaultPfDao implements PfDao {
 
     private static final String WHERE      = " WHERE ";
     private static final String AND        = " AND ";
-    private static final String ORDER      = " ORDER BY ";
+    private static final String ORDER_BY        = " ORDER BY c.";
 
     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_START_FILTER = "c.key.timeStamp >= :startTime";
-    private static final String TIMESTAMP_END_FILTER   = "c.key.timeStamp <= :endTime";
+    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 PARENT_NAME_REF_FILTER     = "c.key.referenceKey.parentKeyName = :parentKeyName";
-
     private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
 
     private static final String DELETE_BY_CONCEPT_KEY =
@@ -89,6 +92,9 @@ public class DefaultPfDao implements PfDao {
     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;
 
@@ -103,6 +109,9 @@ public class DefaultPfDao implements PfDao {
     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
@@ -158,7 +167,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);
@@ -173,7 +182,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));
@@ -188,7 +197,7 @@ public class DefaultPfDao implements PfDao {
         if (key == null) {
             return;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             // @formatter:off
             mg.getTransaction().begin();
@@ -208,7 +217,7 @@ public class DefaultPfDao implements PfDao {
         if (key == null) {
             return;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             // @formatter:off
             mg.getTransaction().begin();
@@ -229,7 +238,7 @@ public class DefaultPfDao implements PfDao {
         if (key == null) {
             return;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             // @formatter:off
             mg.getTransaction().begin();
@@ -245,12 +254,33 @@ public class DefaultPfDao implements PfDao {
         }
     }
 
+    @Override
+    public <T extends PfConcept> void delete(final Class<T> 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 <T extends PfConcept> void createCollection(final Collection<T> objs) {
         if (objs == null || objs.isEmpty()) {
             return;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             mg.getTransaction().begin();
             for (final T t : objs) {
@@ -267,7 +297,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) {
@@ -284,8 +314,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();
@@ -309,8 +339,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();
@@ -331,7 +361,7 @@ public class DefaultPfDao implements PfDao {
 
     @Override
     public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             mg.getTransaction().begin();
             mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate();
@@ -352,7 +382,7 @@ 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));
     }
@@ -361,19 +391,15 @@ public class DefaultPfDao implements PfDao {
     public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name, final String version,
             final Instant startTime, final Instant endTime, final Map<String, Object> filterMap, final String sortOrder,
             final int getRecordNum) {
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
 
-        String filterQueryString = SELECT_FROM_TABLE + WHERE;
+        var filterQueryString = SELECT_FROM_TABLE + WHERE;
 
         try {
-            if (filterMap != null) {
-                filterQueryString = buildFilter(filterMap, filterQueryString);
-            }
-            filterQueryString = addKeyFilterString(filterQueryString, name, startTime, endTime,
-                isRefTimestampKey(someClass));
-            if (getRecordNum > 0) {
-                filterQueryString += ORDER + " c.key.timeStamp " + sortOrder;
-            }
+            PfFilter timeStampFilter = new PfFilterFactory().createFilter(someClass);
+            filterQueryString = timeStampFilter.addFilter(filterQueryString, name, startTime, endTime, filterMap,
+                    sortOrder, getRecordNum);
+
             TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
 
             if (filterMap != null) {
@@ -382,11 +408,7 @@ public class DefaultPfDao implements PfDao {
                 }
             }
             if (name != null) {
-                if (isRefTimestampKey(someClass)) {
-                    query.setParameter("parentKeyName", name);
-                } else {
-                    query.setParameter("name", name);
-                }
+                query.setParameter(timeStampFilter.getNameParameter(), name);
             }
             if (startTime != null) {
                 if (endTime != null) {
@@ -406,33 +428,11 @@ public class DefaultPfDao implements PfDao {
 
             LOGGER.debug("filterQueryString is  \"{}\"", filterQueryString);
             return query.getResultList();
-        }  finally {
+        } finally {
             mg.close();
         }
     }
 
-    /**
-     * This method checks if the class invoking the DAO is using PfReferenceTimestamp Key.
-     * @param someClass class that invoked Dao
-     * @return true if the key is PfReferenceTimestampKey.
-     */
-    private <T extends PfConcept> boolean isRefTimestampKey(final Class<T> someClass) {
-        try {
-            return PfReferenceTimestampKey.class.isAssignableFrom(someClass.getDeclaredField("key").getType());
-        } catch (NoSuchFieldException e) {
-            LOGGER.error("Error verifying the key for reference timestamp:", e);
-            return false;
-        }
-    }
-
-    private String buildFilter(final Map<String, Object> filterMap, String filterQueryString) {
-        StringBuilder bld = new StringBuilder(filterQueryString);
-        for (String key : filterMap.keySet()) {
-            bld.append("c." + key + "= :" + key + AND);
-        }
-        return bld.toString();
-    }
-
     @Override
     public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
         return genericGet(someClass, key);
@@ -443,6 +443,11 @@ public class DefaultPfDao implements PfDao {
         return genericGet(someClass, key);
     }
 
+    @Override
+    public <T extends PfConcept> T get(final Class<T> someClass, final PfGeneratedIdKey key) {
+        return genericGet(someClass, key);
+    }
+
     @Override
     public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
         return genericGet(someClass, key);
@@ -457,9 +462,9 @@ public class DefaultPfDao implements PfDao {
         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) {
                 mg.refresh(t);
             }
@@ -474,7 +479,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 {
@@ -487,7 +492,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)
@@ -500,12 +505,33 @@ public class DefaultPfDao implements PfDao {
         }
     }
 
+    @Override
+    public <T extends PfConcept> List<T> getAll(Class<T> someClass, String orderBy, Integer numRecords) {
+
+        if (someClass == null) {
+            return Collections.emptyList();
+        }
+        final var mg = getEntityManager();
+        try {
+            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();
+        } finally {
+            mg.close();
+        }
+    }
+
     @Override
     public <T extends PfConcept> List<T> getAllVersionsByParent(final Class<T> someClass, final String parentKeyName) {
         if (someClass == null || parentKeyName == null) {
             return Collections.emptyList();
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             // @formatter:off
             return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass)
@@ -522,7 +548,7 @@ public class DefaultPfDao implements PfDao {
         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)
@@ -534,12 +560,33 @@ public class DefaultPfDao implements PfDao {
         }
     }
 
+    @Override
+    public <T extends PfConcept> List<T> getByTimestamp(final Class<T> 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 extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
         if (someClass == null || key == null) {
             return null;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         List<T> ret;
         try {
             // @formatter:off
@@ -560,7 +607,7 @@ public class DefaultPfDao implements PfDao {
         if (someClass == null || key == null) {
             return null;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         List<T> ret;
         try {
             // @formatter:off
@@ -579,7 +626,7 @@ public class DefaultPfDao implements PfDao {
 
     @Override
     public <T extends PfConcept> T update(final T obj) {
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         T ret;
         try {
             mg.getTransaction().begin();
@@ -597,10 +644,14 @@ 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)
+            /*
+             * 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();
         } finally {
             mg.close();
@@ -638,45 +689,6 @@ public class DefaultPfDao implements PfDao {
         return ret.get(0);
     }
 
-    /**
-     * generate filter string with the filter value in TimestampKey.
-     *
-     * @param inputFilterString current filterString generated from FilterMap
-     * @param name the pdp name the start timeStamp to filter from database, filter rule: startTime <= filteredRecord
-     *        timeStamp <= endTime. null for ignore start time.
-     * @param endTime the end timeStamp to filter from database, filter rule: startTime <= filteredRecord timeStamp <=
-     *        endTime. null for ignore end time
-     * @param isRefTimestampKey boolean value, set to true if the query invoked for pfReferenceTimestampKey
-     * @return the filter string to query database
-     */
-    private String addKeyFilterString(String inputFilterString, final String name, final Instant startTime,
-            final Instant endTime, final boolean isRefTimestampKey) {
-        String filterQueryString;
-        String inputFilter = inputFilterString;
-        if (name != null) {
-            if (isRefTimestampKey) {
-                inputFilter += PARENT_NAME_REF_FILTER + AND;
-            } else {
-                inputFilter += NAME_FILTER + AND;
-            }
-        }
-        if (startTime != null) {
-            if (endTime != null) {
-                filterQueryString = inputFilter + TIMESTAMP_START_FILTER + AND + TIMESTAMP_END_FILTER;
-            } else {
-                filterQueryString = inputFilter + TIMESTAMP_START_FILTER;
-            }
-        } else {
-            if (endTime != null) {
-                filterQueryString = inputFilter + TIMESTAMP_END_FILTER;
-            } else {
-                filterQueryString = inputFilter.substring(0, inputFilter.length() - AND.length());
-            }
-        }
-
-        return filterQueryString;
-    }
-
     /**
      * check the result get from database and return the object.
      *