aboutsummaryrefslogtreecommitdiffstats
path: root/models/src/main/java/org/onap/policy/clamp/models/acm/messages/dmaap/participant/ParticipantMessageType.java
blob: c42778aaeef5da093ad138aa793caa4cfd6363c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2021-2023 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.clamp.models.acm.messages.dmaap.participant;

/**
 * Class to hold the possible values for the type of participant messages.
 */
public enum ParticipantMessageType {

    /**
     * Used by participants to report status to the automation composition runtime.
     */
    PARTICIPANT_STATUS,

    /**
     * Used by the acm runtime to change the state of participants, triggers a
     * PARTICIPANT_STATUS message with the result of the PARTICIPANT_STATE_CHANGE operation.
     */
    PARTICIPANT_STATE_CHANGE,

    /**
     * Used by acm runtime to deploy the automation compositions running on participants, triggers a
     * PARTICIPANT_STATUS message with the result of the AUTOMATION_COMPOSITION_DEPLOY operation.
     */
    AUTOMATION_COMPOSITION_DEPLOY,

    /**
     * Used by acm runtime to change the state of automation compositions in participants, triggers a
     * PARTICIPANT_STATUS message with result of AUTOMATION_COMPOSITION_STATE_CHANGE operation.
     */
    AUTOMATION_COMPOSITION_STATE_CHANGE,

    /**
     * Used by participant to register itself with automation composition runtime.
     */
    PARTICIPANT_REGISTER,

    /**
     * Used by automation composition runtime to respond to participant registration.
     */
    PARTICIPANT_REGISTER_ACK,

    /**
     * Used by participant to deregister itself with automation composition runtime.
     */
    PARTICIPANT_DEREGISTER,

    /**
     * Used by automation composition runtime to respond to participant deregistration.
     */
    PARTICIPANT_DEREGISTER_ACK,

    /**
     * Used by automation composition runtime to send ToscaServiceTemplate to participant.
     */
    PARTICIPANT_PRIME,

    /**
     * Used by participant to acknowledge the receipt of PARTICIPANT_UPDATE message
     * from automation composition runtime.
     */
    PARTICIPANT_PRIME_ACK,

    /**
     * Used by participant to acknowledge the receipt of AUTOMATION_COMPOSITION_DEPLOY message
     * from automation composition runtime.
     */
    AUTOMATION_COMPOSITION_DEPLOY_ACK,

    /**
     * Used by participant to acknowledge the receipt of AUTOMATION_COMPOSITION_STATE_CHANGE message
     * from automation composition runtime.
     */
    AUTOMATION_COMPOSITION_STATECHANGE_ACK,

    /**
     * Used by automation composition runtime to request for PARTICIPANT_STATUS message immediately.
     */
    PARTICIPANT_STATUS_REQ,

    /**
     * Used by automation composition runtime to send the element properties update to participant.
     */
    PROPERTIES_UPDATE,

    /**
     * Used by runtime to send composition and instances to a restarted participant.
     */
    PARTICIPANT_RESTART
}