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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 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.supervision.comm.ParticipantDeregisterAckPublisher;
  32 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantRegisterAckPublisher;
  33 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantRestartPublisher;
  34 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  35 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  36 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  37 import org.onap.policy.clamp.models.acm.concepts.Participant;
  38 import org.onap.policy.clamp.models.acm.concepts.ParticipantDefinition;
  39 import org.onap.policy.clamp.models.acm.concepts.ParticipantState;
  40 import org.onap.policy.clamp.models.acm.concepts.ParticipantSupportedElementType;
  41 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  42 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantDeregister;
  43 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantRegister;
  44 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantStatus;
  45 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  46 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  47 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import org.springframework.stereotype.Component;
  51
  52 /**
  53  * This class handles supervision of participant status.
  54  */
  55 @Component
  56 @AllArgsConstructor
  57 public class SupervisionParticipantHandler {
  58     private static final Logger LOGGER = LoggerFactory.getLogger(SupervisionParticipantHandler.class);
  59
  60     private final ParticipantProvider participantProvider;
  61     private final ParticipantRegisterAckPublisher participantRegisterAckPublisher;
  62     private final ParticipantDeregisterAckPublisher participantDeregisterAckPublisher;
  63     private final AutomationCompositionProvider automationCompositionProvider;
  64     private final AcDefinitionProvider acDefinitionProvider;
  65     private final ParticipantRestartPublisher participantRestartPublisher;
  66
  67     /**
  68      * Handle a ParticipantRegister message from a participant.
  69      *
  70      * @param participantRegisterMsg the ParticipantRegister message received from a participant
  71      */
  72     @MessageIntercept
  73     @Timed(value = "listener.participant_register", description = "PARTICIPANT_REGISTER messages received")
  74     public void handleParticipantMessage(ParticipantRegister participantRegisterMsg) {
  75         LOGGER.debug("Participant Register received {}", participantRegisterMsg);
  76         var participantOpt = participantProvider.findParticipant(participantRegisterMsg.getParticipantId());
  77
  78         if (participantOpt.isPresent()) {
  79             var participant = participantOpt.get();
  80             checkOnline(participant);
  81             handleRestart(participant.getParticipantId());
  82         } else {
  83             var participant = createParticipant(participantRegisterMsg.getParticipantId(),
  84                     listToMap(participantRegisterMsg.getParticipantSupportedElementType()));
  85             participantProvider.saveParticipant(participant);
  86
  87         }
  88
  89         participantRegisterAckPublisher.send(participantRegisterMsg.getMessageId(),
  90                 participantRegisterMsg.getParticipantId());
  91     }
  92
  93     /**
  94      * Handle a ParticipantDeregister message from a participant.
  95      *
  96      * @param participantDeregisterMsg the ParticipantDeregister message received from a participant
  97      */
  98     @MessageIntercept
  99     @Timed(value = "listener.participant_deregister", description = "PARTICIPANT_DEREGISTER messages received")
 100     public void handleParticipantMessage(ParticipantDeregister participantDeregisterMsg) {
 101         LOGGER.debug("Participant Deregister received {}", 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         LOGGER.debug("Participant Status received {}", 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     }
 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         participantRestartPublisher.send(participantId, acDefinition, automationCompositions);
 201     }
 202
 203     private boolean isAcToBeRestarted(UUID participantId, AutomationComposition automationComposition) {
 204         boolean toAdd = false;
 205         for (var element : automationComposition.getElements().values()) {
 206             if (participantId.equals(element.getParticipantId())) {
 207                 element.setRestarting(true);
 208                 toAdd = true;
 209             }
 210         }
 211         if (toAdd) {
 212             automationComposition.setRestarting(true);
 213             // expected final state
 214             if (StateChangeResult.TIMEOUT.equals(automationComposition.getStateChangeResult())) {
 215                 automationComposition.setStateChangeResult(StateChangeResult.NO_ERROR);
 216             }
 217             automationCompositionProvider.updateAutomationComposition(automationComposition);
 218         }
 219         return toAdd;
 220     }
 221
 222     private Participant createParticipant(UUID participantId,
 223             Map<UUID, ParticipantSupportedElementType> participantSupportedElementType) {
 224         var participant = new Participant();
 225         participant.setParticipantId(participantId);
 226         participant.setParticipantSupportedElementTypes(participantSupportedElementType);
 227         participant.setParticipantState(ParticipantState.ON_LINE);
 228         return participant;
 229     }
 230
 231     private Map<UUID, ParticipantSupportedElementType> listToMap(List<ParticipantSupportedElementType> elementList) {
 232         Map<UUID, ParticipantSupportedElementType> map = new HashMap<>();
 233         MapUtils.populateMap(map, elementList, ParticipantSupportedElementType::getId);
 234         return map;
 235     }
 236 }