Fix new checkstyle issues in models
[policy/models.git] / models-dao / src / main / java / org / onap / policy / models / dao / impl / DefaultPfDao.java
index 1bd2e09..e9a10a1 100644 (file)
@@ -26,12 +26,12 @@ 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.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;
@@ -45,6 +45,7 @@ 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;
 
@@ -72,7 +73,7 @@ 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";
@@ -83,8 +84,6 @@ public class DefaultPfDao implements PfDao {
     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 =
@@ -168,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);
@@ -183,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));
@@ -198,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();
@@ -218,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();
@@ -239,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();
@@ -260,7 +259,7 @@ public class DefaultPfDao implements PfDao {
         if (key == null) {
             return;
         }
-        final EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             // @formatter:off
             mg.getTransaction().begin();
@@ -281,7 +280,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) {
@@ -298,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) {
@@ -315,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();
@@ -340,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();
@@ -362,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();
@@ -383,54 +382,27 @@ 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 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();
-
-        String filterQueryString = SELECT_FROM_TABLE + WHERE;
+    public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, PfFilterParametersIntfc filterParams) {
+        final var mg = getEntityManager();
 
         try {
-            PfFilter timeStampFilter = new PfFilterFactory().createFilter(someClass);
-            filterQueryString = timeStampFilter.addFilter(filterQueryString,
-                  name, startTime, endTime, filterMap, sortOrder, getRecordNum);
-
+            PfFilter filter = new PfFilterFactory().createFilter(someClass);
+            String filterQueryString = SELECT_FROM_TABLE
+                            + filter.genWhereClause(filterParams)
+                            + filter.genOrderClause(filterParams);
 
             TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
-
-            if (filterMap != null) {
-                for (Map.Entry<String, Object> 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 {
-                if (endTime != null) {
-                    query.setParameter("endTime", Timestamp.from(endTime));
-                }
-            }
-            if (getRecordNum > 0) {
-                query.setMaxResults(getRecordNum);
-            }
+            filter.setParams(query, filterParams);
 
             LOGGER.debug("filterQueryString is  \"{}\"", filterQueryString);
             return query.getResultList();
-        }  finally {
+        } finally {
             mg.close();
         }
     }
@@ -464,9 +436,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);
             }
@@ -481,7 +453,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 {
@@ -494,7 +466,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)
@@ -507,12 +479,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)
@@ -529,7 +522,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)
@@ -542,14 +535,13 @@ public class DefaultPfDao implements PfDao {
     }
 
     @Override
-    public <T extends PfConcept> List<T> getByTimestamp(final Class<T> someClass,
-                                                        final PfGeneratedIdKey key,
-                                                        final Instant timeStamp) {
+    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 EntityManager mg = getEntityManager();
+        final var mg = getEntityManager();
         try {
             // @formatter:off
             return mg.createQuery(setQueryTable(SELECT_BY_TIMESTAMP_NOKEY, someClass), someClass)
@@ -568,7 +560,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
@@ -589,7 +581,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
@@ -608,7 +600,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();
@@ -626,10 +618,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();
@@ -652,19 +648,20 @@ public class DefaultPfDao implements PfDao {
      * 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 searchFilter the search filter
      * @param resultList the result list returned by the query
      * @return the single unique result
      */
-    private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter, List<T> ret) {
-        if (ret == null || ret.isEmpty()) {
+    private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter,
+                    List<T> 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 ret.get(0);
+        return resultList.get(0);
     }
 
     /**
@@ -672,7 +669,7 @@ public class DefaultPfDao implements PfDao {
      *
      * @param <T> 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
+     * @param objToCheck the object that was retrieved from the database
      * @return the checked object or null
      */
     private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {