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.Collections;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Set;
  28 import java.util.UUID;
  29 import javax.ws.rs.core.Response;
  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.persistence.provider.ControlLoopProvider;
  41 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
  42 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ControlLoopAck;
  43 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregister;
  44 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegister;
  45 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantStatus;
  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     public void handleParticipantMessage(ParticipantRegister participantRegisterMessage) {
 147         LOGGER.debug("Participant Register received {}", participantRegisterMessage);
 148
 149         participantRegisterAckPublisher.send(participantRegisterMessage.getMessageId(),
 150                 participantRegisterMessage.getParticipantId(), participantRegisterMessage.getParticipantType());
 151     }
 152
 153     /**
 154      * Handle a ParticipantDeregister message from a participant.
 155      *
 156      * @param participantDeregisterMessage the ParticipantDeregister message received from a participant
 157      */
 158     @MessageIntercept
 159     public void handleParticipantMessage(ParticipantDeregister participantDeregisterMessage) {
 160         LOGGER.debug("Participant Deregister received {}", participantDeregisterMessage);
 161         try {
 162             var participantList =
 163                 participantProvider.getParticipants(participantDeregisterMessage.getParticipantId().getName(),
 164                     participantDeregisterMessage.getParticipantId().getVersion());
 165
 166             if (participantList != null) {
 167                 for (Participant participant : participantList) {
 168                     participant.setParticipantState(ParticipantState.TERMINATED);
 169                     participant.setHealthStatus(ParticipantHealthStatus.OFF_LINE);
 170                 }
 171                 participantProvider.updateParticipants(participantList);
 172             }
 173         } catch (PfModelException pfme) {
 174             LOGGER.warn("Model exception occured {}", participantDeregisterMessage.getParticipantId());
 175         }
 176
 177         participantDeregisterAckPublisher.send(participantDeregisterMessage.getMessageId());
 178     }
 179
 180     /**
 181      * Handle a ParticipantUpdateAck message from a participant.
 182      *
 183      * @param participantUpdateAckMessage the ParticipantUpdateAck message received from a participant
 184      */
 185     @MessageIntercept
 186     public void handleParticipantMessage(ParticipantUpdateAck participantUpdateAckMessage) {
 187         LOGGER.debug("Participant Update Ack received {}", participantUpdateAckMessage);
 188         try {
 189             var participantList =
 190                 participantProvider.getParticipants(participantUpdateAckMessage.getParticipantId().getName(),
 191                     participantUpdateAckMessage.getParticipantId().getVersion());
 192
 193             if (participantList != null) {
 194                 for (Participant participant : participantList) {
 195                     participant.setParticipantState(participantUpdateAckMessage.getState());
 196                 }
 197                 participantProvider.updateParticipants(participantList);
 198             } else {
 199                 LOGGER.warn("Participant not found in database {}", participantUpdateAckMessage.getParticipantId());
 200             }
 201         } catch (PfModelException pfme) {
 202             LOGGER.warn("Model exception occured {}", participantUpdateAckMessage.getParticipantId());
 203         }
 204     }
 205
 206     /**
 207      * Send commissioning update message to dmaap.
 208      *
 209      */
 210     public void handleSendCommissionMessage(Map<String, ToscaNodeType> commonPropertiesMap) {
 211         LOGGER.debug("Participant update message being sent {}");
 212         participantUpdatePublisher.send(commonPropertiesMap, true);
 213     }
 214
 215     /**
 216      * Send decommissioning update message to dmaap.
 217      *
 218      */
 219     public void handleSendDeCommissionMessage() {
 220         LOGGER.debug("Participant update message being sent");
 221         participantUpdatePublisher.send(Collections.emptyMap(), false);
 222     }
 223
 224     /**
 225      * Handle a ControlLoop update acknowledge message from a participant.
 226      *
 227      * @param controlLoopAckMessage the ControlLoopAck message received from a participant
 228      */
 229     @MessageIntercept
 230     public void handleControlLoopUpdateAckMessage(ControlLoopAck controlLoopAckMessage) {
 231         LOGGER.debug("ControlLoop Update Ack message received {}", controlLoopAckMessage);
 232         setClElementStateInDb(controlLoopAckMessage);
 233     }
 234
 235     /**
 236      * Handle a ControlLoop statechange acknowledge message from a participant.
 237      *
 238      * @param controlLoopAckMessage the ControlLoopAck message received from a participant
 239      */
 240     @MessageIntercept
 241     public void handleControlLoopStateChangeAckMessage(ControlLoopAck controlLoopAckMessage) {
 242         LOGGER.debug("ControlLoop StateChange Ack message received {}", controlLoopAckMessage);
 243         setClElementStateInDb(controlLoopAckMessage);
 244     }
 245
 246     private void setClElementStateInDb(ControlLoopAck controlLoopAckMessage) {
 247         if (controlLoopAckMessage.getControlLoopResultMap() != null) {
 248             try {
 249                 var controlLoop = controlLoopProvider.getControlLoop(controlLoopAckMessage.getControlLoopId());
 250                 if (controlLoop != null) {
 251                     var updated = updateState(controlLoop, controlLoopAckMessage
 252                                     .getControlLoopResultMap().entrySet())
 253                                     || setPrimed(controlLoop);
 254                     if (updated) {
 255                         controlLoopProvider.updateControlLoop(controlLoop);
 256                     }
 257                 } else {
 258                     LOGGER.warn("ControlLoop not found in database {}", controlLoopAckMessage.getControlLoopId());
 259                 }
 260             } catch (PfModelException pfme) {
 261                 LOGGER.warn("Model exception occured {}", controlLoopAckMessage.getControlLoopId());
 262             }
 263         }
 264     }
 265
 266     private boolean updateState(ControlLoop controlLoop, Set<Map.Entry<UUID, ControlLoopElementAck>>
 267             controlLoopResultSet) {
 268         var updated = false;
 269         for (var clElementAck : controlLoopResultSet) {
 270             var element = controlLoop.getElements().get(clElementAck.getKey());
 271             if (element != null) {
 272                 element.setState(clElementAck.getValue().getState());
 273                 updated = true;
 274             }
 275         }
 276         return updated;
 277     }
 278
 279     private boolean setPrimed(ControlLoop controlLoop) {
 280         var clElements = controlLoop.getElements().values();
 281         if (clElements != null) {
 282             Boolean primedFlag = true;
 283             var checkOpt = controlLoop.getElements().values().stream()
 284                             .filter(clElement -> (!clElement.getState().equals(ControlLoopState.PASSIVE)
 285                                     || !clElement.getState().equals(ControlLoopState.RUNNING))).findAny();
 286             if (checkOpt.isEmpty()) {
 287                 primedFlag = false;
 288             }
 289             controlLoop.setPrimed(primedFlag);
 290             return true;
 291         }
 292
 293         return false;
 294     }
 295
 296     /**
 297      * Supervise a control loop, performing whatever actions need to be performed on the control loop.
 298      *
 299      * @param controlLoop the control loop to supervises
 300      * @throws ControlLoopException on supervision errors
 301      */
 302     private void superviseControlLoop(ControlLoop controlLoop) throws ControlLoopException {
 303         switch (controlLoop.getOrderedState()) {
 304             case UNINITIALISED:
 305                 superviseControlLoopUninitialization(controlLoop);
 306                 break;
 307
 308             case PASSIVE:
 309                 superviseControlLoopPassivation(controlLoop);
 310                 break;
 311
 312             case RUNNING:
 313                 superviseControlLoopActivation(controlLoop);
 314                 break;
 315
 316             default:
 317                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 318                         "A control loop cannot be commanded to go into state " + controlLoop.getOrderedState().name());
 319         }
 320     }
 321
 322     /**
 323      * Supervise a control loop uninitialisation, performing whatever actions need to be performed on the control loop,
 324      * control loop ordered state is UNINITIALIZED.
 325      *
 326      * @param controlLoop the control loop to supervises
 327      * @throws ControlLoopException on supervision errors
 328      */
 329     private void superviseControlLoopUninitialization(ControlLoop controlLoop) throws ControlLoopException {
 330         switch (controlLoop.getState()) {
 331             case UNINITIALISED:
 332                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 333                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 334                 break;
 335
 336             case UNINITIALISED2PASSIVE:
 337             case PASSIVE:
 338                 controlLoop.setState(ControlLoopState.PASSIVE2UNINITIALISED);
 339                 controlLoopStateChangePublisher.send(controlLoop);
 340                 break;
 341
 342             case PASSIVE2UNINITIALISED:
 343                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 344                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 345                 break;
 346
 347             default:
 348                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 349                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 350                 break;
 351         }
 352     }
 353
 354     private void superviseControlLoopPassivation(ControlLoop controlLoop)
 355             throws ControlLoopException {
 356         switch (controlLoop.getState()) {
 357             case PASSIVE:
 358                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 359                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 360                 break;
 361             case UNINITIALISED:
 362                 controlLoop.setState(ControlLoopState.UNINITIALISED2PASSIVE);
 363                 controlLoopUpdatePublisher.send(controlLoop);
 364                 break;
 365
 366             case UNINITIALISED2PASSIVE:
 367             case RUNNING2PASSIVE:
 368                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 369                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 370                 break;
 371
 372             case RUNNING:
 373                 controlLoop.setState(ControlLoopState.RUNNING2PASSIVE);
 374                 controlLoopStateChangePublisher.send(controlLoop);
 375                 break;
 376
 377             default:
 378                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 379                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 380                 break;
 381         }
 382     }
 383
 384     private void superviseControlLoopActivation(ControlLoop controlLoop) throws ControlLoopException {
 385         switch (controlLoop.getState()) {
 386             case RUNNING:
 387                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 388                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 389                 break;
 390
 391             case PASSIVE2RUNNING:
 392                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 393                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 394                 break;
 395
 396             case PASSIVE:
 397                 controlLoop.setState(ControlLoopState.PASSIVE2RUNNING);
 398                 controlLoopStateChangePublisher.send(controlLoop);
 399                 break;
 400
 401             default:
 402                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 403                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 404                 break;
 405         }
 406     }
 407
 408     private void superviseParticipant(ParticipantStatus participantStatusMessage)
 409             throws PfModelException, ControlLoopException {
 410         if (participantStatusMessage.getParticipantId() == null) {
 411             exceptionOccured(Response.Status.NOT_FOUND, "Participant ID on PARTICIPANT_STATUS message is null");
 412         }
 413
 414         List<Participant> participantList =
 415                 participantProvider.getParticipants(participantStatusMessage.getParticipantId().getName(),
 416                         participantStatusMessage.getParticipantId().getVersion());
 417
 418         if (CollectionUtils.isEmpty(participantList)) {
 419             var participant = new Participant();
 420             participant.setName(participantStatusMessage.getParticipantId().getName());
 421             participant.setVersion(participantStatusMessage.getParticipantId().getVersion());
 422             participant.setDefinition(participantStatusMessage.getParticipantId());
 423             participant.setParticipantType(participantStatusMessage.getParticipantType());
 424             participant.setParticipantState(participantStatusMessage.getState());
 425             participant.setHealthStatus(participantStatusMessage.getHealthStatus());
 426
 427             participantList.add(participant);
 428             participantProvider.createParticipants(participantList);
 429         } else {
 430             for (Participant participant : participantList) {
 431                 participant.setParticipantState(participantStatusMessage.getState());
 432                 participant.setHealthStatus(participantStatusMessage.getHealthStatus());
 433             }
 434             participantProvider.updateParticipants(participantList);
 435         }
 436
 437         monitoringProvider.createParticipantStatistics(List.of(participantStatusMessage.getParticipantStatistics()));
 438     }
 439
 440     private void superviseControlLoops(ParticipantStatus participantStatusMessage)
 441             throws PfModelException, ControlLoopException {
 442         if (participantStatusMessage.getControlLoopInfoList() != null) {
 443             for (ControlLoopInfo clEntry : participantStatusMessage.getControlLoopInfoList()) {
 444                 var dbControlLoop =
 445                         controlLoopProvider.getControlLoop(new ToscaConceptIdentifier(clEntry.getControlLoopId()));
 446                 if (dbControlLoop == null) {
 447                     exceptionOccured(Response.Status.NOT_FOUND,
 448                             "PARTICIPANT_STATUS control loop not found in database: " + clEntry.getControlLoopId());
 449                 }
 450                 dbControlLoop.setState(clEntry.getState());
 451                 monitoringProvider.createClElementStatistics(
 452                         clEntry.getControlLoopStatistics().getClElementStatisticsList().getClElementStatistics());
 453             }
 454         }
 455     }
 456
 457     private void exceptionOccured(Response.Status status, String reason) throws ControlLoopException {
 458         throw new ControlLoopException(status, reason);
 459     }
 460 }