aboutsummaryrefslogtreecommitdiffstats
path: root/runtime-acm/src/main/java/org/onap/policy/clamp/acm/runtime/supervision/comm/ParticipantPrimePublisher.java
blob: f3fcfe67aed919ea26285bdb06bf835ec0245cbe (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
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2021-2023 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.runtime.supervision.comm;

import io.micrometer.core.annotation.Timed;
import java.time.Instant;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import lombok.AllArgsConstructor;
import org.onap.policy.clamp.acm.runtime.main.parameters.AcRuntimeParameterGroup;
import org.onap.policy.clamp.acm.runtime.participants.AcmParticipantProvider;
import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
import org.onap.policy.clamp.models.acm.concepts.ParticipantDefinition;
import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantPrime;
import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
import org.onap.policy.clamp.models.acm.utils.AcmUtils;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

/**
 * This class is used to send ParticipantPrime messages to participants on DMaaP.
 */
@Component
@AllArgsConstructor
public class ParticipantPrimePublisher extends AbstractParticipantPublisher<ParticipantPrime> {

    private static final Logger LOGGER = LoggerFactory.getLogger(ParticipantPrimePublisher.class);

    private final ParticipantProvider participantProvider;
    private final AcmParticipantProvider acmParticipantProvider;
    private final AcRuntimeParameterGroup acRuntimeParameterGroup;

    /**
     * Send ParticipantPrime to Participant
     * if participantId is null then message is broadcast.
     *
     * @param participantDefinitions the list of ParticipantDefinition to send
     * @param compositionId the compositionId
     * @param participantId the ParticipantId
     */
    @Timed(value = "publisher.participant_update", description = "PARTICIPANT_UPDATE messages published")
    public void sendPriming(List<ParticipantDefinition> participantDefinitions, UUID compositionId,
            UUID participantId) {
        var message = new ParticipantPrime();
        message.setCompositionId(compositionId);
        message.setParticipantId(participantId);
        message.setTimestamp(Instant.now());
        message.setParticipantDefinitionUpdates(participantDefinitions);
        LOGGER.debug("Participant Update sent {}", message);
        super.send(message);
    }

    /**
     * Prepare the Priming message creating the list of ParticipantDefinition to send
     * and fill the ElementState map of the AC Definition.
     *
     * @param acmDefinition the AutomationComposition Definition
     * @return list of ParticipantDefinition
     */
    public List<ParticipantDefinition> prepareParticipantPriming(AutomationCompositionDefinition acmDefinition) {
        acmDefinition.setState(AcTypeState.PRIMING);
        var acElements = AcmUtils.extractAcElementsFromServiceTemplate(acmDefinition.getServiceTemplate(),
                acRuntimeParameterGroup.getAcmParameters().getToscaElementName());
        Map<ToscaConceptIdentifier, UUID> supportedElementMap = new HashMap<>();
        var participantIds = new HashSet<UUID>();
        if (AcTypeState.PRIMED.equals(acmDefinition.getState())) {
            // scenario Prime again, participants already assigned
            for (var elementEntry : acElements) {
                var elementState = acmDefinition.getElementStateMap().get(elementEntry.getKey());
                elementState.setState(AcTypeState.PRIMING);
                participantIds.add(elementState.getParticipantId());
                var type = new ToscaConceptIdentifier(elementEntry.getValue().getType(),
                        elementEntry.getValue().getTypeVersion());
                supportedElementMap.put(type, elementState.getParticipantId());
            }
        } else {
            // scenario Prime participants not assigned yet
            supportedElementMap = participantProvider.getSupportedElementMap();
            for (var elementEntry : acElements) {
                var elementState = acmDefinition.getElementStateMap().get(elementEntry.getKey());
                elementState.setState(AcTypeState.PRIMING);
                var type = new ToscaConceptIdentifier(elementEntry.getValue().getType(),
                        elementEntry.getValue().getTypeVersion());
                var participantId = supportedElementMap.get(type);
                if (participantId != null) {
                    elementState.setParticipantId(participantId);
                    participantIds.add(participantId);
                }
            }
        }
        acmParticipantProvider.verifyParticipantState(participantIds);
        return AcmUtils.prepareParticipantPriming(acElements, supportedElementMap);
    }

    /**
     * Send ParticipantPrime to Participant after that commissioning has been removed.
     */
    @Timed(value = "publisher.participant_update", description = "PARTICIPANT_UPDATE messages published")
    public void sendDepriming(UUID compositionId) {
        var message = new ParticipantPrime();
        message.setCompositionId(compositionId);
        message.setTimestamp(Instant.now());
        // DeCommission the automation composition but deleting participantdefinitions on participants
        message.setParticipantDefinitionUpdates(null);

        LOGGER.debug("Participant Update sent {}", message);
        super.send(message);
    }
}