aboutsummaryrefslogtreecommitdiffstats
path: root/models/src/main/java/org/onap/policy/clamp/controlloop/models/controlloop/persistence/provider/ClElementStatisticsProvider.java
blob: 8a06cbf1efb78b27b9798469b85d0722b98e9d49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2021 Nordix Foundation.
 * ================================================================================
 * 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.clamp.controlloop.models.controlloop.persistence.provider;

import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import javax.ws.rs.core.Response;
import lombok.NonNull;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatistics;
import org.onap.policy.clamp.controlloop.models.controlloop.persistence.concepts.JpaClElementStatistics;
import org.onap.policy.common.parameters.BeanValidationResult;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.base.PfModelRuntimeException;
import org.onap.policy.models.base.PfReferenceTimestampKey;
import org.onap.policy.models.provider.PolicyModelsProviderParameters;
import org.onap.policy.models.provider.impl.AbstractModelsProvider;

/**
 * This class provides the provision of information on control loop element statistics in the database to callers.
 *
 * @author Ramesh Murugan Iyer (ramesh.murugan.iyer@est.tech)
 */
public class ClElementStatisticsProvider extends AbstractModelsProvider {

    /**
     * Create a provider for control loop element statistics.
     *
     * @param parameters the parameters for database access
     * @throws PfModelException on initiation errors
     */
    public ClElementStatisticsProvider(@NonNull PolicyModelsProviderParameters parameters) throws PfModelException {
        super(parameters);
        this.init();
    }

    /**
     * Creates control loop element statistics.
     *
     * @param clElementStatisticsList a specification of the CL element statistics to create
     * @return the clElement statistics created
     * @throws PfModelException on errors creating clElement statistics
     */
    public List<ClElementStatistics> createClElementStatistics(
            @NonNull final List<ClElementStatistics> clElementStatisticsList) throws PfModelException {

        BeanValidationResult validationResult =
                new BeanValidationResult("control loop element statistics list", clElementStatisticsList);
        for (ClElementStatistics clElementStatistics : clElementStatisticsList) {
            JpaClElementStatistics jpaClElementStatistics = new JpaClElementStatistics();
            jpaClElementStatistics.fromAuthorative(clElementStatistics);

            validationResult.addResult(jpaClElementStatistics.validate("control loop element statistics"));
        }

        if (!validationResult.isValid()) {
            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult());
        }

        for (ClElementStatistics clElementStatistics : clElementStatisticsList) {
            JpaClElementStatistics jpaClElementStatistics = new JpaClElementStatistics();
            jpaClElementStatistics.fromAuthorative(clElementStatistics);
            getPfDao().create(jpaClElementStatistics);
        }

        // Return the created control loop element statistics
        List<ClElementStatistics> elementStatistics = new ArrayList<>(clElementStatisticsList.size());

        for (ClElementStatistics clElementStat : clElementStatisticsList) {
            JpaClElementStatistics jpaClElementStatistics = getPfDao().get(JpaClElementStatistics.class,
                new PfReferenceTimestampKey(clElementStat.getParticipantId().getName(),
                    clElementStat.getParticipantId().getVersion(), clElementStat.getId().toString(),
                    clElementStat.getTimeStamp()));
            elementStatistics.add(jpaClElementStatistics.toAuthorative());
        }

        return elementStatistics;
    }

    /**
     * Convert JPA clElement statistics list to clElement statistics list.
     *
     * @param jpaClElementStatistics the list to convert
     * @return the clElement statistics list
     */
    private List<ClElementStatistics> asClElementStatisticsList(List<JpaClElementStatistics> jpaClElementStatistics) {
        return jpaClElementStatistics.stream().map(JpaClElementStatistics::toAuthorative).collect(Collectors.toList());
    }

    /**
     * Get clElement statistics.
     *
     * @param name the name of the participant
     * @param version version of the participant
     * @param id of the control loop element
     * @param timestamp timestamp of the statistics
     * @return the clElement statistics found
     * @throws PfModelException on errors getting clElement statistics
     */
    public List<ClElementStatistics> getClElementStatistics(final String name, final String version, final String id,
            final Instant timestamp) throws PfModelException {
        List<ClElementStatistics> clElementStatistics = new ArrayList<>(1);
        if (name != null && version != null && timestamp != null && id != null) {
            clElementStatistics.add(getPfDao()
                .get(JpaClElementStatistics.class, new PfReferenceTimestampKey(name, version, id, timestamp))
                .toAuthorative());
            return clElementStatistics;
        } else if (name != null) {
            clElementStatistics.addAll(getFilteredClElementStatistics(name, version, null, null, null,
                "DESC", 0));
        } else {
            clElementStatistics.addAll(asClElementStatisticsList(getPfDao().getAll(JpaClElementStatistics.class)));
        }
        return  clElementStatistics;
    }

    /**
     * Get filtered clElement statistics.
     *
     * @param name the clElement name for the statistics to get
     * @param startTimeStamp startTimeStamp to filter statistics
     * @param endTimeStamp endTimeStamp to filter statistics
     * @param sortOrder sortOrder to query database
     * @param getRecordNum Total query count from database
     * @return the clElement statistics found
     * @throws PfModelException on errors getting policies
     */
    public List<ClElementStatistics> getFilteredClElementStatistics(final String name, final String version,
            final Instant startTimeStamp, final Instant endTimeStamp, Map<String, Object> filterMap,
            final String sortOrder, final int getRecordNum) {
        return asClElementStatisticsList(getPfDao().getFiltered(JpaClElementStatistics.class, name, version,
                startTimeStamp, endTimeStamp, filterMap, sortOrder, getRecordNum));
    }
}