6a72ec1f2c42f8c043efcbc78c05d9a81bfa1957
[policy/clamp.git] /
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 import java.util.LinkedHashMap;
24 import java.util.Map;
25 import java.util.UUID;
26 import java.util.function.UnaryOperator;
27 import lombok.Getter;
28 import lombok.Setter;
29 import lombok.ToString;
30 import org.apache.commons.lang3.tuple.Pair;
31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElementDefinition;
32 import org.onap.policy.models.base.PfUtils;
33 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
34
35 /**
36  * Class to represent the CONTROLLOOP_ACK message that a participant sends
37  * to control loop runtime as an acknowledgement to either ControlLoopUpdate
38  * or ControlLoopStateChange message.
39  */
40 @Getter
41 @Setter
42 @ToString(callSuper = true)
43 public class ControlLoopAck extends ParticipantAckMessage {
44
45     /**
46      * Participant ID, or {@code null} for messages from participants.
47      */
48     private ToscaConceptIdentifier participantId;
49
50     /**
51      * Participant Type, or {@code null} for messages from participants.
52      */
53     private ToscaConceptIdentifier participantType;
54
55     /**
56      * Control loop ID, or {@code null} for messages to participants.
57      */
58     private ToscaConceptIdentifier controlLoopId;
59
60     // A map with ControlLoopElementID as its key, and a pair of result and message as value per
61     // ControlLoopElement.
62     private Map<UUID, Map<UUID, Boolean>> controlLoopResultMap = new LinkedHashMap<>();
63
64     /**
65      * Constructor for instantiating ParticipantRegisterAck class with message name.
66      *
67      */
68     public ControlLoopAck(final ParticipantMessageType messageType) {
69         super(messageType);
70     }
71
72     /**
73      * Constructs the object, making a deep copy.
74      *
75      * @param source source from which to copy
76      */
77     public ControlLoopAck(final ControlLoopAck source) {
78         super(source);
79         this.participantId = source.participantId;
80         this.participantType = source.participantType;
81         this.controlLoopId = source.controlLoopId;
82         this.controlLoopResultMap = PfUtils.mapMap(source.controlLoopResultMap,
83                 clElementResultMap -> PfUtils.mapMap(clElementResultMap, UnaryOperator.identity()));
84     }
85 }