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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2023 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.models.acm.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 automation composition runtime.
  30      */
  31     PARTICIPANT_STATUS,
  32
  33     /**
  34      * Used by the acm 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 acm runtime to deploy the automation compositions running on participants, triggers a
  41      * PARTICIPANT_STATUS message with the result of the AUTOMATION_COMPOSITION_DEPLOY operation.
  42      */
  43     AUTOMATION_COMPOSITION_DEPLOY,
  44
  45     /**
  46      * Used by acm runtime to change the state of automation compositions in participants, triggers a
  47      * PARTICIPANT_STATUS message with result of AUTOMATION_COMPOSITION_STATE_CHANGE operation.
  48      */
  49     AUTOMATION_COMPOSITION_STATE_CHANGE,
  50
  51     /**
  52      * Used by participant to register itself with automation composition runtime.
  53      */
  54     PARTICIPANT_REGISTER,
  55
  56     /**
  57      * Used by automation composition runtime to respond to participant registration.
  58      */
  59     PARTICIPANT_REGISTER_ACK,
  60
  61     /**
  62      * Used by participant to deregister itself with automation composition runtime.
  63      */
  64     PARTICIPANT_DEREGISTER,
  65
  66     /**
  67      * Used by automation composition runtime to respond to participant deregistration.
  68      */
  69     PARTICIPANT_DEREGISTER_ACK,
  70
  71     /**
  72      * Used by automation composition runtime to send ToscaServiceTemplate to participant.
  73      */
  74     PARTICIPANT_PRIME,
  75
  76     /**
  77      * Used by participant to acknowledge the receipt of PARTICIPANT_UPDATE message
  78      * from automation composition runtime.
  79      */
  80     PARTICIPANT_PRIME_ACK,
  81
  82     /**
  83      * Used by participant to acknowledge the receipt of AUTOMATION_COMPOSITION_DEPLOY message
  84      * from automation composition runtime.
  85      */
  86     AUTOMATION_COMPOSITION_DEPLOY_ACK,
  87
  88     /**
  89      * Used by participant to acknowledge the receipt of AUTOMATION_COMPOSITION_STATE_CHANGE message
  90      * from automation composition runtime.
  91      */
  92     AUTOMATION_COMPOSITION_STATECHANGE_ACK,
  93
  94     /**
  95      * Used by automation composition runtime to request for PARTICIPANT_STATUS message immediately.
  96      */
  97     PARTICIPANT_STATUS_REQ,
  98
  99     /**
 100      * Used by automation composition runtime to send the element properties update to participant.
 101      */
 102     PROPERTIES_UPDATE,
 103
 104     /**
 105      * Used by runtime to send composition and instances to a restarted participant.
 106      */
 107     PARTICIPANT_RESTART,
 108
 109     /**
 110      * Used by acm runtime to migrate from a composition to another one in participants, triggers a
 111      * AUTOMATION_COMPOSITION_MIGRATION message with result of AUTOMATION_COMPOSITION_STATE_CHANGE operation.
 112      */
 113     AUTOMATION_COMPOSITION_MIGRATION
 114 }