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.models.messages.dmaap.participant;
  22
  23 /**
  24  * Class to hold the possible values for the type of participant messages.
  25  */
  26 public enum ParticipantMessageType {
  27
  28     /**
  29      * Used by participants to report status to the control loop runtime.
  30      */
  31     PARTICIPANT_STATUS,
  32
  33     /**
  34      * Used by the controlloop runtime to change the state of participants, triggers a
  35      * PARTICIPANT_STATUS message with the result of the PARTICIPANT_STATE_CHANGE operation.
  36      */
  37     PARTICIPANT_STATE_CHANGE,
  38
  39     /**
  40      * Used by controlloop runtime to update the controlloops running on participants, triggers a
  41      * PARTICIPANT_STATUS message with the result of the CONTROL_LOOP_UPDATE operation.
  42      */
  43     CONTROL_LOOP_UPDATE,
  44
  45     /**
  46      * Used by controlloop runtime to change the state of controlloops in participants, triggers a
  47      * PARTICIPANT_STATUS message with result of CONTROL_LOOP_STATE_CHANGE operation.
  48      */
  49     CONTROL_LOOP_STATE_CHANGE,
  50
  51     /**
  52      * Used by the control loop runtime to order a health check on participants, triggers a
  53      * PARTICIPANT_STATUS message with the result of the PARTICIPANT_HEALTH_CHECK operation.
  54      */
  55     PARTICIPANT_HEALTH_CHECK,
  56
  57     /**
  58      * Used by participant to register itself with control loop runtime.
  59      */
  60     PARTICIPANT_REGISTER,
  61
  62     /**
  63      * Used by control loop runtime to respond to participant registration.
  64      */
  65     PARTICIPANT_REGISTER_ACK,
  66
  67     /**
  68      * Used by participant to deregister itself with control loop runtime.
  69      */
  70     PARTICIPANT_DEREGISTER,
  71
  72     /**
  73      * Used by control loop runtime to respond to participant deregistration.
  74      */
  75     PARTICIPANT_DEREGISTER_ACK,
  76
  77     /**
  78      * Used by control loop runtime to send ToscaServiceTemplate to participant.
  79      */
  80     PARTICIPANT_UPDATE,
  81
  82     /**
  83      * Used by participant to acknowledge the receipt of Participant_Update message
  84      * from control loop runtime.
  85      */
  86     PARTICIPANT_UPDATE_ACK,
  87
  88     /**
  89      * Used by participant to acknowledge the receipt of ControlLoop_Update message
  90      * from control loop runtime.
  91      */
  92     CONTROLLOOP_UPDATE_ACK,
  93
  94     /**
  95      * Used by participant to acknowledge the receipt of ControlLoop_StateChange message
  96      * from control loop runtime.
  97      */
  98     CONTROLLOOP_STATECHANGE_ACK,
  99
 100     /**
 101      * Used by control loop runtime to request for ParticipantStatus message immediately.
 102      */
 103     PARTICIPANT_STATUS_REQ
 104 }