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.messages.dmaap.participant.ControlLoopAck;
  44 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregister;
  45 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantMessage;
  46 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegister;
  47 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantStatus;
  48 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdateAck;
  49 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
  50 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopStateChangePublisher;
  51 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopUpdatePublisher;
  52 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantDeregisterAckPublisher;
  53 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantRegisterAckPublisher;
  54 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantUpdatePublisher;
  55 import org.onap.policy.models.base.PfModelException;
  56 import org.onap.policy.models.base.PfModelRuntimeException;
  57 import org.onap.policy.models.provider.PolicyModelsProvider;
  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 PolicyModelsProvider modelsProvider;
  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 participantList =
 178                     participantProvider.getParticipants(participantDeregisterMessage.getParticipantId().getName(),
 179                             participantDeregisterMessage.getParticipantId().getVersion());
 180
 181             if (participantList != null) {
 182                 for (Participant participant : participantList) {
 183                     participant.setParticipantState(ParticipantState.TERMINATED);
 184                     participant.setHealthStatus(ParticipantHealthStatus.OFF_LINE);
 185                 }
 186                 participantProvider.updateParticipants(participantList);
 187             }
 188         } catch (PfModelException pfme) {
 189             LOGGER.warn("Model exception occured with participant id {}",
 190                     participantDeregisterMessage.getParticipantId());
 191         }
 192
 193         participantDeregisterAckPublisher.send(participantDeregisterMessage.getMessageId());
 194     }
 195
 196     /**
 197      * Handle a ParticipantUpdateAck message from a participant.
 198      *
 199      * @param participantUpdateAckMessage the ParticipantUpdateAck message received from a participant
 200      */
 201     @MessageIntercept
 202     public void handleParticipantMessage(ParticipantUpdateAck participantUpdateAckMessage) {
 203         LOGGER.debug("Participant Update Ack received {}", participantUpdateAckMessage);
 204         try {
 205             var participantList =
 206                     participantProvider.getParticipants(participantUpdateAckMessage.getParticipantId().getName(),
 207                             participantUpdateAckMessage.getParticipantId().getVersion());
 208
 209             if (participantList != null) {
 210                 for (Participant participant : participantList) {
 211                     participant.setParticipantState(participantUpdateAckMessage.getState());
 212                 }
 213                 participantProvider.updateParticipants(participantList);
 214             } else {
 215                 LOGGER.warn("Participant not found in database {}", participantUpdateAckMessage.getParticipantId());
 216             }
 217         } catch (PfModelException pfme) {
 218             LOGGER.warn("Model exception occured with participant id {}",
 219                     participantUpdateAckMessage.getParticipantId());
 220         }
 221     }
 222
 223     /**
 224      * Send commissioning update message to dmaap.
 225      *
 226      * @param name the ToscaServiceTemplate name
 227      * @param version the ToscaServiceTemplate version
 228      */
 229     public void handleSendCommissionMessage(String name, String version) {
 230         LOGGER.debug("Participant update message with serviveTemplate {} {} being sent to all participants", name,
 231                 version);
 232         participantUpdatePublisher.sendComissioningBroadcast(name, version);
 233     }
 234
 235     /**
 236      * Send decommissioning update message to dmaap.
 237      *
 238      */
 239     public void handleSendDeCommissionMessage() {
 240         LOGGER.debug("Participant update message being sent");
 241         participantUpdatePublisher.sendDecomisioning();
 242     }
 243
 244     /**
 245      * Handle a ControlLoop update acknowledge message from a participant.
 246      *
 247      * @param controlLoopAckMessage the ControlLoopAck message received from a participant
 248      */
 249     @MessageIntercept
 250     public void handleControlLoopUpdateAckMessage(ControlLoopAck controlLoopAckMessage) {
 251         LOGGER.debug("ControlLoop Update Ack message received {}", controlLoopAckMessage);
 252         setClElementStateInDb(controlLoopAckMessage);
 253     }
 254
 255     /**
 256      * Handle a ControlLoop statechange acknowledge message from a participant.
 257      *
 258      * @param controlLoopAckMessage the ControlLoopAck message received from a participant
 259      */
 260     @MessageIntercept
 261     public void handleControlLoopStateChangeAckMessage(ControlLoopAck controlLoopAckMessage) {
 262         LOGGER.debug("ControlLoop StateChange Ack message received {}", controlLoopAckMessage);
 263         setClElementStateInDb(controlLoopAckMessage);
 264     }
 265
 266     private void setClElementStateInDb(ControlLoopAck controlLoopAckMessage) {
 267         if (controlLoopAckMessage.getControlLoopResultMap() != null) {
 268             try {
 269                 var controlLoop = controlLoopProvider.getControlLoop(controlLoopAckMessage.getControlLoopId());
 270                 if (controlLoop != null) {
 271                     var updated = updateState(controlLoop, controlLoopAckMessage.getControlLoopResultMap().entrySet());
 272                     updated |= setPrimed(controlLoop);
 273                     if (updated) {
 274                         controlLoopProvider.updateControlLoop(controlLoop);
 275                     }
 276                 } else {
 277                     LOGGER.warn("ControlLoop not found in database {}", controlLoopAckMessage.getControlLoopId());
 278                 }
 279             } catch (PfModelException pfme) {
 280                 LOGGER.warn("Model exception occured with ControlLoop Id {}", controlLoopAckMessage.getControlLoopId());
 281             }
 282         }
 283     }
 284
 285     private boolean updateState(ControlLoop controlLoop,
 286             Set<Map.Entry<UUID, ControlLoopElementAck>> controlLoopResultSet) {
 287         var updated = false;
 288         for (var clElementAck : controlLoopResultSet) {
 289             var element = controlLoop.getElements().get(clElementAck.getKey());
 290             if (element != null) {
 291                 element.setState(clElementAck.getValue().getState());
 292                 updated = true;
 293             }
 294         }
 295         return updated;
 296     }
 297
 298     private boolean setPrimed(ControlLoop controlLoop) {
 299         var clElements = controlLoop.getElements().values();
 300         if (clElements != null) {
 301             Boolean primedFlag = true;
 302             var checkOpt = controlLoop.getElements().values().stream()
 303                     .filter(clElement -> (!clElement.getState().equals(ControlLoopState.PASSIVE)
 304                             || !clElement.getState().equals(ControlLoopState.RUNNING)))
 305                     .findAny();
 306             if (checkOpt.isEmpty()) {
 307                 primedFlag = false;
 308             }
 309             controlLoop.setPrimed(primedFlag);
 310             return true;
 311         }
 312
 313         return false;
 314     }
 315
 316     /**
 317      * Supervise a control loop, performing whatever actions need to be performed on the control loop.
 318      *
 319      * @param controlLoop the control loop to supervises
 320      * @throws ControlLoopException on supervision errors
 321      */
 322     private void superviseControlLoop(ControlLoop controlLoop) throws ControlLoopException {
 323         switch (controlLoop.getOrderedState()) {
 324             case UNINITIALISED:
 325                 superviseControlLoopUninitialization(controlLoop);
 326                 break;
 327
 328             case PASSIVE:
 329                 superviseControlLoopPassivation(controlLoop);
 330                 break;
 331
 332             case RUNNING:
 333                 superviseControlLoopActivation(controlLoop);
 334                 break;
 335
 336             default:
 337                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 338                         "A control loop cannot be commanded to go into state " + controlLoop.getOrderedState().name());
 339         }
 340     }
 341
 342     /**
 343      * Supervise a control loop uninitialisation, performing whatever actions need to be performed on the control loop,
 344      * control loop ordered state is UNINITIALIZED.
 345      *
 346      * @param controlLoop the control loop to supervises
 347      * @throws ControlLoopException on supervision errors
 348      */
 349     private void superviseControlLoopUninitialization(ControlLoop controlLoop) throws ControlLoopException {
 350         switch (controlLoop.getState()) {
 351             case UNINITIALISED:
 352                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 353                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 354                 break;
 355
 356             case UNINITIALISED2PASSIVE:
 357             case PASSIVE:
 358                 controlLoop.setState(ControlLoopState.PASSIVE2UNINITIALISED);
 359                 controlLoopStateChangePublisher.send(controlLoop, getFirstStartPhase(controlLoop));
 360                 break;
 361
 362             case PASSIVE2UNINITIALISED:
 363                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 364                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 365                 break;
 366
 367             default:
 368                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 369                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 370                 break;
 371         }
 372     }
 373
 374     private void superviseControlLoopPassivation(ControlLoop controlLoop) throws ControlLoopException {
 375         switch (controlLoop.getState()) {
 376             case PASSIVE:
 377                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 378                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 379                 break;
 380             case UNINITIALISED:
 381                 controlLoop.setState(ControlLoopState.UNINITIALISED2PASSIVE);
 382                 controlLoopUpdatePublisher.send(controlLoop);
 383                 break;
 384
 385             case UNINITIALISED2PASSIVE:
 386             case RUNNING2PASSIVE:
 387                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 388                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 389                 break;
 390
 391             case RUNNING:
 392                 controlLoop.setState(ControlLoopState.RUNNING2PASSIVE);
 393                 controlLoopStateChangePublisher.send(controlLoop, getFirstStartPhase(controlLoop));
 394                 break;
 395
 396             default:
 397                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 398                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 399                 break;
 400         }
 401     }
 402
 403     private void superviseControlLoopActivation(ControlLoop controlLoop) throws ControlLoopException {
 404         switch (controlLoop.getState()) {
 405             case RUNNING:
 406                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 407                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 408                 break;
 409
 410             case PASSIVE2RUNNING:
 411                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 412                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 413                 break;
 414
 415             case PASSIVE:
 416                 controlLoop.setState(ControlLoopState.PASSIVE2RUNNING);
 417                 controlLoopStateChangePublisher.send(controlLoop, getFirstStartPhase(controlLoop));
 418                 break;
 419
 420             default:
 421                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 422                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 423                 break;
 424         }
 425     }
 426
 427     private int getFirstStartPhase(ControlLoop controlLoop) {
 428         ToscaServiceTemplate toscaServiceTemplate = null;
 429         try {
 430             toscaServiceTemplate = modelsProvider.getServiceTemplateList(null, null).get(0);
 431         } catch (PfModelException e) {
 432             throw new PfModelRuntimeException(Status.BAD_REQUEST, "Canont load ToscaServiceTemplate from DB", e);
 433         }
 434         return ParticipantUtils.getFirstStartPhase(controlLoop, toscaServiceTemplate);
 435     }
 436
 437     private void checkParticipant(ParticipantMessage participantMessage, ParticipantState participantState,
 438             ParticipantHealthStatus healthStatus) throws ControlLoopException, PfModelException {
 439         if (participantMessage.getParticipantId() == null) {
 440             exceptionOccured(Response.Status.NOT_FOUND, "Participant ID on PARTICIPANT_STATUS message is null");
 441         }
 442         List<Participant> participantList = participantProvider.getParticipants(
 443                 participantMessage.getParticipantId().getName(), participantMessage.getParticipantId().getVersion());
 444
 445         if (CollectionUtils.isEmpty(participantList)) {
 446             var participant = new Participant();
 447             participant.setName(participantMessage.getParticipantId().getName());
 448             participant.setVersion(participantMessage.getParticipantId().getVersion());
 449             participant.setDefinition(participantMessage.getParticipantId());
 450             participant.setParticipantType(participantMessage.getParticipantType());
 451             participant.setParticipantState(participantState);
 452             participant.setHealthStatus(healthStatus);
 453
 454             participantList.add(participant);
 455             participantProvider.createParticipants(participantList);
 456         } else {
 457             for (Participant participant : participantList) {
 458                 participant.setParticipantState(participantState);
 459                 participant.setHealthStatus(healthStatus);
 460             }
 461             participantProvider.updateParticipants(participantList);
 462         }
 463     }
 464
 465     private void superviseParticipant(ParticipantStatus participantStatusMessage)
 466             throws PfModelException, ControlLoopException {
 467
 468         checkParticipant(participantStatusMessage, participantStatusMessage.getState(),
 469                 participantStatusMessage.getHealthStatus());
 470
 471         monitoringProvider.createParticipantStatistics(List.of(participantStatusMessage.getParticipantStatistics()));
 472     }
 473
 474     private void superviseControlLoops(ParticipantStatus participantStatusMessage)
 475             throws PfModelException, ControlLoopException {
 476         if (participantStatusMessage.getControlLoopInfoList() != null) {
 477             for (ControlLoopInfo clEntry : participantStatusMessage.getControlLoopInfoList()) {
 478                 var dbControlLoop =
 479                         controlLoopProvider.getControlLoop(new ToscaConceptIdentifier(clEntry.getControlLoopId()));
 480                 if (dbControlLoop == null) {
 481                     exceptionOccured(Response.Status.NOT_FOUND,
 482                             "PARTICIPANT_STATUS control loop not found in database: " + clEntry.getControlLoopId());
 483                 }
 484                 dbControlLoop.setState(clEntry.getState());
 485                 monitoringProvider.createClElementStatistics(
 486                         clEntry.getControlLoopStatistics().getClElementStatisticsList().getClElementStatistics());
 487             }
 488         }
 489     }
 490
 491     private void exceptionOccured(Response.Status status, String reason) throws ControlLoopException {
 492         throw new ControlLoopException(status, reason);
 493     }
 494 }