7b39360f0e4074de93d36814c67c6f7a9cb167f5
[policy/clamp.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  * Copyright (C) 2021-2023 Nordix Foundation.
4  * ================================================================================
5  * Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  * SPDX-License-Identifier: Apache-2.0
20  * ============LICENSE_END=========================================================
21  */
22
23 package org.onap.policy.clamp.models.acm.persistence.provider;
24
25 import java.util.ArrayList;
26 import java.util.List;
27 import java.util.Optional;
28 import java.util.UUID;
29 import javax.ws.rs.core.Response;
30 import javax.ws.rs.core.Response.Status;
31 import lombok.AllArgsConstructor;
32 import lombok.NonNull;
33 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
34 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionInfo;
35 import org.onap.policy.clamp.models.acm.concepts.DeployState;
36 import org.onap.policy.clamp.models.acm.concepts.LockState;
37 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaAutomationComposition;
38 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaAutomationCompositionElement;
39 import org.onap.policy.clamp.models.acm.persistence.repository.AutomationCompositionElementRepository;
40 import org.onap.policy.clamp.models.acm.persistence.repository.AutomationCompositionRepository;
41 import org.onap.policy.clamp.models.acm.utils.AcmUtils;
42 import org.onap.policy.models.base.PfModelRuntimeException;
43 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
44 import org.springframework.data.domain.Example;
45 import org.springframework.stereotype.Service;
46 import org.springframework.transaction.annotation.Transactional;
47
48 /**
49  * This class provides information on automation composition concepts in the database to callers.
50  */
51 @Service
52 @Transactional
53 @AllArgsConstructor
54 public class AutomationCompositionProvider {
55
56     private final AutomationCompositionRepository automationCompositionRepository;
57     private final AutomationCompositionElementRepository acElementRepository;
58
59     /**
60      * Get automation composition.
61      *
62      * @param instanceId the ID of the automation composition to get
63      * @return the automation composition found
64      */
65     @Transactional(readOnly = true)
66     public AutomationComposition getAutomationComposition(final UUID instanceId) {
67         var result = automationCompositionRepository.findById(instanceId.toString());
68         if (result.isEmpty()) {
69             throw new PfModelRuntimeException(Status.NOT_FOUND, "AutomationComposition not found");
70         }
71         return result.get().toAuthorative();
72     }
73
74     /**
75      * Find automation composition.
76      *
77      * @param instanceId the ID of the automation composition to get
78      * @return the automation composition found
79      */
80     @Transactional(readOnly = true)
81     public Optional<AutomationComposition> findAutomationComposition(final UUID instanceId) {
82         var result = automationCompositionRepository.findById(instanceId.toString());
83         return result.stream().map(JpaAutomationComposition::toAuthorative).findFirst();
84     }
85
86     /**
87      * Find automation composition by automationCompositionId.
88      *
89      * @param automationCompositionId the ID of the automation composition to get
90      * @return the automation composition found
91      */
92     @Transactional(readOnly = true)
93     public Optional<AutomationComposition> findAutomationComposition(
94             final ToscaConceptIdentifier automationCompositionId) {
95         return automationCompositionRepository
96                 .findOne(createExample(null, automationCompositionId.getName(), automationCompositionId.getVersion()))
97                 .map(JpaAutomationComposition::toAuthorative);
98     }
99
100     /**
101      * Create automation composition.
102      *
103      * @param automationComposition the automation composition to create
104      * @return the create automation composition
105      */
106     public AutomationComposition createAutomationComposition(final AutomationComposition automationComposition) {
107         automationComposition.setInstanceId(UUID.randomUUID());
108         AcmUtils.setCascadedState(automationComposition, DeployState.UNDEPLOYED, LockState.NONE);
109         var result = automationCompositionRepository.save(ProviderUtils.getJpaAndValidate(automationComposition,
110                 JpaAutomationComposition::new, "automation composition"));
111
112         // Return the saved automation composition
113         return result.toAuthorative();
114     }
115
116     /**
117      * Update automation composition.
118      *
119      * @param automationComposition the automation composition to update
120      * @return the updated automation composition
121      */
122     public AutomationComposition updateAutomationComposition(
123             @NonNull final AutomationComposition automationComposition) {
124         var result = automationCompositionRepository.save(ProviderUtils.getJpaAndValidate(automationComposition,
125                 JpaAutomationComposition::new, "automation composition"));
126
127         // Return the saved automation composition
128         return result.toAuthorative();
129     }
130
131     /**
132      * Get all automation compositions by compositionId.
133      *
134      * @param compositionId the compositionId of the automation composition definition
135      * @return all automation compositions found
136      */
137     @Transactional(readOnly = true)
138     public List<AutomationComposition> getAcInstancesByCompositionId(UUID compositionId) {
139         return ProviderUtils
140                 .asEntityList(automationCompositionRepository.findByCompositionId(compositionId.toString()));
141     }
142
143     /**
144      * Get automation compositions.
145      *
146      * @param name the name of the automation composition to get, null to get all automation compositions
147      * @param version the version of the automation composition to get, null to get all automation compositions
148      * @return the automation compositions found
149      */
150     @Transactional(readOnly = true)
151     public List<AutomationComposition> getAutomationCompositions(final UUID compositionId, final String name,
152             final String version) {
153
154         return ProviderUtils
155                 .asEntityList(automationCompositionRepository.findAll(createExample(compositionId, name, version)));
156     }
157
158     private Example<JpaAutomationComposition> createExample(final UUID compositionId, final String name,
159             final String version) {
160         var example = new JpaAutomationComposition();
161         example.setCompositionId(compositionId != null ? compositionId.toString() : null);
162         example.setName(name);
163         example.setVersion(version);
164         example.setInstanceId(null);
165         example.setElements(null);
166         example.setDeployState(null);
167         example.setLockState(null);
168
169         return Example.of(example);
170     }
171
172     /**
173      * Delete a automation composition.
174      *
175      * @param instanceId the ID of the automation composition to get
176      * @return the automation composition deleted
177      */
178     public AutomationComposition deleteAutomationComposition(@NonNull final UUID instanceId) {
179         var jpaDeleteAutomationComposition = automationCompositionRepository.findById(instanceId.toString());
180         if (jpaDeleteAutomationComposition.isEmpty()) {
181             var errorMessage = "delete of automation composition \"" + instanceId
182                     + "\" failed, automation composition does not exist";
183             throw new PfModelRuntimeException(Response.Status.NOT_FOUND, errorMessage);
184         }
185
186         automationCompositionRepository.deleteById(instanceId.toString());
187
188         return jpaDeleteAutomationComposition.get().toAuthorative();
189     }
190
191     /**
192      * Upgrade States.
193      *
194      * @param automationCompositionInfoList list of AutomationCompositionInfo
195      */
196     public void upgradeStates(@NonNull final List<AutomationCompositionInfo> automationCompositionInfoList) {
197         if (automationCompositionInfoList.isEmpty()) {
198             return;
199         }
200         List<JpaAutomationCompositionElement> jpaList = new ArrayList<>();
201         for (var acInstance : automationCompositionInfoList) {
202             for (var element : acInstance.getElements()) {
203                 var jpa = acElementRepository.getReferenceById(element.getAutomationCompositionElementId().toString());
204                 jpa.setUseState(element.getUseState());
205                 jpa.setOperationalState(element.getOperationalState());
206                 jpa.setOutProperties(element.getOutProperties());
207                 jpaList.add(jpa);
208             }
209         }
210         acElementRepository.saveAll(jpaList);
211     }
212 }