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.onap.policy.clamp.models.acm.utils.TimestampHelper;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52 import org.springframework.stereotype.Component;
  53
  54 /**
  55  * This class handles supervision of participant status.
  56  */
  57 @Component
  58 @AllArgsConstructor
  59 public class SupervisionParticipantHandler {
  60     private static final Logger LOGGER = LoggerFactory.getLogger(SupervisionParticipantHandler.class);
  61
  62     private final ParticipantProvider participantProvider;
  63     private final ParticipantRegisterAckPublisher participantRegisterAckPublisher;
  64     private final ParticipantDeregisterAckPublisher participantDeregisterAckPublisher;
  65     private final AutomationCompositionProvider automationCompositionProvider;
  66     private final AcDefinitionProvider acDefinitionProvider;
  67     private final ParticipantRestartPublisher participantRestartPublisher;
  68     private final AcRuntimeParameterGroup acRuntimeParameterGroup;
  69
  70     /**
  71      * Handle a ParticipantRegister message from a participant.
  72      *
  73      * @param participantRegisterMsg the ParticipantRegister message received from a participant
  74      */
  75     @MessageIntercept
  76     @Timed(value = "listener.participant_register", description = "PARTICIPANT_REGISTER messages received")
  77     public void handleParticipantMessage(ParticipantRegister 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         var participantOpt = participantProvider.findParticipant(participantDeregisterMsg.getParticipantId());
 104
 105         if (participantOpt.isPresent()) {
 106             var participant = participantOpt.get();
 107             participant.setParticipantState(ParticipantState.OFF_LINE);
 108             participantProvider.updateParticipant(participant);
 109         }
 110
 111         participantDeregisterAckPublisher.send(participantDeregisterMsg.getMessageId());
 112     }
 113
 114     /**
 115      * Handle a ParticipantStatus message from a participant.
 116      *
 117      * @param participantStatusMsg the ParticipantStatus message received from a participant
 118      */
 119     @MessageIntercept
 120     @Timed(value = "listener.participant_status", description = "PARTICIPANT_STATUS messages received")
 121     public void handleParticipantMessage(ParticipantStatus participantStatusMsg) {
 122
 123         var participantOpt = participantProvider.findParticipant(participantStatusMsg.getParticipantId());
 124         if (participantOpt.isEmpty()) {
 125             var participant = createParticipant(participantStatusMsg.getParticipantId(),
 126                     listToMap(participantStatusMsg.getParticipantSupportedElementType()));
 127             participantProvider.saveParticipant(participant);
 128         } else {
 129             checkOnline(participantOpt.get());
 130         }
 131         if (!participantStatusMsg.getAutomationCompositionInfoList().isEmpty()) {
 132             automationCompositionProvider.upgradeStates(participantStatusMsg.getAutomationCompositionInfoList());
 133         }
 134         if (!participantStatusMsg.getParticipantDefinitionUpdates().isEmpty()
 135                 && participantStatusMsg.getCompositionId() != null) {
 136             updateAcDefinitionOutProperties(participantStatusMsg.getCompositionId(),
 137                     participantStatusMsg.getParticipantDefinitionUpdates());
 138         }
 139     }
 140
 141     private void updateAcDefinitionOutProperties(UUID composotionId, List<ParticipantDefinition> list) {
 142         var acDefinitionOpt = acDefinitionProvider.findAcDefinition(composotionId);
 143         if (acDefinitionOpt.isEmpty()) {
 144             LOGGER.error("Ac Definition with id {} not found", composotionId);
 145             return;
 146         }
 147         var acDefinition = acDefinitionOpt.get();
 148         for (var acElements : list) {
 149             for (var element : acElements.getAutomationCompositionElementDefinitionList()) {
 150                 var state = acDefinition.getElementStateMap().get(element.getAcElementDefinitionId().getName());
 151                 if (state != null) {
 152                     state.setOutProperties(element.getOutProperties());
 153                 }
 154             }
 155         }
 156         acDefinitionProvider.updateAcDefinition(acDefinition,
 157                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 158     }
 159
 160     private void checkOnline(Participant participant) {
 161         if (ParticipantState.OFF_LINE.equals(participant.getParticipantState())) {
 162             participant.setParticipantState(ParticipantState.ON_LINE);
 163         }
 164         participant.setLastMsg(TimestampHelper.now());
 165         participantProvider.saveParticipant(participant);
 166     }
 167
 168     private void handleRestart(UUID participantId) {
 169         var compositionIds = participantProvider.getCompositionIds(participantId);
 170         for (var compositionId : compositionIds) {
 171             var acDefinition = acDefinitionProvider.getAcDefinition(compositionId);
 172             LOGGER.debug("Scan Composition {} for restart", acDefinition.getCompositionId());
 173             handleRestart(participantId, acDefinition);
 174         }
 175     }
 176
 177     private void handleRestart(UUID participantId, AutomationCompositionDefinition acDefinition) {
 178         if (AcTypeState.COMMISSIONED.equals(acDefinition.getState())) {
 179             LOGGER.debug("Composition {} COMMISSIONED", acDefinition.getCompositionId());
 180             return;
 181         }
 182         LOGGER.debug("Composition to be send in Restart message {}", acDefinition.getCompositionId());
 183         for (var elementState : acDefinition.getElementStateMap().values()) {
 184             if (participantId.equals(elementState.getParticipantId())) {
 185                 elementState.setRestarting(true);
 186             }
 187         }
 188         var automationCompositionList =
 189                 automationCompositionProvider.getAcInstancesByCompositionId(acDefinition.getCompositionId());
 190         List<AutomationComposition> automationCompositions = new ArrayList<>();
 191         for (var automationComposition : automationCompositionList) {
 192             if (isAcToBeRestarted(participantId, automationComposition)) {
 193                 automationCompositions.add(automationComposition);
 194             }
 195         }
 196         // expected final state
 197         if (StateChangeResult.TIMEOUT.equals(acDefinition.getStateChangeResult())) {
 198             acDefinition.setStateChangeResult(StateChangeResult.NO_ERROR);
 199         }
 200         acDefinition.setRestarting(true);
 201         acDefinitionProvider.updateAcDefinition(acDefinition,
 202                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 203         participantRestartPublisher.send(participantId, acDefinition, automationCompositions);
 204     }
 205
 206     private boolean isAcToBeRestarted(UUID participantId, AutomationComposition automationComposition) {
 207         boolean toAdd = false;
 208         for (var element : automationComposition.getElements().values()) {
 209             if (participantId.equals(element.getParticipantId())) {
 210                 element.setRestarting(true);
 211                 toAdd = true;
 212             }
 213         }
 214         if (toAdd) {
 215             automationComposition.setRestarting(true);
 216             // expected final state
 217             if (StateChangeResult.TIMEOUT.equals(automationComposition.getStateChangeResult())) {
 218                 automationComposition.setStateChangeResult(StateChangeResult.NO_ERROR);
 219             }
 220             automationCompositionProvider.updateAutomationComposition(automationComposition);
 221         }
 222         return toAdd;
 223     }
 224
 225     private Participant createParticipant(UUID participantId,
 226             Map<UUID, ParticipantSupportedElementType> participantSupportedElementType) {
 227         var participant = new Participant();
 228         participant.setParticipantId(participantId);
 229         participant.setParticipantSupportedElementTypes(participantSupportedElementType);
 230         participant.setParticipantState(ParticipantState.ON_LINE);
 231         participant.setLastMsg(TimestampHelper.now());
 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 }