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