aboutsummaryrefslogtreecommitdiffstats
path: root/models/src/main/java/org/onap/policy/clamp/models/acm/messages/dmaap/participant/ParticipantAckMessage.java
blob: 56e5064703817d041f7a12d64c75df9dabea3e4e (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
/*-
 * ============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;

import java.util.UUID;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
import org.onap.policy.clamp.models.acm.concepts.ParticipantState;
import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;

/**
 * Class to represent participant Ack message.
 */
@Getter
@Setter
@ToString
public class ParticipantAckMessage {

    // The responseTo field should match the original request id in the request.
    private UUID responseTo;

    // Intermediary result: Success/Fail.
    private Boolean result;

    // Indicating participant failure
    private StateChangeResult stateChangeResult;

    // Message indicating reason for failure
    private String message;

    private ParticipantMessageType messageType;

    private UUID compositionId;

    /**
     * Participant ID, or {@code null} for messages from participants.
     */
    private UUID participantId;

    /**
     * Participant State, or {@code null} for messages from participants.
     */
    private ParticipantState state;

    /**
     * Constructor for instantiating a participant ack message class.
     *
     * @param messageType the message type
     */
    public ParticipantAckMessage(final ParticipantMessageType messageType) {
        this.messageType = messageType;
    }

    /**
     * Constructs the object, making a deep copy.
     *
     * @param source source from which to copy
     */
    public ParticipantAckMessage(ParticipantAckMessage source) {
        this.responseTo = source.responseTo;
        this.result = source.result;
        this.stateChangeResult = source.stateChangeResult;
        this.message = source.message;
        this.messageType = source.messageType;
        this.participantId = source.participantId;
        this.state = source.state;
    }

    /**
     * Determines if this message applies to this participant type.
     *
     * @param participantId id of the participant to match against
     * @return {@code true} if this message applies to this participant, {@code false} otherwise
     */
    public boolean appliesTo(@NonNull final UUID participantId) {
        // Broadcast message to all participants
        if (this.participantId == null) {
            return true;
        }

        // Targeted message at this specific participant
        return participantId.equals(this.participantId);
    }
}