aboutsummaryrefslogtreecommitdiffstats
path: root/tosca-controlloop/models/src/main/java/org/onap/policy/clamp/controlloop/models/controlloop/persistence/provider/ControlLoopProvider.java
blob: 520e9b86403441eca132b0193a988f59b666af21 (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*-
 * ============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.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import javax.ws.rs.core.Response;
import lombok.NonNull;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
import org.onap.policy.clamp.controlloop.models.controlloop.persistence.concepts.JpaControlLoop;
import org.onap.policy.common.parameters.BeanValidationResult;
import org.onap.policy.models.base.PfAuthorative;
import org.onap.policy.models.base.PfConceptKey;
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.provider.PolicyModelsProviderParameters;
import org.onap.policy.models.provider.impl.AbstractModelsProvider;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter;
import org.onap.policy.models.tosca.simple.concepts.JpaToscaNodeTemplate;

/**
 * This class provides information on control loop concepts in the database to callers.
 */
public class ControlLoopProvider extends AbstractModelsProvider {

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

    /**
     * Get Control Loop.
     *
     * @param controlLoopId the ID of the control loop to get
     * @return the control loop found
     * @throws PfModelException on errors getting the control loop
     */
    public ControlLoop getControlLoop(final ToscaConceptIdentifier controlLoopId) throws PfModelException {
        JpaControlLoop jpaControlLoop = getPfDao().get(JpaControlLoop.class, controlLoopId.asConceptKey());

        return jpaControlLoop == null ? null : jpaControlLoop.toAuthorative();
    }

    /**
     * Update Control Loop.
     *
     * @param controlLoop the control loop to update
     * @return the updated control loop
     * @throws PfModelException on errors updating the control loop
     */
    public ControlLoop updateControlLoop(final ControlLoop controlLoop) throws PfModelException {
        return updateControlLoops(Collections.singletonList(controlLoop)).get(0);
    }

    /**
     * Get Control Loops.
     *
     * @param name the name of the control loop to get, null to get all control loops
     * @param version the version of the control loop to get, null to get all control loops
     * @return the control loops found
     * @throws PfModelException on errors getting control loops
     */
    public List<ControlLoop> getControlLoops(final String name, final String version) throws PfModelException {

        return asEntityList(getPfDao().getFiltered(JpaControlLoop.class, name, version));
    }

    /**
     * Get filtered control loops.
     *
     * @param filter the filter for the control loops to get
     * @return the control loops found
     * @throws PfModelException on errors getting control loops
     */
    public List<ControlLoop> getFilteredControlLoops(@NonNull final ToscaTypedEntityFilter<ControlLoop> filter) {

        return filter.filter(
                asEntityList(getPfDao().getFiltered(JpaControlLoop.class, filter.getName(), PfKey.NULL_KEY_VERSION)));
    }

    /**
     * Creates control loops.
     *
     * @param controlLoops a specification of the control loops to create
     * @return the control loops created
     * @throws PfModelException on errors creating control loops
     */
    public List<ControlLoop> createControlLoops(@NonNull final List<ControlLoop> controlLoops) throws PfModelException {

        BeanValidationResult validationResult = new BeanValidationResult("control loops", controlLoops);

        for (ControlLoop controlLoop : controlLoops) {
            JpaControlLoop jpaControlLoop = new JpaControlLoop();
            jpaControlLoop.fromAuthorative(controlLoop);

            validationResult.addResult(jpaControlLoop.validate("control loop"));
        }

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

        for (ControlLoop controlLoop : controlLoops) {
            JpaControlLoop jpaControlLoop = new JpaControlLoop();
            jpaControlLoop.fromAuthorative(controlLoop);

            getPfDao().create(jpaControlLoop);
        }

        // Return the created control loops
        List<ControlLoop> returnControlLoops = new ArrayList<>(controlLoops.size());

        for (ControlLoop controlLoop : controlLoops) {
            JpaControlLoop jpaControlLoop = getPfDao().get(JpaControlLoop.class,
                    new PfConceptKey(controlLoop.getName(), controlLoop.getVersion()));
            returnControlLoops.add(jpaControlLoop.toAuthorative());
        }

        return returnControlLoops;
    }

    /**
     * Updates control loops.
     *
     * @param controlLoops a specification of the control loops to update
     * @return the control loops updated
     * @throws PfModelException on errors updating control loops
     */
    public List<ControlLoop> updateControlLoops(@NonNull final List<ControlLoop> controlLoops) throws PfModelException {

        BeanValidationResult validationResult = new BeanValidationResult("control loops", controlLoops);

        for (ControlLoop controlLoop : controlLoops) {
            JpaControlLoop jpaControlLoop = new JpaControlLoop();
            jpaControlLoop.fromAuthorative(controlLoop);

            validationResult.addResult(jpaControlLoop.validate("control loop"));
        }

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

        // Return the created control loops
        List<ControlLoop> returnControlLoops = new ArrayList<>(controlLoops.size());

        for (ControlLoop controlLoop : controlLoops) {
            JpaControlLoop jpaControlLoop = new JpaControlLoop();
            jpaControlLoop.fromAuthorative(controlLoop);

            JpaControlLoop returnJpaControlLoop = getPfDao().update(jpaControlLoop);
            returnControlLoops.add(returnJpaControlLoop.toAuthorative());
        }

        return returnControlLoops;
    }

    /**
     * Delete a control loop.
     *
     * @param name the name of the control loop to delete
     * @param version the version of the control loop to delete
     * @return the control loop deleted
     * @throws PfModelException on errors deleting the control loop
     */
    public ControlLoop deleteControlLoop(@NonNull final String name, @NonNull final String version) {

        PfConceptKey controlLoopKey = new PfConceptKey(name, version);

        JpaControlLoop jpaDeleteControlLoop = getPfDao().get(JpaControlLoop.class, controlLoopKey);

        if (jpaDeleteControlLoop == null) {
            String errorMessage =
                    "delete of control loop \"" + controlLoopKey.getId() + "\" failed, control loop does not exist";
            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
        }

        getPfDao().delete(jpaDeleteControlLoop);

        return jpaDeleteControlLoop.toAuthorative();
    }

    /**
     * Get Node Templates.
     *
     * @param name the name of the node template to get, null to get all node templates
     * @param version the version of the node template to get, null to get all node templates
     * @return the node templates found
     * @throws PfModelException on errors getting node templates
     */
    public List<ToscaNodeTemplate> getNodeTemplates(final String name, final String version) {
        return asEntityList(getPfDao().getFiltered(JpaToscaNodeTemplate.class, name, version));
    }

    /**
     * Get filtered node templates.
     *
     * @param filter the filter for the node templates to get
     * @return the node templates found
     * @throws PfModelException on errors getting node templates
     */
    public List<ToscaNodeTemplate> getFilteredNodeTemplates(
            @NonNull final ToscaTypedEntityFilter<ToscaNodeTemplate> filter) {

        return filter.filter(asEntityList(
                getPfDao().getFiltered(JpaToscaNodeTemplate.class, filter.getName(), filter.getVersion())));
    }

    /**
     * Convert JPA control loop list to an authorative control loop list.
     *
     * @param jpaEntityList the list to convert
     * @return the authorative list
     */
    private <T extends ToscaEntity, J extends PfAuthorative<T>> List<T> asEntityList(List<J> jpaEntityList) {
        return jpaEntityList.stream().map(J::toAuthorative).collect(Collectors.toList());
    }
}