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
109
110
111
112
113
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021 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.controlloop.models.messages.dmaap.participant;
import java.time.Instant;
import java.util.UUID;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* Class to represent the base class for various messages that will be exchanged between the control loop runtime and
* participants.
*/
@Getter
@Setter
@ToString
public class ParticipantMessage {
@Setter(AccessLevel.NONE)
private ParticipantMessageType messageType;
private UUID messageId = UUID.randomUUID();
/**
* Time-stamp, in milliseconds, when the message was created. Defaults to the current time.
*/
private Instant timestamp = Instant.now();
/**
* Participant Type, or {@code null} for messages from participants.
*/
private ToscaConceptIdentifier participantType;
/**
* Participant ID, or {@code null} for messages from participants.
*/
private ToscaConceptIdentifier participantId;
/**
* Control loop ID, or {@code null} for messages to participants.
*/
private ToscaConceptIdentifier controlLoopId;
/**
* Constructor for instantiating a participant message class.
*
* @param messageType the message type
*/
public ParticipantMessage(final ParticipantMessageType messageType) {
this.messageType = messageType;
}
/**
* Constructs the object, making a deep copy. Does <i>not</i> copy the request id or the time stamp.
*
* @param source source from which to copy
*/
public ParticipantMessage(final ParticipantMessage source) {
this.messageType = source.messageType;
this.participantType = source.participantType;
this.participantId = source.participantId;
this.controlLoopId = source.controlLoopId;
}
/**
* Determines if this message applies to this participant type.
*
* @param participantType type of the participant to match against
* @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 ToscaConceptIdentifier participantType,
@NonNull final ToscaConceptIdentifier participantId) {
// Broadcast message to all participants
if (this.participantType == null) {
return true;
}
// Broadcast message to all control loop elements on this participant
if (participantType.equals(this.participantType) && this.participantId == null) {
return true;
}
// Targeted message at this specific participant
if (participantType.equals(this.participantType) && participantId.equals(this.participantId)) {
return true;
}
// Message is not for this participant
return false;
}
}
|
