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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 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.controlloop.runtime.supervision.comm;
  24
  25 import java.time.Instant;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.Map;
  29 import lombok.AllArgsConstructor;
  30 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElementDefinition;
  31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantDefinition;
  32 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdate;
  33 import org.onap.policy.common.utils.coder.Coder;
  34 import org.onap.policy.common.utils.coder.CoderException;
  35 import org.onap.policy.common.utils.coder.StandardCoder;
  36 import org.onap.policy.models.base.PfModelException;
  37 import org.onap.policy.models.provider.PolicyModelsProvider;
  38 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  39 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43 import org.springframework.stereotype.Component;
  44
  45 /**
  46  * This class is used to send ParticipantUpdate messages to participants on DMaaP.
  47  */
  48 @Component
  49 @AllArgsConstructor
  50 public class ParticipantUpdatePublisher extends AbstractParticipantPublisher<ParticipantUpdate> {
  51
  52     private static final Logger LOGGER = LoggerFactory.getLogger(ParticipantUpdatePublisher.class);
  53     private static final String CONTROL_LOOP_ELEMENT = "org.onap.policy.clamp.controlloop.ControlLoopElement";
  54     private static final Coder CODER = new StandardCoder();
  55     private final PolicyModelsProvider modelsProvider;
  56
  57     /**
  58      * Send ParticipantUpdate to Participant.
  59      *
  60      * @param participantId the participant Id
  61      * @param participantType the participant Type
  62      */
  63     public void send(ToscaConceptIdentifier participantId, ToscaConceptIdentifier participantType,
  64             boolean commissionFlag) {
  65         var message = new ParticipantUpdate();
  66         message.setParticipantId(participantId);
  67         message.setParticipantType(participantType);
  68         message.setTimestamp(Instant.now());
  69
  70         ToscaServiceTemplate toscaServiceTemplate;
  71         try {
  72             toscaServiceTemplate = modelsProvider.getServiceTemplateList(null, null).get(0);
  73         } catch (PfModelException pfme) {
  74             LOGGER.warn("Get of tosca service template failed, cannot send participantupdate", pfme);
  75             return;
  76         }
  77
  78         List<ParticipantDefinition> participantDefinitionUpdates = new ArrayList<>();
  79         for (Map.Entry<String, ToscaNodeTemplate> toscaInputEntry :
  80             toscaServiceTemplate.getToscaTopologyTemplate().getNodeTemplates().entrySet()) {
  81             if (toscaInputEntry.getValue().getType().contains(CONTROL_LOOP_ELEMENT)) {
  82                 ToscaConceptIdentifier clParticipantId;
  83                 try {
  84                     clParticipantId = CODER.decode(
  85                             toscaInputEntry.getValue().getProperties().get("participant_id").toString(),
  86                             ToscaConceptIdentifier.class);
  87                 } catch (CoderException e) {
  88                     throw new RuntimeException("cannot get ParticipantId from toscaNodeTemplate", e);
  89                 }
  90                 prepareParticipantDefinitionUpdate(clParticipantId, toscaInputEntry.getKey(),
  91                     toscaInputEntry.getValue(), participantDefinitionUpdates);
  92             }
  93         }
  94
  95         if (commissionFlag) {
  96             // Commission the controlloop but sending participantdefinitions to participants
  97             message.setParticipantDefinitionUpdates(participantDefinitionUpdates);
  98             message.setToscaServiceTemplate(toscaServiceTemplate);
  99         } else {
 100             // DeCommission the controlloop but deleting participantdefinitions on participants
 101             message.setParticipantDefinitionUpdates(null);
 102             message.setToscaServiceTemplate(null);
 103         }
 104         LOGGER.debug("Participant Update sent {}", message);
 105         super.send(message);
 106     }
 107
 108     private void prepareParticipantDefinitionUpdate(ToscaConceptIdentifier clParticipantId, String entryKey,
 109         ToscaNodeTemplate entryValue, List<ParticipantDefinition> participantDefinitionUpdates) {
 110
 111         var clDefinition = new ControlLoopElementDefinition();
 112         clDefinition.setClElementDefinitionId(new ToscaConceptIdentifier(
 113             entryKey, entryValue.getVersion()));
 114         clDefinition.setControlLoopElementToscaNodeTemplate(entryValue);
 115         List<ControlLoopElementDefinition> controlLoopElementDefinitionList = new ArrayList<>();
 116
 117         if (participantDefinitionUpdates.isEmpty()) {
 118             participantDefinitionUpdates.add(getParticipantDefinition(clDefinition, clParticipantId,
 119                 controlLoopElementDefinitionList));
 120         } else {
 121             var participantExists = false;
 122             for (ParticipantDefinition participantDefinitionUpdate : participantDefinitionUpdates) {
 123                 if (participantDefinitionUpdate.getParticipantId().equals(clParticipantId)) {
 124                     participantDefinitionUpdate.getControlLoopElementDefinitionList().add(clDefinition);
 125                     participantExists = true;
 126                 }
 127             }
 128             if (!participantExists) {
 129                 participantDefinitionUpdates.add(getParticipantDefinition(clDefinition, clParticipantId,
 130                     controlLoopElementDefinitionList));
 131             }
 132         }
 133     }
 134
 135     private ParticipantDefinition getParticipantDefinition(ControlLoopElementDefinition clDefinition,
 136         ToscaConceptIdentifier clParticipantId,
 137         List<ControlLoopElementDefinition> controlLoopElementDefinitionList) {
 138         var participantDefinition = new ParticipantDefinition();
 139         participantDefinition.setParticipantId(clParticipantId);
 140         controlLoopElementDefinitionList.add(clDefinition);
 141         participantDefinition.setControlLoopElementDefinitionList(controlLoopElementDefinitionList);
 142         return participantDefinition;
 143     }
 144 }