Fix issue with GeneratedValue in PfGeneratedIdKey

PfGeneratedIdKey class (which is used as a composite key
in JpaPolicyAudit and JpaPdpStatistics) uses GeneratedValue
in a wrong way and not according to the specification.
This review fixes it. PfGeneratedIdKey class is removed, and the
generatedId is directly specified in the JpaPolicyAudit and
JpaPdpStatistics classes.

Note: These classes are only used by PAP, so the related methods for db
interaction is removed as PAP directly talks to DB using spring
repository layer. Also the only end result this change brings is that the
'generatedId' alone will be used as the primary key instead of
'generatedId, name and version' together.

Corresponding changes in
DB Migrator: https://gerrit.onap.org/r/c/policy/docker/+/127139
PAP: https://gerrit.onap.org/r/c/policy/pap/+/127130

Change-Id: Ib4ea8b60ffe5c2480746569c0354bf474a6b7006
Issue-ID: POLICY-3897
Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>

2 files changed, 60 insertions, 201 deletions

diff --git a/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/concepts/JpaPdpStatistics.java b/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/concepts/JpaPdpStatistics.java
index 0ff60b90f..45e63e404 100644
--- a/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/concepts/JpaPdpStatistics.java
+++ b/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/concepts/JpaPdpStatistics.java
@@ -4,6 +4,7 @@
  * ================================================================================
  * Copyright (C) 2019-2021 Nordix Foundation.
  * Modifications Copyright (C) 2020-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.
@@ -25,15 +26,19 @@ package org.onap.policy.models.pdp.persistence.concepts;
 
 import java.io.Serializable;
 import java.time.Instant;
+import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import javax.persistence.Column;
 import javax.persistence.ElementCollection;
-import javax.persistence.EmbeddedId;
 import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
 import javax.persistence.Inheritance;
 import javax.persistence.InheritanceType;
 import javax.persistence.Table;
+import javax.persistence.TableGenerator;
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
 import lombok.AllArgsConstructor;
@@ -42,13 +47,15 @@ import lombok.EqualsAndHashCode;
 import lombok.NonNull;
 import org.apache.commons.lang3.builder.CompareToBuilder;
 import org.eclipse.persistence.annotations.Index;
-import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.ValidationStatus;
+import org.onap.policy.common.parameters.annotations.Pattern;
 import org.onap.policy.models.base.PfAuthorative;
 import org.onap.policy.models.base.PfConcept;
-import org.onap.policy.models.base.PfGeneratedIdKey;
+import org.onap.policy.models.base.PfConceptKey;
 import org.onap.policy.models.base.PfKey;
 import org.onap.policy.models.base.PfUtils;
-import org.onap.policy.models.base.validation.annotations.VerifyKey;
+import org.onap.policy.models.base.Validated;
 import org.onap.policy.models.pdp.concepts.PdpEngineWorkerStatistics;
 import org.onap.policy.models.pdp.concepts.PdpStatistics;
 
@@ -67,10 +74,24 @@ import org.onap.policy.models.pdp.concepts.PdpStatistics;
 public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStatistics>, Serializable {
     private static final long serialVersionUID = -7312974966820980659L;
 
-    @EmbeddedId
-    @VerifyKey
-    @NotNull
-    private PfGeneratedIdKey key;
+    @Id
+    @Column(name = "ID")
+    @GeneratedValue(strategy = GenerationType.TABLE, generator = "statisticsIdGen")
+    @TableGenerator(
+        name = "statisticsIdGen",
+        table = "sequence",
+        pkColumnName = "SEQ_NAME",
+        valueColumnName = "SEQ_COUNT",
+        pkColumnValue = "SEQ_GEN")
+    private Long generatedId;
+
+    @Column(name = "name", length = 120)
+    @Pattern(regexp = PfKey.NAME_REGEXP)
+    private String name;
+
+    @Column(name = "version", length = 20)
+    @Pattern(regexp = PfKey.VERSION_REGEXP)
+    private String version;
 
     @Column(precision = 3)
     @Temporal(TemporalType.TIMESTAMP)
@@ -116,16 +137,8 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
      * The Default Constructor creates a {@link JpaPdpStatistics} object with a null key.
      */
     public JpaPdpStatistics() {
-        this(new PfGeneratedIdKey());
-    }
-
-    /**
-     * The Key Constructor creates a {@link JpaPdpStatistics} object with the given concept key.
-     *
-     * @param key the key
-     */
-    public JpaPdpStatistics(@NonNull final PfGeneratedIdKey key) {
-        this.key = new PfGeneratedIdKey(key);
+        this.setName(PfKey.NULL_KEY_NAME);
+        this.setVersion(PfKey.NULL_KEY_VERSION);
     }
 
     /**
@@ -135,7 +148,9 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
      */
     public JpaPdpStatistics(@NonNull final JpaPdpStatistics copyConcept) {
         super(copyConcept);
-        this.key = new PfGeneratedIdKey(copyConcept.key);
+        this.name = copyConcept.name;
+        this.version = copyConcept.version;
+        this.generatedId = copyConcept.generatedId;
         this.timeStamp = copyConcept.timeStamp;
         this.pdpGroupName = copyConcept.pdpGroupName;
         this.pdpSubGroupName = copyConcept.pdpSubGroupName;
@@ -174,7 +189,9 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
 
         final JpaPdpStatistics other = (JpaPdpStatistics) otherConcept;
         return new CompareToBuilder()
-                .append(this.key, other.key)
+                .append(this.name, other.name)
+                .append(this.version, other.version)
+                .append(this.generatedId, other.generatedId)
                 .append(this.timeStamp, other.timeStamp)
                 .append(this.pdpGroupName, other.pdpGroupName)
                 .append(this.pdpSubGroupName, other.pdpSubGroupName)
@@ -192,8 +209,8 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
     @Override
     public PdpStatistics toAuthorative() {
         var pdpStatistics = new PdpStatistics();
-        pdpStatistics.setPdpInstanceId(key.getName());
-        pdpStatistics.setGeneratedId(key.getGeneratedId());
+        pdpStatistics.setPdpInstanceId(name);
+        pdpStatistics.setGeneratedId(generatedId);
         pdpStatistics.setTimeStamp(timeStamp.toInstant());
         pdpStatistics.setPdpGroupName(pdpGroupName);
         pdpStatistics.setPdpSubGroupName(pdpSubGroupName);
@@ -213,12 +230,11 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
 
     @Override
     public void fromAuthorative(@NonNull final PdpStatistics pdpStatistics) {
-        if (pdpStatistics.getGeneratedId() == null) {
-            this.setKey(new PfGeneratedIdKey(pdpStatistics.getPdpInstanceId(), PfKey.NULL_KEY_VERSION));
-        } else {
-            this.setKey(new PfGeneratedIdKey(pdpStatistics.getPdpInstanceId(),
-                        PfKey.NULL_KEY_VERSION, pdpStatistics.getGeneratedId()));
+        if (pdpStatistics.getGeneratedId() != null) {
+            this.setGeneratedId(pdpStatistics.getGeneratedId());
         }
+        this.setName(pdpStatistics.getPdpInstanceId());
+        this.setVersion(PfKey.NULL_KEY_VERSION);
         if (pdpStatistics.getTimeStamp() == null) {
             this.setTimeStamp(Date.from(Instant.EPOCH));
         } else {
@@ -241,12 +257,18 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
 
     @Override
     public List<PfKey> getKeys() {
-        return getKey().getKeys();
+        final List<PfKey> keyList = new ArrayList<>();
+        keyList.add(getKey());
+        return keyList;
+    }
+
+    @Override
+    public PfKey getKey() {
+        return new PfConceptKey(name, version);
     }
 
     @Override
     public void clean() {
-        key.clean();
         pdpGroupName = pdpGroupName.trim();
         pdpSubGroupName = pdpSubGroupName.trim();
         if (engineStats != null) {
@@ -255,4 +277,13 @@ public class JpaPdpStatistics extends PfConcept implements PfAuthorative<PdpStat
             }
         }
     }
+
+    @Override
+    public BeanValidationResult validate(@NonNull String fieldName) {
+        BeanValidationResult result = super.validate(fieldName);
+        if (PfKey.NULL_KEY_NAME.equals(name)) {
+            result.addResult("name", name, ValidationStatus.INVALID, Validated.IS_NULL);
+        }
+        return result;
+    }
 }
diff --git a/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpStatisticsProvider.java b/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpStatisticsProvider.java
deleted file mode 100644
index 0b3f32cf5..000000000
--- a/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpStatisticsProvider.java
+++ /dev/null
@@ -1,172 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP Policy Model
- * ================================================================================
- * Copyright (C) 2019-2021 Nordix Foundation.
- * Modifications Copyright (C) 2020-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.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.models.pdp.persistence.provider;
-
-import java.time.Instant;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.stream.Collectors;
-import javax.ws.rs.core.Response;
-import lombok.NonNull;
-import org.onap.policy.common.parameters.BeanValidationResult;
-import org.onap.policy.models.base.PfGeneratedIdKey;
-import org.onap.policy.models.base.PfKey;
-import org.onap.policy.models.base.PfModelException;
-import org.onap.policy.models.base.PfModelRuntimeException;
-import org.onap.policy.models.dao.PfDao;
-import org.onap.policy.models.dao.PfFilterParameters;
-import org.onap.policy.models.pdp.concepts.PdpStatistics;
-import org.onap.policy.models.pdp.persistence.concepts.JpaPdpStatistics;
-
-
-/**
- * This class provides the provision of information on PAP concepts in the database to callers.
- *
- * @author Ning Xi (ning.xi@est.tech)
- */
-public class PdpStatisticsProvider {
-    private static final int DEFAULT_RECORD_COUNT = 10;
-    private static final int MAX_RECORD_COUNT = 100;
-
-    /**
-     * Get filtered PDP statistics.
-     *
-     * @param dao the DAO to use to access the database
-     * @param filterParams filter parameters
-     * @return the PDP statistics found
-     * @throws PfModelException on errors getting policies
-     */
-    public List<PdpStatistics> getFilteredPdpStatistics(@NonNull final PfDao dao,
-                    PdpFilterParameters filterParams) {
-
-        if (filterParams.getRecordNum() <= 0) {
-            filterParams.setRecordNum(DEFAULT_RECORD_COUNT);
-
-        } else if (filterParams.getRecordNum() > MAX_RECORD_COUNT) {
-            filterParams.setRecordNum(MAX_RECORD_COUNT);
-        }
-
-        return asPdpStatisticsList(dao.getFiltered(JpaPdpStatistics.class, filterParams));
-    }
-
-    /**
-     * Creates PDP statistics.
-     *
-     * @param dao the DAO to use to access the database
-     * @param pdpStatisticsList a specification of the PDP statistics to create
-     * @return the PDP statistics created
-     * @throws PfModelException on errors creating PDP statistics
-     */
-    public List<PdpStatistics> createPdpStatistics(@NonNull final PfDao dao,
-            @NonNull final List<PdpStatistics> pdpStatisticsList) throws PfModelException {
-        for (PdpStatistics pdpStatistics : pdpStatisticsList) {
-            var jpaPdpStatistics = new JpaPdpStatistics();
-            jpaPdpStatistics.fromAuthorative(pdpStatistics);
-            BeanValidationResult validationResult = jpaPdpStatistics.validate("pdp statistics");
-            if (!validationResult.isValid()) {
-                throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult());
-            }
-
-            dao.create(jpaPdpStatistics);
-            pdpStatistics.setGeneratedId(jpaPdpStatistics.getKey().getGeneratedId());
-        }
-
-        // Return the created PDP statistics
-        List<PdpStatistics> pdpStatistics = new ArrayList<>(pdpStatisticsList.size());
-
-        for (PdpStatistics pdpStatisticsItem : pdpStatisticsList) {
-            var jpaPdpStatistics =
-                    dao.get(JpaPdpStatistics.class, new PfGeneratedIdKey(pdpStatisticsItem.getPdpInstanceId(),
-                            PfKey.NULL_KEY_VERSION, pdpStatisticsItem.getGeneratedId()));
-            pdpStatistics.add(jpaPdpStatistics.toAuthorative());
-        }
-        return pdpStatistics;
-    }
-
-    /**
-     * Updates PDP statistics.
-     *
-     * @param dao the DAO to use to access the database
-     * @param pdpStatisticsList a specification of the PDP statistics to update
-     * @return the PDP statistics updated
-     * @throws PfModelException on errors updating PDP statistics
-     */
-    public List<PdpStatistics> updatePdpStatistics(@NonNull final PfDao dao,
-            @NonNull final List<PdpStatistics> pdpStatisticsList) throws PfModelException {
-
-        for (PdpStatistics pdpStatistics : pdpStatisticsList) {
-            var jpaPdpStatistics = new JpaPdpStatistics();
-            jpaPdpStatistics.fromAuthorative(pdpStatistics);
-
-            BeanValidationResult validationResult = jpaPdpStatistics.validate("pdp statistics");
-            if (!validationResult.isValid()) {
-                throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult());
-            }
-
-            dao.update(jpaPdpStatistics);
-        }
-
-        // Return the created PDP statistics
-        List<PdpStatistics> pdpStatistics = new ArrayList<>(pdpStatisticsList.size());
-
-        for (PdpStatistics pdpStatisticsItem : pdpStatisticsList) {
-            var jpaPdpStatistics =
-                    dao.get(JpaPdpStatistics.class, new PfGeneratedIdKey(pdpStatisticsItem.getPdpInstanceId(),
-                            PfKey.NULL_KEY_VERSION, pdpStatisticsItem.getGeneratedId()));
-            pdpStatistics.add(jpaPdpStatistics.toAuthorative());
-        }
-
-        return pdpStatistics;
-    }
-
-    /**
-     * Delete a PDP statistics.
-     *
-     * @param dao the DAO to use to access the database
-     * @param name the name of the policy to get, null to get all PDP statistics
-     * @param timestamp the timeStamp of statistics to delete, null to delete all statistics record of given PDP
-     * @return the PDP statistics list deleted
-     * @throws PfModelException on errors deleting PDP statistics
-     */
-    public List<PdpStatistics> deletePdpStatistics(@NonNull final PfDao dao, @NonNull final String name,
-                    final Instant timestamp) {
-        List<PdpStatistics> pdpStatisticsListToDel = asPdpStatisticsList(dao.getFiltered(JpaPdpStatistics.class,
-                        PfFilterParameters.builder().name(name).startTime(timestamp).endTime(timestamp).build()));
-
-        pdpStatisticsListToDel.stream().forEach(s -> dao.delete(JpaPdpStatistics.class,
-                new PfGeneratedIdKey(s.getPdpInstanceId(), PfKey.NULL_KEY_VERSION, s.getGeneratedId())));
-
-        return pdpStatisticsListToDel;
-    }
-
-    /**
-     * Convert JPA PDP statistics list to an PDP statistics list.
-     *
-     * @param jpaPdpStatisticsList the list to convert
-     * @return the PDP statistics list
-     */
-    private List<PdpStatistics> asPdpStatisticsList(List<JpaPdpStatistics> jpaPdpStatisticsList) {
-        return jpaPdpStatisticsList.stream().map(JpaPdpStatistics::toAuthorative).collect(Collectors.toList());
-    }
-}