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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.controlloop.runtime.supervision;
  22
  23 import java.util.List;
  24 import java.util.UUID;
  25 import javax.ws.rs.core.Response;
  26 import javax.ws.rs.core.Response.Status;
  27 import org.apache.commons.collections4.CollectionUtils;
  28 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
  29 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopRuntimeException;
  30 import org.onap.policy.clamp.controlloop.common.handler.ControlLoopHandler;
  31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
  32 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  33 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
  34 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  35 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
  36 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
  37 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantControlLoopStateChange;
  38 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantControlLoopUpdate;
  39 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantMessageType;
  40 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantStatus;
  41 import org.onap.policy.clamp.controlloop.runtime.commissioning.CommissioningHandler;
  42 import org.onap.policy.clamp.controlloop.runtime.main.parameters.ClRuntimeParameterGroup;
  43 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringHandler;
  44 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
  45 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantControlLoopStateChangePublisher;
  46 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantControlLoopUpdatePublisher;
  47 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantStateChangePublisher;
  48 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantStatusListener;
  49 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  50 import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
  51 import org.onap.policy.common.utils.services.Registry;
  52 import org.onap.policy.common.utils.services.ServiceManager;
  53 import org.onap.policy.common.utils.services.ServiceManagerException;
  54 import org.onap.policy.models.base.PfModelException;
  55 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 /**
  60  * This class handles supervision of control loop instances, so only one object of this type should be built at a time.
  61  *
  62  * <p/> It is effectively a singleton that is started at system start.
  63  */
  64 public class SupervisionHandler extends ControlLoopHandler {
  65     private static final Logger LOGGER = LoggerFactory.getLogger(SupervisionHandler.class);
  66
  67     private static final String CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE = "Control loop can't transition from state ";
  68     private static final String CONTROL_LOOP_IS_ALREADY_IN_STATE = "Control loop is already in state ";
  69     private static final String TO_STATE = " to state ";
  70     private static final String AND_TRANSITIONING_TO_STATE = " and transitioning to state ";
  71
  72     private ControlLoopProvider controlLoopProvider;
  73     private ParticipantProvider participantProvider;
  74     private MonitoringProvider monitoringProvider;
  75
  76     // Publishers for participant communication
  77     private ParticipantStateChangePublisher stateChangePublisher;
  78     private ParticipantControlLoopUpdatePublisher controlLoopUpdatePublisher;
  79     private ParticipantControlLoopStateChangePublisher controlLoopStateChangePublisher;
  80
  81     // Database scanner
  82     private SupervisionScanner scanner;
  83
  84     /**
  85      * Used to manage the services.
  86      */
  87     private ServiceManager manager;
  88     private ServiceManager publisherManager;
  89
  90     /**
  91      * Gets the SupervisionHandler.
  92      *
  93      * @return SupervisionHandler
  94      */
  95     public static SupervisionHandler getInstance() {
  96         return Registry.get(SupervisionHandler.class.getName());
  97     }
  98
  99     /**
 100      * Create a handler.
 101      *
 102      * @param clRuntimeParameterGroup the parameters for the control loop runtime
 103      */
 104     public SupervisionHandler(ClRuntimeParameterGroup clRuntimeParameterGroup) {
 105         super(clRuntimeParameterGroup.getDatabaseProviderParameters());
 106         // @formatter:off
 107         this.manager = new ServiceManager()
 108                         .addAction("ControlLoop Provider",
 109                             () -> controlLoopProvider = new ControlLoopProvider(getDatabaseProviderParameters()),
 110                             () -> controlLoopProvider = null)
 111                         .addAction("Participant Provider",
 112                             () -> participantProvider = new ParticipantProvider(getDatabaseProviderParameters()),
 113                             () -> participantProvider = null);
 114         // @formatter:on
 115     }
 116
 117     /**
 118      * Supervision trigger called when a command is issued on control loops.
 119      *
 120      * </p> Causes supervision to start or continue supervision on the control loops in question.
 121      *
 122      * @param controlLoopIdentifierList the control loops for which the supervision command has been issued
 123      * @throws ControlLoopException on supervision triggering exceptions
 124      */
 125     public void triggerControlLoopSupervision(List<ToscaConceptIdentifier> controlLoopIdentifierList)
 126             throws ControlLoopException {
 127
 128         LOGGER.debug("triggering control loop supervision on control loops {}", controlLoopIdentifierList);
 129
 130         if (CollectionUtils.isEmpty(controlLoopIdentifierList)) {
 131             // This is just to force throwing of the exception in certain circumstances.
 132             exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 133                     "The list of control loops for supervision is empty");
 134         }
 135
 136         for (ToscaConceptIdentifier controlLoopId : controlLoopIdentifierList) {
 137             try {
 138                 var controlLoop = controlLoopProvider.getControlLoop(controlLoopId);
 139
 140                 superviseControlLoop(controlLoop);
 141
 142                 controlLoopProvider.updateControlLoop(controlLoop);
 143             } catch (PfModelException pfme) {
 144                 throw new ControlLoopException(pfme.getErrorResponse().getResponseCode(), pfme.getMessage(), pfme);
 145             }
 146         }
 147     }
 148
 149     @Override
 150     public void startAndRegisterListeners(MessageTypeDispatcher msgDispatcher) {
 151         msgDispatcher.register(ParticipantMessageType.PARTICIPANT_STATUS.name(), new ParticipantStatusListener());
 152     }
 153
 154     @Override
 155     public void startAndRegisterPublishers(List<TopicSink> topicSinks) {
 156         // TODO: Use a parameter for the timeout
 157         // @formatter:off
 158         this.publisherManager = new ServiceManager()
 159                 .addAction("Supervision scanner",
 160                         () -> scanner = new SupervisionScanner(controlLoopProvider, 10000),
 161                         () -> scanner = null)
 162                 .addAction("ControlLoopUpdate publisher",
 163                         () -> controlLoopUpdatePublisher = new ParticipantControlLoopUpdatePublisher(topicSinks, -1),
 164                         () -> controlLoopUpdatePublisher.terminate())
 165                 .addAction("StateChange Publisher",
 166                         () -> stateChangePublisher = new ParticipantStateChangePublisher(topicSinks, 10000),
 167                         () -> stateChangePublisher.terminate())
 168                 .addAction("ControlLoopStateChange Publisher",
 169                         () -> controlLoopStateChangePublisher =
 170                         new ParticipantControlLoopStateChangePublisher(topicSinks, -1),
 171                         () -> controlLoopStateChangePublisher.terminate());
 172         // @formatter:on
 173         try {
 174             publisherManager.start();
 175         } catch (final ServiceManagerException exp) {
 176             throw new ControlLoopRuntimeException(Status.INTERNAL_SERVER_ERROR,
 177                     "Supervision handler start of publishers or scanner failed", exp);
 178         }
 179     }
 180
 181     @Override
 182     public void stopAndUnregisterPublishers() {
 183         try {
 184             publisherManager.stop();
 185         } catch (final ServiceManagerException exp) {
 186             throw new ControlLoopRuntimeException(Status.INTERNAL_SERVER_ERROR,
 187                     "Supervision handler stop of publishers or scanner failed", exp);
 188         }
 189     }
 190
 191     @Override
 192     public void stopAndUnregisterListeners(MessageTypeDispatcher msgDispatcher) {
 193         msgDispatcher.unregister(ParticipantMessageType.PARTICIPANT_STATUS.name());
 194     }
 195
 196     /**
 197      * Handle a ParticipantStatus message from a participant.
 198      *
 199      * @param participantStatusMessage the ParticipantStatus message received from a participant
 200      */
 201     public void handleParticipantStatusMessage(ParticipantStatus participantStatusMessage) {
 202         LOGGER.debug("Participant Status received {}", participantStatusMessage);
 203
 204         try {
 205             superviseParticipant(participantStatusMessage);
 206         } catch (PfModelException | ControlLoopException svExc) {
 207             LOGGER.warn("error supervising participant {}", participantStatusMessage.getParticipantId(), svExc);
 208             return;
 209         }
 210
 211         try {
 212             superviseControlLoops(participantStatusMessage);
 213         } catch (PfModelException | ControlLoopException svExc) {
 214             LOGGER.warn("error supervising participant {}", participantStatusMessage.getParticipantId(), svExc);
 215         }
 216     }
 217
 218     /**
 219      * Supervise a control loop, performing whatever actions need to be performed on the control loop.
 220      *
 221      * @param controlLoop the control loop to supervises
 222      * @throws PfModelException on accessing models in the database
 223      * @throws ControlLoopException on supervision errors
 224      */
 225     private void superviseControlLoop(ControlLoop controlLoop) throws ControlLoopException, PfModelException  {
 226         switch (controlLoop.getOrderedState()) {
 227             case UNINITIALISED:
 228                 superviseControlLoopUninitialization(controlLoop);
 229                 break;
 230
 231             case PASSIVE:
 232                 superviseControlLoopPassivation(controlLoop);
 233                 break;
 234
 235             case RUNNING:
 236                 superviseControlLoopActivation(controlLoop);
 237                 break;
 238
 239             default:
 240                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 241                     "A control loop cannot be commanded to go into state " + controlLoop.getOrderedState().name());
 242         }
 243     }
 244
 245     /**
 246      * Supervise a control loop uninitialisation, performing whatever actions need to be performed on the control loop,
 247      * control loop ordered state is UNINITIALIZED.
 248      *
 249      * @param controlLoop the control loop to supervises
 250      * @throws ControlLoopException on supervision errors
 251      */
 252     private void superviseControlLoopUninitialization(ControlLoop controlLoop) throws ControlLoopException {
 253         switch (controlLoop.getState()) {
 254             case UNINITIALISED:
 255                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 256                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 257                 break;
 258
 259             case UNINITIALISED2PASSIVE:
 260             case PASSIVE:
 261                 controlLoop.setState(ControlLoopState.PASSIVE2UNINITIALISED);
 262                 sendControlLoopStateChange(controlLoop);
 263                 break;
 264
 265             case PASSIVE2UNINITIALISED:
 266                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 267                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 268                 break;
 269
 270             default:
 271                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 272                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 273                 break;
 274         }
 275     }
 276
 277     private void superviseControlLoopPassivation(ControlLoop controlLoop)
 278             throws ControlLoopException, PfModelException {
 279         switch (controlLoop.getState()) {
 280             case PASSIVE:
 281                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 282                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 283                 break;
 284             case UNINITIALISED:
 285                 controlLoop.setState(ControlLoopState.UNINITIALISED2PASSIVE);
 286                 sendControlLoopUpdate(controlLoop);
 287                 break;
 288
 289             case UNINITIALISED2PASSIVE:
 290             case RUNNING2PASSIVE:
 291                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 292                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 293                 break;
 294
 295             case RUNNING:
 296                 controlLoop.setState(ControlLoopState.RUNNING2PASSIVE);
 297                 sendControlLoopStateChange(controlLoop);
 298                 break;
 299
 300             default:
 301                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 302                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 303                 break;
 304         }
 305     }
 306
 307     private void superviseControlLoopActivation(ControlLoop controlLoop) throws ControlLoopException {
 308         switch (controlLoop.getState()) {
 309             case RUNNING:
 310                 exceptionOccured(Response.Status.NOT_ACCEPTABLE,
 311                         CONTROL_LOOP_IS_ALREADY_IN_STATE + controlLoop.getState().name());
 312                 break;
 313
 314             case PASSIVE2RUNNING:
 315                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_IS_ALREADY_IN_STATE
 316                         + controlLoop.getState().name() + AND_TRANSITIONING_TO_STATE + controlLoop.getOrderedState());
 317                 break;
 318
 319             case PASSIVE:
 320                 controlLoop.setState(ControlLoopState.PASSIVE2RUNNING);
 321                 sendControlLoopStateChange(controlLoop);
 322                 break;
 323
 324             default:
 325                 exceptionOccured(Response.Status.NOT_ACCEPTABLE, CONTROL_LOOP_CANNOT_TRANSITION_FROM_STATE
 326                         + controlLoop.getState().name() + TO_STATE + controlLoop.getOrderedState());
 327                 break;
 328         }
 329     }
 330
 331     private void sendControlLoopUpdate(ControlLoop controlLoop) throws PfModelException {
 332         var pclu = new ParticipantControlLoopUpdate();
 333         pclu.setControlLoopId(controlLoop.getKey().asIdentifier());
 334         pclu.setControlLoop(controlLoop);
 335         // TODO: We should look up the correct TOSCA node template here for the control loop
 336         // Tiny hack implemented to return the tosca service template entry from the database and be passed onto dmaap
 337         var commissioningProvider = CommissioningHandler.getInstance().getProvider();
 338         pclu.setControlLoopDefinition(commissioningProvider.getToscaServiceTemplate(null, null));
 339         controlLoopUpdatePublisher.send(pclu);
 340     }
 341
 342     private void sendControlLoopStateChange(ControlLoop controlLoop) {
 343         var clsc = new ParticipantControlLoopStateChange();
 344         clsc.setControlLoopId(controlLoop.getKey().asIdentifier());
 345         clsc.setMessageId(UUID.randomUUID());
 346         clsc.setOrderedState(controlLoop.getOrderedState());
 347
 348         controlLoopStateChangePublisher.send(clsc);
 349     }
 350
 351     private void superviseParticipant(ParticipantStatus participantStatusMessage)
 352             throws PfModelException, ControlLoopException {
 353         if (participantStatusMessage.getParticipantId() == null) {
 354             exceptionOccured(Response.Status.NOT_FOUND,
 355                     "Participant ID on PARTICIPANT_STATUS message is null");
 356         }
 357
 358         List<Participant> participantList =
 359                 participantProvider.getParticipants(participantStatusMessage.getParticipantId().getName(),
 360                         participantStatusMessage.getParticipantId().getVersion());
 361
 362         if (CollectionUtils.isEmpty(participantList)) {
 363             var participant = new Participant();
 364             participant.setName(participantStatusMessage.getParticipantId().getName());
 365             participant.setVersion(participantStatusMessage.getParticipantId().getVersion());
 366             participant.setDefinition(new ToscaConceptIdentifier("unknown", "0.0.0"));
 367             participant.setParticipantState(participantStatusMessage.getState());
 368             participant.setHealthStatus(participantStatusMessage.getHealthStatus());
 369
 370             participantList.add(participant);
 371             participantProvider.createParticipants(participantList);
 372         } else {
 373             for (Participant participant : participantList) {
 374                 participant.setParticipantState(participantStatusMessage.getState());
 375                 participant.setHealthStatus(participantStatusMessage.getHealthStatus());
 376             }
 377             participantProvider.updateParticipants(participantList);
 378         }
 379
 380         monitoringProvider = MonitoringHandler.getInstance().getMonitoringProvider();
 381         monitoringProvider.createParticipantStatistics(
 382                                 List.of(participantStatusMessage.getParticipantStatistics()));
 383     }
 384
 385     private void superviseControlLoops(ParticipantStatus participantStatusMessage)
 386             throws PfModelException, ControlLoopException {
 387         if (CollectionUtils.isEmpty(participantStatusMessage.getControlLoops().getControlLoopList())) {
 388             return;
 389         }
 390
 391         for (ControlLoop controlLoop : participantStatusMessage.getControlLoops().getControlLoopList()) {
 392             if (controlLoop == null) {
 393                 exceptionOccured(Response.Status.NOT_FOUND,
 394                     "PARTICIPANT_STATUS message references unknown control loop: " + controlLoop);
 395             }
 396
 397             var dbControlLoop = controlLoopProvider
 398                     .getControlLoop(new ToscaConceptIdentifier(controlLoop.getName(), controlLoop.getVersion()));
 399             if (dbControlLoop == null) {
 400                 exceptionOccured(Response.Status.NOT_FOUND,
 401                     "PARTICIPANT_STATUS control loop not found in database: " + controlLoop);
 402             }
 403
 404             for (ControlLoopElement element : controlLoop.getElements().values()) {
 405                 ControlLoopElement dbElement = dbControlLoop.getElements().get(element.getId());
 406
 407                 if (dbElement == null) {
 408                     exceptionOccured(Response.Status.NOT_FOUND,
 409                             "PARTICIPANT_STATUS message references unknown control loop element: " + element);
 410                 }
 411
 412                 // Replace element entry in the database
 413                 dbControlLoop.getElements().put(element.getId(), element);
 414             }
 415             controlLoopProvider.updateControlLoop(dbControlLoop);
 416         }
 417
 418         monitoringProvider = MonitoringHandler.getInstance().getMonitoringProvider();
 419         for (ControlLoop controlLoop : participantStatusMessage.getControlLoops().getControlLoopList()) {
 420             monitoringProvider.createClElementStatistics(controlLoop.getControlLoopElementStatisticsList(controlLoop));
 421         }
 422     }
 423
 424     @Override
 425     public void startProviders() {
 426         try {
 427             manager.start();
 428         } catch (final ServiceManagerException exp) {
 429             throw new ControlLoopRuntimeException(Status.INTERNAL_SERVER_ERROR,
 430                     "Supervision handler start of providers failed", exp);
 431         }
 432     }
 433
 434     @Override
 435     public void stopProviders() {
 436         try {
 437             manager.stop();
 438         } catch (final ServiceManagerException exp) {
 439             throw new ControlLoopRuntimeException(Status.INTERNAL_SERVER_ERROR,
 440                     "Supervision handler stop of providers failed", exp);
 441         }
 442     }
 443
 444     private void exceptionOccured(Response.Status status, String reason) throws ControlLoopException {
 445         throw new ControlLoopException(status, reason);
 446     }
 447 }