gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023-2024 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.acm.runtime.supervision;
  22
  23 import io.micrometer.core.annotation.Timed;
  24 import java.util.ArrayList;
  25 import java.util.HashMap;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.UUID;
  29 import lombok.AllArgsConstructor;
  30 import org.apache.commons.collections4.MapUtils;
  31 import org.onap.policy.clamp.acm.runtime.main.parameters.AcRuntimeParameterGroup;
  32 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantDeregisterAckPublisher;
  33 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantRegisterAckPublisher;
  34 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantRestartPublisher;
  35 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  36 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  37 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  38 import org.onap.policy.clamp.models.acm.concepts.Participant;
  39 import org.onap.policy.clamp.models.acm.concepts.ParticipantDefinition;
  40 import org.onap.policy.clamp.models.acm.concepts.ParticipantState;
  41 import org.onap.policy.clamp.models.acm.concepts.ParticipantSupportedElementType;
  42 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  43 import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantDeregister;
  44 import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantRegister;
  45 import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantStatus;
  46 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  47 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  48 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51 import org.springframework.stereotype.Component;
  52
  53 /**
  54  * This class handles supervision of participant status.
  55  */
  56 @Component
  57 @AllArgsConstructor
  58 public class SupervisionParticipantHandler {
  59     private static final Logger LOGGER = LoggerFactory.getLogger(SupervisionParticipantHandler.class);
  60
  61     private final ParticipantProvider participantProvider;
  62     private final ParticipantRegisterAckPublisher participantRegisterAckPublisher;
  63     private final ParticipantDeregisterAckPublisher participantDeregisterAckPublisher;
  64     private final AutomationCompositionProvider automationCompositionProvider;
  65     private final AcDefinitionProvider acDefinitionProvider;
  66     private final ParticipantRestartPublisher participantRestartPublisher;
  67     private final AcRuntimeParameterGroup acRuntimeParameterGroup;
  68
  69     /**
  70      * Handle a ParticipantRegister message from a participant.
  71      *
  72      * @param participantRegisterMsg the ParticipantRegister message received from a participant
  73      */
  74     @MessageIntercept
  75     @Timed(value = "listener.participant_register", description = "PARTICIPANT_REGISTER messages received")
  76     public void handleParticipantMessage(ParticipantRegister participantRegisterMsg) {
  77         LOGGER.debug("Participant Register received {}", participantRegisterMsg);
  78         var participantOpt = participantProvider.findParticipant(participantRegisterMsg.getParticipantId());
  79
  80         if (participantOpt.isPresent()) {
  81             var participant = participantOpt.get();
  82             checkOnline(participant);
  83             handleRestart(participant.getParticipantId());
  84         } else {
  85             var participant = createParticipant(participantRegisterMsg.getParticipantId(),
  86                     listToMap(participantRegisterMsg.getParticipantSupportedElementType()));
  87             participantProvider.saveParticipant(participant);
  88
  89         }
  90
  91         participantRegisterAckPublisher.send(participantRegisterMsg.getMessageId(),
  92                 participantRegisterMsg.getParticipantId());
  93     }
  94
  95     /**
  96      * Handle a ParticipantDeregister message from a participant.
  97      *
  98      * @param participantDeregisterMsg the ParticipantDeregister message received from a participant
  99      */
 100     @MessageIntercept
 101     @Timed(value = "listener.participant_deregister", description = "PARTICIPANT_DEREGISTER messages received")
 102     public void handleParticipantMessage(ParticipantDeregister participantDeregisterMsg) {
 103         LOGGER.debug("Participant Deregister received {}", participantDeregisterMsg);
 104         var participantOpt = participantProvider.findParticipant(participantDeregisterMsg.getParticipantId());
 105
 106         if (participantOpt.isPresent()) {
 107             var participant = participantOpt.get();
 108             participant.setParticipantState(ParticipantState.OFF_LINE);
 109             participantProvider.updateParticipant(participant);
 110         }
 111
 112         participantDeregisterAckPublisher.send(participantDeregisterMsg.getMessageId());
 113     }
 114
 115     /**
 116      * Handle a ParticipantStatus message from a participant.
 117      *
 118      * @param participantStatusMsg the ParticipantStatus message received from a participant
 119      */
 120     @MessageIntercept
 121     @Timed(value = "listener.participant_status", description = "PARTICIPANT_STATUS messages received")
 122     public void handleParticipantMessage(ParticipantStatus participantStatusMsg) {
 123         LOGGER.debug("Participant Status received {}", participantStatusMsg);
 124
 125         var participantOpt = participantProvider.findParticipant(participantStatusMsg.getParticipantId());
 126         if (participantOpt.isEmpty()) {
 127             var participant = createParticipant(participantStatusMsg.getParticipantId(),
 128                     listToMap(participantStatusMsg.getParticipantSupportedElementType()));
 129             participantProvider.saveParticipant(participant);
 130         } else {
 131             checkOnline(participantOpt.get());
 132         }
 133         if (!participantStatusMsg.getAutomationCompositionInfoList().isEmpty()) {
 134             automationCompositionProvider.upgradeStates(participantStatusMsg.getAutomationCompositionInfoList());
 135         }
 136         if (!participantStatusMsg.getParticipantDefinitionUpdates().isEmpty()
 137                 && participantStatusMsg.getCompositionId() != null) {
 138             updateAcDefinitionOutProperties(participantStatusMsg.getCompositionId(),
 139                     participantStatusMsg.getParticipantDefinitionUpdates());
 140         }
 141     }
 142
 143     private void updateAcDefinitionOutProperties(UUID composotionId, List<ParticipantDefinition> list) {
 144         var acDefinitionOpt = acDefinitionProvider.findAcDefinition(composotionId);
 145         if (acDefinitionOpt.isEmpty()) {
 146             LOGGER.error("Ac Definition with id {} not found", composotionId);
 147             return;
 148         }
 149         var acDefinition = acDefinitionOpt.get();
 150         for (var acElements : list) {
 151             for (var element : acElements.getAutomationCompositionElementDefinitionList()) {
 152                 var state = acDefinition.getElementStateMap().get(element.getAcElementDefinitionId().getName());
 153                 if (state != null) {
 154                     state.setOutProperties(element.getOutProperties());
 155                 }
 156             }
 157         }
 158         acDefinitionProvider.updateAcDefinition(acDefinition,
 159                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 160     }
 161
 162     private void checkOnline(Participant participant) {
 163         if (ParticipantState.OFF_LINE.equals(participant.getParticipantState())) {
 164             participant.setParticipantState(ParticipantState.ON_LINE);
 165             participantProvider.saveParticipant(participant);
 166         }
 167     }
 168
 169     private void handleRestart(UUID participantId) {
 170         var compositionIds = participantProvider.getCompositionIds(participantId);
 171         for (var compositionId : compositionIds) {
 172             var acDefinition = acDefinitionProvider.getAcDefinition(compositionId);
 173             LOGGER.debug("Scan Composition {} for restart", acDefinition.getCompositionId());
 174             handleRestart(participantId, acDefinition);
 175         }
 176     }
 177
 178     private void handleRestart(UUID participantId, AutomationCompositionDefinition acDefinition) {
 179         if (AcTypeState.COMMISSIONED.equals(acDefinition.getState())) {
 180             LOGGER.debug("Composition {} COMMISSIONED", acDefinition.getCompositionId());
 181             return;
 182         }
 183         LOGGER.debug("Composition to be send in Restart message {}", acDefinition.getCompositionId());
 184         for (var elementState : acDefinition.getElementStateMap().values()) {
 185             if (participantId.equals(elementState.getParticipantId())) {
 186                 elementState.setRestarting(true);
 187             }
 188         }
 189         var automationCompositionList =
 190                 automationCompositionProvider.getAcInstancesByCompositionId(acDefinition.getCompositionId());
 191         List<AutomationComposition> automationCompositions = new ArrayList<>();
 192         for (var automationComposition : automationCompositionList) {
 193             if (isAcToBeRestarted(participantId, automationComposition)) {
 194                 automationCompositions.add(automationComposition);
 195             }
 196         }
 197         // expected final state
 198         if (StateChangeResult.TIMEOUT.equals(acDefinition.getStateChangeResult())) {
 199             acDefinition.setStateChangeResult(StateChangeResult.NO_ERROR);
 200         }
 201         acDefinition.setRestarting(true);
 202         acDefinitionProvider.updateAcDefinition(acDefinition,
 203                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 204         participantRestartPublisher.send(participantId, acDefinition, automationCompositions);
 205     }
 206
 207     private boolean isAcToBeRestarted(UUID participantId, AutomationComposition automationComposition) {
 208         boolean toAdd = false;
 209         for (var element : automationComposition.getElements().values()) {
 210             if (participantId.equals(element.getParticipantId())) {
 211                 element.setRestarting(true);
 212                 toAdd = true;
 213             }
 214         }
 215         if (toAdd) {
 216             automationComposition.setRestarting(true);
 217             // expected final state
 218             if (StateChangeResult.TIMEOUT.equals(automationComposition.getStateChangeResult())) {
 219                 automationComposition.setStateChangeResult(StateChangeResult.NO_ERROR);
 220             }
 221             automationCompositionProvider.updateAutomationComposition(automationComposition);
 222         }
 223         return toAdd;
 224     }
 225
 226     private Participant createParticipant(UUID participantId,
 227             Map<UUID, ParticipantSupportedElementType> participantSupportedElementType) {
 228         var participant = new Participant();
 229         participant.setParticipantId(participantId);
 230         participant.setParticipantSupportedElementTypes(participantSupportedElementType);
 231         participant.setParticipantState(ParticipantState.ON_LINE);
 232         return participant;
 233     }
 234
 235     private Map<UUID, ParticipantSupportedElementType> listToMap(List<ParticipantSupportedElementType> elementList) {
 236         Map<UUID, ParticipantSupportedElementType> map = new HashMap<>();
 237         MapUtils.populateMap(map, elementList, ParticipantSupportedElementType::getId);
 238         return map;
 239     }
 240 }