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