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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.clamp.controlloop.runtime.supervision;
  23
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Set;
  27 import java.util.UUID;
  28 import javax.ws.rs.core.Response;
  29 import lombok.AllArgsConstructor;
  30 import org.apache.commons.collections4.CollectionUtils;
  31 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
  32 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
  33 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElementAck;
  34 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopInfo;
  35 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
  36 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  37 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantHealthStatus;
  38 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
  39 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
  40 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
  41 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ControlLoopAck;
  42 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregister;
  43 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegister;
  44 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantStatus;
  45 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdate;
  46 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdateAck;
  47 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
  48 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopStateChangePublisher;
  49 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopUpdatePublisher;
  50 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantDeregisterAckPublisher;
  51 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantRegisterAckPublisher;
  52 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantUpdatePublisher;
  53 import org.onap.policy.models.base.PfModelException;
  54 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  55 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeType;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58 import org.springframework.stereotype.Component;
  59
  60 /**
  61  * This class handles supervision of control loop instances, so only one object of this type should be built at a time.
  62  *
  63  * <p/>
  64  * It is effectively a singleton that is started at system start.
  65  */
  66 @Component
  67 @AllArgsConstructor
  68 public class SupervisionHandler {
  69     private static final Logger LOGGER = LoggerFactory.getLogger(SupervisionHandler.class);
  70
  71     private static final String CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE = "Control loop can't transition from state ";
  72     private static final String CONTROL_LOOP_IS_ALREADY_IN_STATE = "Control loop is already in state ";
  73     private static final String TO_STATE = " to state ";
  74     private static final String AND_TRANSITIONING_TO_STATE = " and transitioning to state ";
  75
  76     private final ControlLoopProvider controlLoopProvider;
  77     private final ParticipantProvider participantProvider;
  78     private final MonitoringProvider monitoringProvider;
  79
  80     // Publishers for participant communication
  81     private final ControlLoopUpdatePublisher controlLoopUpdatePublisher;
  82     private final ControlLoopStateChangePublisher controlLoopStateChangePublisher;
  83     private final ParticipantRegisterAckPublisher participantRegisterAckPublisher;
  84     private final ParticipantDeregisterAckPublisher participantDeregisterAckPublisher;
  85     private final ParticipantUpdatePublisher participantUpdatePublisher;
  86
  87     /**
  88      * Supervision trigger called when a command is issued on control loops.
  89      *
  90      * <p/>
  91      * Causes supervision to start or continue supervision on the control loops in question.
  92      *
  93      * @param controlLoopIdentifierList the control loops for which the supervision command has been issued
  94      * @throws ControlLoopException on supervision triggering exceptions
  95      */
  96     public void triggerControlLoopSupervision(List<ToscaConceptIdentifier> controlLoopIdentifierList)
  97             throws ControlLoopException {
  98
  99         LOGGER.debug("triggering control loop supervision on control loops {}", controlLoopIdentifierList);
 100
 101         if (CollectionUtils.isEmpty(controlLoopIdentifierList)) {
 102             // This is just to force throwing of the exception in certain circumstances.
 103             exceptionOccured(Response.Status.NOT_ACCEPTABLE, "The list of control loops for supervision is empty");
 104         }
 105
 106         for (ToscaConceptIdentifier controlLoopId : controlLoopIdentifierList) {
 107             try {
 108                 var controlLoop = controlLoopProvider.getControlLoop(controlLoopId);
 109
 110                 superviseControlLoop(controlLoop);
 111
 112                 controlLoopProvider.updateControlLoop(controlLoop);
 113             } catch (PfModelException pfme) {
 114                 throw new ControlLoopException(pfme.getErrorResponse().getResponseCode(), pfme.getMessage(), pfme);
 115             }
 116         }
 117     }
 118
 119     /**
 120      * Handle a ParticipantStatus message from a participant.
 121      *
 122      * @param participantStatusMessage the ParticipantStatus message received from a participant
 123      */
 124     @MessageIntercept
 125     public void handleParticipantMessage(ParticipantStatus participantStatusMessage) {
 126         LOGGER.debug("Participant Status received {}", participantStatusMessage);
 127         try {
 128             superviseParticipant(participantStatusMessage);
 129         } catch (PfModelException | ControlLoopException svExc) {
 130             LOGGER.warn("error supervising participant {}", participantStatusMessage.getParticipantId(), svExc);
 131             return;
 132         }
 133
 134         try {
 135             superviseControlLoops(participantStatusMessage);
 136         } catch (PfModelException | ControlLoopException svExc) {
 137             LOGGER.warn("error supervising participant {}", participantStatusMessage.getParticipantId(), svExc);
 138         }
 139     }
 140
 141     /**
 142      * Handle a ParticipantRegister message from a participant.
 143      *
 144      * @param participantRegisterMessage the ParticipantRegister message received from a participant
 145      */
 146     @MessageIntercept
 147     public void handleParticipantMessage(ParticipantRegister participantRegisterMessage) {
 148         LOGGER.debug("Participant Register received {}", participantRegisterMessage);
 149
 150         participantRegisterAckPublisher.send(participantRegisterMessage.getMessageId(),
 151                 participantRegisterMessage.getParticipantId(), participantRegisterMessage.getParticipantType());
 152
 153         participantUpdatePublisher.send(null, true);
 154     }
 155
 156     /**
 157      * Handle a ParticipantDeregister message from a participant.
 158      *
 159      * @param participantDeregisterMessage the ParticipantDeregister message received from a participant
 160      */
 161     @MessageIntercept
 162     public void handleParticipantMessage(ParticipantDeregister participantDeregisterMessage) {
 163         LOGGER.debug("Participant Deregister received {}", participantDeregisterMessage);
 164         try {
 165             var participantList =
 166                 participantProvider.getParticipants(participantDeregisterMessage.getParticipantId().getName(),
 167                     participantDeregisterMessage.getParticipantId().getVersion());
 168
 169             if (participantList != null) {
 170                 for (Participant participant : participantList) {
 171                     participant.setParticipantState(ParticipantState.TERMINATED);
 172                     participant.setHealthStatus(ParticipantHealthStatus.OFF_LINE);
 173                 }
 174                 participantProvider.updateParticipants(participantList);
 175             }
 176         } catch (PfModelException pfme) {
 177             LOGGER.warn("Model exception occured {}", participantDeregisterMessage.getParticipantId());
 178         }
 179
 180         participantDeregisterAckPublisher.send(participantDeregisterMessage.getMessageId());
 181     }
 182
 183     /**
 184      * Handle a ParticipantUpdateAck message from a participant.
 185      *
 186      * @param participantUpdateAckMessage the ParticipantUpdateAck message received from a participant
 187      */
 188     @MessageIntercept
 189     public void handleParticipantMessage(ParticipantUpdateAck participantUpdateAckMessage) {
 190         LOGGER.debug("Participant Update Ack received {}", participantUpdateAckMessage);
 191         try {
 192             var participantList =
 193                 participantProvider.getParticipants(participantUpdateAckMessage.getParticipantId().getName(),
 194                     participantUpdateAckMessage.getParticipantId().getVersion());
 195
 196             if (participantList != null) {
 197                 for (Participant participant : participantList) {
 198                     participant.setParticipantState(participantUpdateAckMessage.getState());
 199                 }
 200                 participantProvider.updateParticipants(participantList);
 201             } else {
 202                 LOGGER.warn("Participant not found in database {}", participantUpdateAckMessage.getParticipantId());
 203             }
 204         } catch (PfModelException pfme) {
 205             LOGGER.warn("Model exception occured {}", participantUpdateAckMessage.getParticipantId());
 206         }
 207     }
 208
 209     /**
 210      * Send commissioning update message to dmaap.
 211      *
 212      */
 213     public void handleSendCommissionMessage(Map<String, ToscaNodeType> commonPropertiesMap) {
 214         LOGGER.debug("Participant update message being sent {}");
 215         participantUpdatePublisher.send(commonPropertiesMap, true);
 216     }
 217
 218     /**
 219      * Send decommissioning update message to dmaap.
 220      *
 221      */
 222     public void handleSendDeCommissionMessage() {
 223         LOGGER.debug("Participant update message being sent");
 224         participantUpdatePublisher.send(null, false);
 225     }
 226
 227     /**
 228      * Handle a ControlLoop update acknowledge message from a participant.
 229      *
 230      * @param controlLoopAckMessage the ControlLoopAck message received from a participant
 231      */
 232     @MessageIntercept
 233     public void handleControlLoopUpdateAckMessage(ControlLoopAck controlLoopAckMessage) {
 234         LOGGER.debug("ControlLoop Update Ack message received {}", controlLoopAckMessage);
 235         setClElementStateInDb(controlLoopAckMessage);
 236     }
 237
 238     /**
 239      * Handle a ControlLoop statechange acknowledge message from a participant.
 240      *
 241      * @param controlLoopAckMessage the ControlLoopAck message received from a participant
 242      */
 243     @MessageIntercept
 244     public void handleControlLoopStateChangeAckMessage(ControlLoopAck controlLoopAckMessage) {
 245         LOGGER.debug("ControlLoop StateChange Ack message received {}", controlLoopAckMessage);
 246         setClElementStateInDb(controlLoopAckMessage);
 247     }
 248
 249     private void setClElementStateInDb(ControlLoopAck controlLoopAckMessage) {
 250         if (controlLoopAckMessage.getControlLoopResultMap() != null) {
 251             try {
 252                 var controlLoop = controlLoopProvider.getControlLoop(controlLoopAckMessage.getControlLoopId());
 253                 if (controlLoop != null) {
 254                     var updated = updateState(controlLoop, controlLoopAckMessage
 255                                     .getControlLoopResultMap().entrySet())
 256                                     || setPrimed(controlLoop);
 257                     if (updated) {
 258                         controlLoopProvider.updateControlLoop(controlLoop);
 259                     }
 260                 } else {
 261                     LOGGER.warn("ControlLoop not found in database {}", controlLoopAckMessage.getControlLoopId());
 262                 }
 263             } catch (PfModelException pfme) {
 264                 LOGGER.warn("Model exception occured {}", controlLoopAckMessage.getControlLoopId());
 265             }
 266         }
 267     }
 268
 269     private boolean updateState(ControlLoop controlLoop, Set<Map.Entry<UUID, ControlLoopElementAck>>
 270             controlLoopResultSet) {
 271         var updated = false;
 272         for (var clElementAck : controlLoopResultSet) {
 273             var element = controlLoop.getElements().get(clElementAck.getKey());
 274             if (element != null) {
 275                 element.setState(clElementAck.getValue().getState());
 276                 updated = true;
 277             }
 278         }
 279         return updated;
 280     }
 281
 282     private boolean setPrimed(ControlLoop controlLoop) {
 283         var clElements = controlLoop.getElements().values();
 284         if (clElements != null) {
 285             Boolean primedFlag = true;
 286             var checkOpt = controlLoop.getElements().values().stream()
 287                             .filter(clElement -> (!clElement.getState().equals(ControlLoopState.PASSIVE)
 288                                     || !clElement.getState().equals(ControlLoopState.RUNNING))).findAny();
 289             if (checkOpt.isEmpty()) {
 290                 primedFlag = false;
 291             }
 292             controlLoop.setPrimed(primedFlag);
 293             return true;
 294         }
 295
 296         return false;
 297     }
 298
 299     /**
 300      * Supervise a control loop, performing whatever actions need to be performed on the control loop.
 301      *
 302      * @param controlLoop the control loop to supervises
 303      * @throws ControlLoopException on supervision errors
 304      */
 305     private void superviseControlLoop(ControlLoop controlLoop) throws ControlLoopException {
 306         switch (controlLoop.getOrderedState()) {
 307             case UNINITIALISED:
 308                 superviseControlLoopUninitialization(controlLoop);
 309                 break;
 310
 311             case PASSIVE:
 312                 superviseControlLoopPassivation(controlLoop);
 313                 break;
 314
 315             case RUNNING:
 316                 superviseControlLoopActivation(controlLoop);
 317                 break;
 318
 319             default:
 320                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 321                         "A control loop cannot be commanded to go into state " + controlLoop.getOrderedState().name());
 322         }
 323     }
 324
 325     /**
 326      * Supervise a control loop uninitialisation, performing whatever actions need to be performed on the control loop,
 327      * control loop ordered state is UNINITIALIZED.
 328      *
 329      * @param controlLoop the control loop to supervises
 330      * @throws ControlLoopException on supervision errors
 331      */
 332     private void superviseControlLoopUninitialization(ControlLoop controlLoop) throws ControlLoopException {
 333         switch (controlLoop.getState()) {
 334             case UNINITIALISED:
 335                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 336                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 337                 break;
 338
 339             case UNINITIALISED2PASSIVE:
 340             case PASSIVE:
 341                 controlLoop.setState(ControlLoopState.PASSIVE2UNINITIALISED);
 342                 controlLoopStateChangePublisher.send(controlLoop);
 343                 break;
 344
 345             case PASSIVE2UNINITIALISED:
 346                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 347                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 348                 break;
 349
 350             default:
 351                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 352                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 353                 break;
 354         }
 355     }
 356
 357     private void superviseControlLoopPassivation(ControlLoop controlLoop)
 358             throws ControlLoopException {
 359         switch (controlLoop.getState()) {
 360             case PASSIVE:
 361                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 362                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 363                 break;
 364             case UNINITIALISED:
 365                 controlLoop.setState(ControlLoopState.UNINITIALISED2PASSIVE);
 366                 controlLoopUpdatePublisher.send(controlLoop);
 367                 break;
 368
 369             case UNINITIALISED2PASSIVE:
 370             case RUNNING2PASSIVE:
 371                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 372                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 373                 break;
 374
 375             case RUNNING:
 376                 controlLoop.setState(ControlLoopState.RUNNING2PASSIVE);
 377                 controlLoopStateChangePublisher.send(controlLoop);
 378                 break;
 379
 380             default:
 381                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 382                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 383                 break;
 384         }
 385     }
 386
 387     private void superviseControlLoopActivation(ControlLoop controlLoop) throws ControlLoopException {
 388         switch (controlLoop.getState()) {
 389             case RUNNING:
 390                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 391                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 392                 break;
 393
 394             case PASSIVE2RUNNING:
 395                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 396                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 397                 break;
 398
 399             case PASSIVE:
 400                 controlLoop.setState(ControlLoopState.PASSIVE2RUNNING);
 401                 controlLoopStateChangePublisher.send(controlLoop);
 402                 break;
 403
 404             default:
 405                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 406                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 407                 break;
 408         }
 409     }
 410
 411     private void superviseParticipant(ParticipantStatus participantStatusMessage)
 412             throws PfModelException, ControlLoopException {
 413         if (participantStatusMessage.getParticipantId() == null) {
 414             exceptionOccured(Response.Status.NOT_FOUND, "Participant ID on PARTICIPANT_STATUS message is null");
 415         }
 416
 417         List<Participant> participantList =
 418                 participantProvider.getParticipants(participantStatusMessage.getParticipantId().getName(),
 419                         participantStatusMessage.getParticipantId().getVersion());
 420
 421         if (CollectionUtils.isEmpty(participantList)) {
 422             var participant = new Participant();
 423             participant.setName(participantStatusMessage.getParticipantId().getName());
 424             participant.setVersion(participantStatusMessage.getParticipantId().getVersion());
 425             participant.setDefinition(participantStatusMessage.getParticipantId());
 426             participant.setParticipantType(participantStatusMessage.getParticipantType());
 427             participant.setParticipantState(participantStatusMessage.getState());
 428             participant.setHealthStatus(participantStatusMessage.getHealthStatus());
 429
 430             participantList.add(participant);
 431             participantProvider.createParticipants(participantList);
 432         } else {
 433             for (Participant participant : participantList) {
 434                 participant.setParticipantState(participantStatusMessage.getState());
 435                 participant.setHealthStatus(participantStatusMessage.getHealthStatus());
 436             }
 437             participantProvider.updateParticipants(participantList);
 438         }
 439
 440         monitoringProvider.createParticipantStatistics(List.of(participantStatusMessage.getParticipantStatistics()));
 441     }
 442
 443     private void superviseControlLoops(ParticipantStatus participantStatusMessage)
 444             throws PfModelException, ControlLoopException {
 445         if (participantStatusMessage.getControlLoopInfoList() != null) {
 446             for (ControlLoopInfo clEntry : participantStatusMessage.getControlLoopInfoList()) {
 447                 var dbControlLoop =
 448                         controlLoopProvider.getControlLoop(new ToscaConceptIdentifier(clEntry.getControlLoopId()));
 449                 if (dbControlLoop == null) {
 450                     exceptionOccured(Response.Status.NOT_FOUND,
 451                             "PARTICIPANT_STATUS control loop not found in database: " + clEntry.getControlLoopId());
 452                 }
 453                 dbControlLoop.setState(clEntry.getState());
 454                 monitoringProvider.createClElementStatistics(
 455                         clEntry.getControlLoopStatistics().getClElementStatisticsList().getClElementStatistics());
 456             }
 457         }
 458     }
 459
 460     private void exceptionOccured(Response.Status status, String reason) throws ControlLoopException {
 461         throw new ControlLoopException(status, reason);
 462     }
 463 }