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         var participantOpt = participantProvider.findParticipant(participantRegisterMsg.getParticipantId());
  78
  79         if (participantOpt.isPresent()) {
  80             var participant = participantOpt.get();
  81             checkOnline(participant);
  82             handleRestart(participant.getParticipantId());
  83         } else {
  84             var participant = createParticipant(participantRegisterMsg.getParticipantId(),
  85                     listToMap(participantRegisterMsg.getParticipantSupportedElementType()));
  86             participantProvider.saveParticipant(participant);
  87
  88         }
  89
  90         participantRegisterAckPublisher.send(participantRegisterMsg.getMessageId(),
  91                 participantRegisterMsg.getParticipantId());
  92     }
  93
  94     /**
  95      * Handle a ParticipantDeregister message from a participant.
  96      *
  97      * @param participantDeregisterMsg the ParticipantDeregister message received from a participant
  98      */
  99     @MessageIntercept
 100     @Timed(value = "listener.participant_deregister", description = "PARTICIPANT_DEREGISTER messages received")
 101     public void handleParticipantMessage(ParticipantDeregister participantDeregisterMsg) {
 102         var participantOpt = participantProvider.findParticipant(participantDeregisterMsg.getParticipantId());
 103
 104         if (participantOpt.isPresent()) {
 105             var participant = participantOpt.get();
 106             participant.setParticipantState(ParticipantState.OFF_LINE);
 107             participantProvider.updateParticipant(participant);
 108         }
 109
 110         participantDeregisterAckPublisher.send(participantDeregisterMsg.getMessageId());
 111     }
 112
 113     /**
 114      * Handle a ParticipantStatus message from a participant.
 115      *
 116      * @param participantStatusMsg the ParticipantStatus message received from a participant
 117      */
 118     @MessageIntercept
 119     @Timed(value = "listener.participant_status", description = "PARTICIPANT_STATUS messages received")
 120     public void handleParticipantMessage(ParticipantStatus participantStatusMsg) {
 121
 122         var participantOpt = participantProvider.findParticipant(participantStatusMsg.getParticipantId());
 123         if (participantOpt.isEmpty()) {
 124             var participant = createParticipant(participantStatusMsg.getParticipantId(),
 125                     listToMap(participantStatusMsg.getParticipantSupportedElementType()));
 126             participantProvider.saveParticipant(participant);
 127         } else {
 128             checkOnline(participantOpt.get());
 129         }
 130         if (!participantStatusMsg.getAutomationCompositionInfoList().isEmpty()) {
 131             automationCompositionProvider.upgradeStates(participantStatusMsg.getAutomationCompositionInfoList());
 132         }
 133         if (!participantStatusMsg.getParticipantDefinitionUpdates().isEmpty()
 134                 && participantStatusMsg.getCompositionId() != null) {
 135             updateAcDefinitionOutProperties(participantStatusMsg.getCompositionId(),
 136                     participantStatusMsg.getParticipantDefinitionUpdates());
 137         }
 138     }
 139
 140     private void updateAcDefinitionOutProperties(UUID composotionId, List<ParticipantDefinition> list) {
 141         var acDefinitionOpt = acDefinitionProvider.findAcDefinition(composotionId);
 142         if (acDefinitionOpt.isEmpty()) {
 143             LOGGER.error("Ac Definition with id {} not found", composotionId);
 144             return;
 145         }
 146         var acDefinition = acDefinitionOpt.get();
 147         for (var acElements : list) {
 148             for (var element : acElements.getAutomationCompositionElementDefinitionList()) {
 149                 var state = acDefinition.getElementStateMap().get(element.getAcElementDefinitionId().getName());
 150                 if (state != null) {
 151                     state.setOutProperties(element.getOutProperties());
 152                 }
 153             }
 154         }
 155         acDefinitionProvider.updateAcDefinition(acDefinition,
 156                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 157     }
 158
 159     private void checkOnline(Participant participant) {
 160         if (ParticipantState.OFF_LINE.equals(participant.getParticipantState())) {
 161             participant.setParticipantState(ParticipantState.ON_LINE);
 162             participantProvider.saveParticipant(participant);
 163         }
 164     }
 165
 166     private void handleRestart(UUID participantId) {
 167         var compositionIds = participantProvider.getCompositionIds(participantId);
 168         for (var compositionId : compositionIds) {
 169             var acDefinition = acDefinitionProvider.getAcDefinition(compositionId);
 170             LOGGER.debug("Scan Composition {} for restart", acDefinition.getCompositionId());
 171             handleRestart(participantId, acDefinition);
 172         }
 173     }
 174
 175     private void handleRestart(UUID participantId, AutomationCompositionDefinition acDefinition) {
 176         if (AcTypeState.COMMISSIONED.equals(acDefinition.getState())) {
 177             LOGGER.debug("Composition {} COMMISSIONED", acDefinition.getCompositionId());
 178             return;
 179         }
 180         LOGGER.debug("Composition to be send in Restart message {}", acDefinition.getCompositionId());
 181         for (var elementState : acDefinition.getElementStateMap().values()) {
 182             if (participantId.equals(elementState.getParticipantId())) {
 183                 elementState.setRestarting(true);
 184             }
 185         }
 186         var automationCompositionList =
 187                 automationCompositionProvider.getAcInstancesByCompositionId(acDefinition.getCompositionId());
 188         List<AutomationComposition> automationCompositions = new ArrayList<>();
 189         for (var automationComposition : automationCompositionList) {
 190             if (isAcToBeRestarted(participantId, automationComposition)) {
 191                 automationCompositions.add(automationComposition);
 192             }
 193         }
 194         // expected final state
 195         if (StateChangeResult.TIMEOUT.equals(acDefinition.getStateChangeResult())) {
 196             acDefinition.setStateChangeResult(StateChangeResult.NO_ERROR);
 197         }
 198         acDefinition.setRestarting(true);
 199         acDefinitionProvider.updateAcDefinition(acDefinition,
 200                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 201         participantRestartPublisher.send(participantId, acDefinition, automationCompositions);
 202     }
 203
 204     private boolean isAcToBeRestarted(UUID participantId, AutomationComposition automationComposition) {
 205         boolean toAdd = false;
 206         for (var element : automationComposition.getElements().values()) {
 207             if (participantId.equals(element.getParticipantId())) {
 208                 element.setRestarting(true);
 209                 toAdd = true;
 210             }
 211         }
 212         if (toAdd) {
 213             automationComposition.setRestarting(true);
 214             // expected final state
 215             if (StateChangeResult.TIMEOUT.equals(automationComposition.getStateChangeResult())) {
 216                 automationComposition.setStateChangeResult(StateChangeResult.NO_ERROR);
 217             }
 218             automationCompositionProvider.updateAutomationComposition(automationComposition);
 219         }
 220         return toAdd;
 221     }
 222
 223     private Participant createParticipant(UUID participantId,
 224             Map<UUID, ParticipantSupportedElementType> participantSupportedElementType) {
 225         var participant = new Participant();
 226         participant.setParticipantId(participantId);
 227         participant.setParticipantSupportedElementTypes(participantSupportedElementType);
 228         participant.setParticipantState(ParticipantState.ON_LINE);
 229         return participant;
 230     }
 231
 232     private Map<UUID, ParticipantSupportedElementType> listToMap(List<ParticipantSupportedElementType> elementList) {
 233         Map<UUID, ParticipantSupportedElementType> map = new HashMap<>();
 234         MapUtils.populateMap(map, elementList, ParticipantSupportedElementType::getId);
 235         return map;
 236     }
 237 }