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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 Nordix Foundation.
   4  * ================================================================================
   5  * Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.clamp.acm.participant.intermediary.handler;
  24
  25 import io.micrometer.core.annotation.Timed;
  26 import java.util.ArrayList;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.UUID;
  31 import lombok.Getter;
  32 import org.onap.policy.clamp.acm.participant.intermediary.comm.ParticipantMessagePublisher;
  33 import org.onap.policy.clamp.acm.participant.intermediary.parameters.ParticipantParameters;
  34 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElementDefinition;
  35 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionInfo;
  36 import org.onap.policy.clamp.models.acm.concepts.ParticipantDefinition;
  37 import org.onap.policy.clamp.models.acm.concepts.ParticipantState;
  38 import org.onap.policy.clamp.models.acm.concepts.ParticipantSupportedElementType;
  39 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.AutomationCompositionStateChange;
  40 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.AutomationCompositionUpdate;
  41 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantAckMessage;
  42 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantDeregister;
  43 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantDeregisterAck;
  44 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantMessage;
  45 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantRegister;
  46 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantRegisterAck;
  47 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantStatus;
  48 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantStatusReq;
  49 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantUpdate;
  50 import org.onap.policy.clamp.models.acm.messages.dmaap.participant.ParticipantUpdateAck;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53 import org.springframework.stereotype.Component;
  54
  55 /**
  56  * This class is responsible for managing the state of a participant.
  57  */
  58 @Component
  59 public class ParticipantHandler {
  60     private static final Logger LOGGER = LoggerFactory.getLogger(ParticipantHandler.class);
  61
  62     @Getter
  63     private final UUID participantId;
  64
  65     private final AutomationCompositionHandler automationCompositionHandler;
  66     private final ParticipantMessagePublisher publisher;
  67
  68     private final Map<UUID, List<AutomationCompositionElementDefinition>> acElementDefsMap = new HashMap<>();
  69
  70     private final List<ParticipantSupportedElementType> supportedAcElementTypes;
  71
  72     /**
  73      * Constructor, set the participant ID and sender.
  74      *
  75      * @param parameters the parameters of the participant
  76      * @param publisher the publisher for sending responses to messages
  77      */
  78     public ParticipantHandler(ParticipantParameters parameters, ParticipantMessagePublisher publisher,
  79             AutomationCompositionHandler automationCompositionHandler) {
  80         this.participantId = parameters.getIntermediaryParameters().getParticipantId();
  81         this.publisher = publisher;
  82         this.automationCompositionHandler = automationCompositionHandler;
  83         this.supportedAcElementTypes = parameters.getIntermediaryParameters().getParticipantSupportedElementTypes();
  84     }
  85
  86     /**
  87      * Method which handles a participant health check event from clamp.
  88      *
  89      * @param participantStatusReqMsg participant participantStatusReq message
  90      */
  91     @Timed(value = "listener.participant_status_req", description = "PARTICIPANT_STATUS_REQ messages received")
  92     public void handleParticipantStatusReq(final ParticipantStatusReq participantStatusReqMsg) {
  93         var participantStatus = makeHeartbeat(true);
  94         participantStatus.setParticipantSupportedElementType(this.supportedAcElementTypes);
  95         publisher.sendParticipantStatus(participantStatus);
  96     }
  97
  98     /**
  99      * Handle a automation composition update message.
 100      *
 101      * @param updateMsg the update message
 102      */
 103     @Timed(
 104             value = "listener.automation_composition_update",
 105             description = "AUTOMATION_COMPOSITION_UPDATE messages received")
 106     public void handleAutomationCompositionUpdate(AutomationCompositionUpdate updateMsg) {
 107         automationCompositionHandler.handleAutomationCompositionUpdate(updateMsg,
 108                 acElementDefsMap.get(updateMsg.getCompositionId()));
 109     }
 110
 111     /**
 112      * Handle a automation composition state change message.
 113      *
 114      * @param stateChangeMsg the state change message
 115      */
 116     @Timed(
 117             value = "listener.automation_composition_state_change",
 118             description = "AUTOMATION_COMPOSITION_STATE_CHANGE messages received")
 119     public void handleAutomationCompositionStateChange(AutomationCompositionStateChange stateChangeMsg) {
 120         automationCompositionHandler.handleAutomationCompositionStateChange(stateChangeMsg,
 121                 acElementDefsMap.get(stateChangeMsg.getCompositionId()));
 122     }
 123
 124     /**
 125      * Check if a participant message applies to this participant handler.
 126      *
 127      * @param participantMsg the message to check
 128      * @return true if it applies, false otherwise
 129      */
 130     public boolean appliesTo(ParticipantMessage participantMsg) {
 131         return participantMsg.appliesTo(participantId);
 132     }
 133
 134     /**
 135      * Check if a participant message applies to this participant handler.
 136      *
 137      * @param participantMsg the message to check
 138      * @return true if it applies, false otherwise
 139      */
 140     public boolean appliesTo(ParticipantAckMessage participantMsg) {
 141         return participantMsg.appliesTo(participantId);
 142     }
 143
 144     /**
 145      * Method to send ParticipantRegister message to automation composition runtime.
 146      */
 147     public void sendParticipantRegister() {
 148         var participantRegister = new ParticipantRegister();
 149         participantRegister.setParticipantId(participantId);
 150         participantRegister.setParticipantSupportedElementType(supportedAcElementTypes);
 151
 152         publisher.sendParticipantRegister(participantRegister);
 153     }
 154
 155     /**
 156      * Handle a participantRegister Ack message.
 157      *
 158      * @param participantRegisterAckMsg the participantRegisterAck message
 159      */
 160     @Timed(value = "listener.participant_register_ack", description = "PARTICIPANT_REGISTER_ACK messages received")
 161     public void handleParticipantRegisterAck(ParticipantRegisterAck participantRegisterAckMsg) {
 162         LOGGER.debug("ParticipantRegisterAck message received as responseTo {}",
 163                 participantRegisterAckMsg.getResponseTo());
 164         publisher.sendParticipantStatus(makeHeartbeat(false));
 165     }
 166
 167     /**
 168      * Method to send ParticipantDeregister message to automation composition runtime.
 169      */
 170     public void sendParticipantDeregister() {
 171         var participantDeregister = new ParticipantDeregister();
 172         participantDeregister.setParticipantId(participantId);
 173
 174         publisher.sendParticipantDeregister(participantDeregister);
 175     }
 176
 177     /**
 178      * Handle a participantDeregister Ack message.
 179      *
 180      * @param participantDeregisterAckMsg the participantDeregisterAck message
 181      */
 182     @Timed(value = "listener.participant_deregister_ack", description = "PARTICIPANT_DEREGISTER_ACK messages received")
 183     public void handleParticipantDeregisterAck(ParticipantDeregisterAck participantDeregisterAckMsg) {
 184         LOGGER.debug("ParticipantDeregisterAck message received as responseTo {}",
 185                 participantDeregisterAckMsg.getResponseTo());
 186     }
 187
 188     /**
 189      * Handle a ParticipantUpdate message.
 190      *
 191      * @param participantUpdateMsg the ParticipantUpdate message
 192      */
 193     @Timed(value = "listener.participant_update", description = "PARTICIPANT_UPDATE messages received")
 194     public void handleParticipantUpdate(ParticipantUpdate participantUpdateMsg) {
 195         LOGGER.debug("ParticipantUpdate message received for participantId {}",
 196                 participantUpdateMsg.getParticipantId());
 197
 198         acElementDefsMap.putIfAbsent(participantUpdateMsg.getCompositionId(), new ArrayList<>());
 199         if (!participantUpdateMsg.getParticipantDefinitionUpdates().isEmpty()) {
 200             // This message is to commission the automation composition
 201             for (var participantDefinition : participantUpdateMsg.getParticipantDefinitionUpdates()) {
 202                 if (participantDefinition.getParticipantId().equals(participantId)) {
 203                     acElementDefsMap.get(participantUpdateMsg.getCompositionId())
 204                             .addAll(participantDefinition.getAutomationCompositionElementDefinitionList());
 205                     break;
 206                 }
 207             }
 208         } else {
 209             // This message is to decommission the automation composition
 210             acElementDefsMap.get(participantUpdateMsg.getCompositionId()).clear();
 211         }
 212         sendParticipantUpdateAck(participantUpdateMsg.getMessageId());
 213     }
 214
 215     /**
 216      * Method to send ParticipantUpdateAck message to automation composition runtime.
 217      */
 218     public void sendParticipantUpdateAck(UUID messageId) {
 219         var participantUpdateAck = new ParticipantUpdateAck();
 220         participantUpdateAck.setResponseTo(messageId);
 221         participantUpdateAck.setMessage("Participant Update Ack message");
 222         participantUpdateAck.setResult(true);
 223         participantUpdateAck.setParticipantId(participantId);
 224         participantUpdateAck.setState(ParticipantState.ON_LINE);
 225         publisher.sendParticipantUpdateAck(participantUpdateAck);
 226     }
 227
 228     /**
 229      * Dispatch a heartbeat for this participant.
 230      */
 231     public void sendHeartbeat() {
 232         publisher.sendHeartbeat(makeHeartbeat(false));
 233     }
 234
 235     /**
 236      * Method to send heartbeat to automation composition runtime.
 237      */
 238     public ParticipantStatus makeHeartbeat(boolean responseToParticipantStatusReq) {
 239         var heartbeat = new ParticipantStatus();
 240         heartbeat.setParticipantId(participantId);
 241         heartbeat.setState(ParticipantState.ON_LINE);
 242         heartbeat.setAutomationCompositionInfoList(getAutomationCompositionInfoList());
 243
 244         if (responseToParticipantStatusReq) {
 245             List<ParticipantDefinition> participantDefinitionList = new ArrayList<>(acElementDefsMap.size());
 246             for (var acElementDefsOnThisParticipant : acElementDefsMap.values()) {
 247                 var participantDefinition = new ParticipantDefinition();
 248                 participantDefinition.setParticipantId(participantId);
 249                 participantDefinition.setAutomationCompositionElementDefinitionList(acElementDefsOnThisParticipant);
 250                 participantDefinitionList.add(participantDefinition);
 251             }
 252             heartbeat.setParticipantDefinitionUpdates(participantDefinitionList);
 253         }
 254
 255         return heartbeat;
 256     }
 257
 258     private List<AutomationCompositionInfo> getAutomationCompositionInfoList() {
 259         List<AutomationCompositionInfo> automationCompositionInfoList = new ArrayList<>();
 260         for (var entry : automationCompositionHandler.getAutomationCompositionMap().entrySet()) {
 261             var acInfo = new AutomationCompositionInfo();
 262             acInfo.setAutomationCompositionId(entry.getKey());
 263             acInfo.setState(entry.getValue().getState());
 264             automationCompositionInfoList.add(acInfo);
 265         }
 266         return automationCompositionInfoList;
 267     }
 268 }