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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021-2024 Nordix Foundation.
* Modifications Copyright (C) 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.clamp.acm.participant.intermediary.handler;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.onap.policy.clamp.acm.participant.intermediary.api.CompositionElementDto;
import org.onap.policy.clamp.acm.participant.intermediary.api.InstanceElementDto;
import org.onap.policy.clamp.acm.participant.intermediary.comm.ParticipantMessagePublisher;
import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
import org.onap.policy.clamp.models.acm.concepts.DeployState;
import org.onap.policy.clamp.models.acm.concepts.ParticipantDeploy;
import org.onap.policy.clamp.models.acm.concepts.ParticipantUtils;
import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.AutomationCompositionDeploy;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.AutomationCompositionDeployAck;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.AutomationCompositionMigration;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.AutomationCompositionStateChange;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantMessageType;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.PropertiesUpdate;
import org.onap.policy.clamp.models.acm.messages.rest.instantiation.DeployOrder;
import org.onap.policy.clamp.models.acm.utils.AcmUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
/*
* This class is responsible for managing the state of all automation compositions in the participant.
*/
@Component
@RequiredArgsConstructor
public class AutomationCompositionHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(AutomationCompositionHandler.class);
private final CacheProvider cacheProvider;
private final ParticipantMessagePublisher publisher;
private final ThreadHandler listener;
/**
* Handle a automation composition state change message.
*
* @param stateChangeMsg the state change message
*/
public void handleAutomationCompositionStateChange(AutomationCompositionStateChange stateChangeMsg) {
if (stateChangeMsg.getAutomationCompositionId() == null) {
return;
}
var automationComposition = cacheProvider.getAutomationComposition(stateChangeMsg.getAutomationCompositionId());
if (automationComposition == null) {
if (DeployOrder.DELETE.equals(stateChangeMsg.getDeployOrderedState())) {
var automationCompositionAck = new AutomationCompositionDeployAck(
ParticipantMessageType.AUTOMATION_COMPOSITION_STATECHANGE_ACK);
automationCompositionAck.setParticipantId(cacheProvider.getParticipantId());
automationCompositionAck.setMessage("Already deleted or never used");
automationCompositionAck.setResult(true);
automationCompositionAck.setStateChangeResult(StateChangeResult.NO_ERROR);
automationCompositionAck.setResponseTo(stateChangeMsg.getMessageId());
automationCompositionAck.setAutomationCompositionId(stateChangeMsg.getAutomationCompositionId());
publisher.sendAutomationCompositionAck(automationCompositionAck);
} else {
LOGGER.debug("Automation composition {} does not use this participant",
stateChangeMsg.getAutomationCompositionId());
}
return;
}
switch (stateChangeMsg.getDeployOrderedState()) {
case UNDEPLOY -> handleUndeployState(stateChangeMsg.getMessageId(), automationComposition,
stateChangeMsg.getStartPhase());
case DELETE -> handleDeleteState(stateChangeMsg.getMessageId(), automationComposition,
stateChangeMsg.getStartPhase());
default ->
LOGGER.error("StateChange message has no state, state is null {}", automationComposition.getKey());
}
}
/**
* Handle a automation composition properties update message.
*
* @param updateMsg the properties update message
*/
public void handleAcPropertyUpdate(PropertiesUpdate updateMsg) {
if (updateMsg.getParticipantUpdatesList().isEmpty()) {
LOGGER.warn("No AutomationCompositionElement updates in message {}",
updateMsg.getAutomationCompositionId());
return;
}
for (var participantDeploy : updateMsg.getParticipantUpdatesList()) {
if (cacheProvider.getParticipantId().equals(participantDeploy.getParticipantId())) {
var acCopy = new AutomationComposition(cacheProvider.getAutomationComposition(
updateMsg.getAutomationCompositionId()));
updateExistingElementsOnThisParticipant(updateMsg.getAutomationCompositionId(), participantDeploy,
DeployState.UPDATING);
callParticipantUpdateProperty(updateMsg.getMessageId(), participantDeploy.getAcElementList(), acCopy);
}
}
}
/**
* Handle a automation composition Deploy message.
*
* @param deployMsg the Deploy message
*/
public void handleAutomationCompositionDeploy(AutomationCompositionDeploy deployMsg) {
if (deployMsg.getParticipantUpdatesList().isEmpty()) {
LOGGER.warn("No AutomationCompositionElement deploy in message {}", deployMsg.getAutomationCompositionId());
return;
}
for (var participantDeploy : deployMsg.getParticipantUpdatesList()) {
if (cacheProvider.getParticipantId().equals(participantDeploy.getParticipantId())) {
if (deployMsg.isFirstStartPhase()) {
cacheProvider.initializeAutomationComposition(deployMsg.getCompositionId(),
deployMsg.getAutomationCompositionId(), participantDeploy);
}
callParticipanDeploy(deployMsg.getMessageId(), participantDeploy.getAcElementList(),
deployMsg.getStartPhase(), deployMsg.getAutomationCompositionId());
}
}
}
private void callParticipanDeploy(UUID messageId, List<AcElementDeploy> acElementDeployList,
Integer startPhaseMsg, UUID instanceId) {
var automationComposition = cacheProvider.getAutomationComposition(instanceId);
for (var elementDeploy : acElementDeployList) {
var element = automationComposition.getElements().get(elementDeploy.getId());
var compositionInProperties = cacheProvider
.getCommonProperties(automationComposition.getCompositionId(), element.getDefinition());
int startPhase = ParticipantUtils.findStartPhase(compositionInProperties);
if (startPhaseMsg.equals(startPhase)) {
var compositionElement = cacheProvider.createCompositionElementDto(
automationComposition.getCompositionId(), element, compositionInProperties);
var instanceElement = new InstanceElementDto(instanceId, elementDeploy.getId(),
elementDeploy.getToscaServiceTemplateFragment(),
elementDeploy.getProperties(), element.getOutProperties());
listener.deploy(messageId, compositionElement, instanceElement);
}
}
}
private Map<UUID, CompositionElementDto> getCompositionElementDtoMap(AutomationComposition automationComposition,
UUID compositionId) {
Map<UUID, CompositionElementDto> map = new HashMap<>();
for (var element : automationComposition.getElements().values()) {
var compositionInProperties = cacheProvider.getCommonProperties(compositionId, element.getDefinition());
var compositionElement = cacheProvider
.createCompositionElementDto(compositionId, element, compositionInProperties);
map.put(element.getId(), compositionElement);
}
return map;
}
private Map<UUID, CompositionElementDto> getCompositionElementDtoMap(AutomationComposition automationComposition) {
return getCompositionElementDtoMap(automationComposition, automationComposition.getCompositionId());
}
private Map<UUID, InstanceElementDto> getInstanceElementDtoMap(AutomationComposition automationComposition) {
Map<UUID, InstanceElementDto> map = new HashMap<>();
for (var element : automationComposition.getElements().values()) {
var instanceElement = new InstanceElementDto(automationComposition.getInstanceId(), element.getId(),
null, element.getProperties(), element.getOutProperties());
map.put(element.getId(), instanceElement);
}
return map;
}
private void callParticipantUpdateProperty(UUID messageId, List<AcElementDeploy> acElements,
AutomationComposition acCopy) {
var instanceElementDtoMap = getInstanceElementDtoMap(acCopy);
var instanceElementDtoMapUpdated = getInstanceElementDtoMap(
cacheProvider.getAutomationComposition(acCopy.getInstanceId()));
var compositionElementDtoMap = getCompositionElementDtoMap(acCopy);
for (var acElement : acElements) {
listener.update(messageId, compositionElementDtoMap.get(acElement.getId()),
instanceElementDtoMap.get(acElement.getId()), instanceElementDtoMapUpdated.get(acElement.getId()));
}
}
private void updateExistingElementsOnThisParticipant(UUID instanceId, ParticipantDeploy participantDeploy,
DeployState deployState) {
var acElementList = cacheProvider.getAutomationComposition(instanceId).getElements();
for (var element : participantDeploy.getAcElementList()) {
var acElement = acElementList.get(element.getId());
AcmUtils.recursiveMerge(acElement.getProperties(), element.getProperties());
acElement.setDeployState(deployState);
acElement.setDefinition(element.getDefinition());
}
}
/**
* Method to handle when the new state from participant is UNINITIALISED state.
*
* @param messageId the messageId
* @param automationComposition participant response
* @param startPhaseMsg startPhase from message
*/
private void handleUndeployState(UUID messageId, final AutomationComposition automationComposition,
Integer startPhaseMsg) {
automationComposition.setCompositionTargetId(null);
for (var element : automationComposition.getElements().values()) {
var compositionInProperties = cacheProvider
.getCommonProperties(automationComposition.getCompositionId(), element.getDefinition());
int startPhase = ParticipantUtils.findStartPhase(compositionInProperties);
if (startPhaseMsg.equals(startPhase)) {
element.setDeployState(DeployState.UNDEPLOYING);
var compositionElement = cacheProvider.createCompositionElementDto(
automationComposition.getCompositionId(), element, compositionInProperties);
var instanceElement = new InstanceElementDto(automationComposition.getInstanceId(), element.getId(),
null, element.getProperties(), element.getOutProperties());
listener.undeploy(messageId, compositionElement, instanceElement);
}
}
}
private void handleDeleteState(UUID messageId, final AutomationComposition automationComposition,
Integer startPhaseMsg) {
for (var element : automationComposition.getElements().values()) {
var compositionInProperties = cacheProvider
.getCommonProperties(automationComposition.getCompositionId(), element.getDefinition());
int startPhase = ParticipantUtils.findStartPhase(compositionInProperties);
if (startPhaseMsg.equals(startPhase)) {
element.setDeployState(DeployState.DELETING);
var compositionElement = cacheProvider.createCompositionElementDto(
automationComposition.getCompositionId(), element, compositionInProperties);
var instanceElement = new InstanceElementDto(automationComposition.getInstanceId(), element.getId(),
null, element.getProperties(), element.getOutProperties());
listener.delete(messageId, compositionElement, instanceElement);
}
}
}
/**
* Handles AutomationComposition Migration.
*
* @param migrationMsg the AutomationCompositionMigration
*/
public void handleAutomationCompositionMigration(AutomationCompositionMigration migrationMsg) {
if (migrationMsg.getAutomationCompositionId() == null || migrationMsg.getCompositionTargetId() == null) {
return;
}
var automationComposition = cacheProvider.getAutomationComposition(migrationMsg.getAutomationCompositionId());
if (automationComposition == null) {
LOGGER.debug("Automation composition {} does not use this participant",
migrationMsg.getAutomationCompositionId());
return;
}
var acCopy = new AutomationComposition(automationComposition);
automationComposition.setCompositionTargetId(migrationMsg.getCompositionTargetId());
for (var participantDeploy : migrationMsg.getParticipantUpdatesList()) {
if (cacheProvider.getParticipantId().equals(participantDeploy.getParticipantId())) {
updateExistingElementsOnThisParticipant(migrationMsg.getAutomationCompositionId(), participantDeploy,
DeployState.MIGRATING);
callParticipantMigrate(migrationMsg.getMessageId(), participantDeploy.getAcElementList(),
acCopy, migrationMsg.getCompositionTargetId());
}
}
}
private void callParticipantMigrate(UUID messageId, List<AcElementDeploy> acElements,
AutomationComposition acCopy, UUID compositionTargetId) {
var compositionElementMap = getCompositionElementDtoMap(acCopy);
var instanceElementMap = getInstanceElementDtoMap(acCopy);
var automationComposition = cacheProvider.getAutomationComposition(acCopy.getInstanceId());
var compositionElementTargetMap = getCompositionElementDtoMap(automationComposition, compositionTargetId);
var instanceElementMigrateMap = getInstanceElementDtoMap(automationComposition);
for (var acElement : acElements) {
listener.migrate(messageId, compositionElementMap.get(acElement.getId()),
compositionElementTargetMap.get(acElement.getId()),
instanceElementMap.get(acElement.getId()), instanceElementMigrateMap.get(acElement.getId()));
}
}
}
|
