gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider;
  22
  23 import java.time.Instant;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.stream.Collectors;
  28 import lombok.NonNull;
  29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatistics;
  30 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.concepts.JpaClElementStatistics;
  31 import org.onap.policy.models.base.PfModelException;
  32 import org.onap.policy.models.base.PfReferenceTimestampKey;
  33 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  34 import org.onap.policy.models.provider.impl.AbstractModelsProvider;
  35
  36 /**
  37  * This class provides the provision of information on control loop element statistics in the database to callers.
  38  *
  39  * @author Ramesh Murugan Iyer (ramesh.murugan.iyer@est.tech)
  40  */
  41 public class ClElementStatisticsProvider extends AbstractModelsProvider {
  42
  43     /**
  44      * Create a provider for control loop element statistics.
  45      *
  46      * @param parameters the parameters for database access
  47      * @throws PfModelException on initiation errors
  48      */
  49     public ClElementStatisticsProvider(@NonNull PolicyModelsProviderParameters parameters) throws PfModelException {
  50         super(parameters);
  51         this.init();
  52     }
  53
  54     /**
  55      * Creates control loop element statistics.
  56      *
  57      * @param clElementStatisticsList a specification of the CL element statistics to create
  58      * @return the clElement statistics created
  59      * @throws PfModelException on errors creating clElement statistics
  60      */
  61     public List<ClElementStatistics> createClElementStatistics(
  62             @NonNull final List<ClElementStatistics> clElementStatisticsList) throws PfModelException {
  63
  64         List<JpaClElementStatistics> jpaClElementStatisticsList = ProviderUtils.getJpaAndValidate(
  65                 clElementStatisticsList, JpaClElementStatistics::new, "control loop element statistics");
  66
  67         jpaClElementStatisticsList.forEach(jpaClElementStatistics -> getPfDao().create(jpaClElementStatistics));
  68
  69         // Return the created control loop element statistics
  70         List<ClElementStatistics> elementStatistics = new ArrayList<>(clElementStatisticsList.size());
  71
  72         for (ClElementStatistics clElementStat : clElementStatisticsList) {
  73             var jpaClElementStatistics = getPfDao().get(JpaClElementStatistics.class,
  74                     new PfReferenceTimestampKey(clElementStat.getParticipantId().getName(),
  75                             clElementStat.getParticipantId().getVersion(), clElementStat.getId().toString(),
  76                             clElementStat.getTimeStamp()));
  77             elementStatistics.add(jpaClElementStatistics.toAuthorative());
  78         }
  79
  80         return elementStatistics;
  81     }
  82
  83     /**
  84      * Convert JPA clElement statistics list to clElement statistics list.
  85      *
  86      * @param jpaClElementStatistics the list to convert
  87      * @return the clElement statistics list
  88      */
  89     private List<ClElementStatistics> asClElementStatisticsList(List<JpaClElementStatistics> jpaClElementStatistics) {
  90         return jpaClElementStatistics.stream().map(JpaClElementStatistics::toAuthorative).collect(Collectors.toList());
  91     }
  92
  93     /**
  94      * Get clElement statistics.
  95      *
  96      * @param name the name of the participant
  97      * @param version version of the participant
  98      * @param id of the control loop element
  99      * @param timestamp timestamp of the statistics
 100      * @return the clElement statistics found
 101      * @throws PfModelException on errors getting clElement statistics
 102      */
 103     public List<ClElementStatistics> getClElementStatistics(final String name, final String version, final String id,
 104             final Instant timestamp) throws PfModelException {
 105         List<ClElementStatistics> clElementStatistics = new ArrayList<>(1);
 106         if (name != null && version != null && timestamp != null && id != null) {
 107             clElementStatistics.add(getPfDao()
 108                     .get(JpaClElementStatistics.class, new PfReferenceTimestampKey(name, version, id, timestamp))
 109                     .toAuthorative());
 110             return clElementStatistics;
 111         } else if (name != null) {
 112             clElementStatistics.addAll(getFilteredClElementStatistics(name, version, null, null, null, "DESC", 0));
 113         } else {
 114             clElementStatistics.addAll(asClElementStatisticsList(getPfDao().getAll(JpaClElementStatistics.class)));
 115         }
 116         return clElementStatistics;
 117     }
 118
 119     /**
 120      * Get filtered clElement statistics.
 121      *
 122      * @param name the clElement name for the statistics to get
 123      * @param startTimeStamp startTimeStamp to filter statistics
 124      * @param endTimeStamp endTimeStamp to filter statistics
 125      * @param sortOrder sortOrder to query database
 126      * @param getRecordNum Total query count from database
 127      * @return the clElement statistics found
 128      * @throws PfModelException on errors getting policies
 129      */
 130     public List<ClElementStatistics> getFilteredClElementStatistics(final String name, final String version,
 131             final Instant startTimeStamp, final Instant endTimeStamp, Map<String, Object> filterMap,
 132             final String sortOrder, final int getRecordNum) {
 133         return asClElementStatisticsList(getPfDao().getFiltered(JpaClElementStatistics.class, name, version,
 134                 startTimeStamp, endTimeStamp, filterMap, sortOrder, getRecordNum));
 135     }
 136 }