865264f6dff3a994227146f7ca51f159445eccbf
[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 lombok.Getter;
27 import lombok.Setter;
28 import lombok.ToString;
29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
30 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
31 import org.onap.policy.models.base.PfUtils;
32 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
33
34 /**
35  * Class to represent the CONTROL_LOOP_UPDATE message that the control loop runtime sends to a participant.
36  * When a participant receives this message, it creates the control loop elements contained in the message and sets them
37  * to state PASSIVE. subsequent CONTROL_LOOP_STATE_CHANGE messages are used to activate the control loops.
38  */
39 @Getter
40 @Setter
41 @ToString(callSuper = true)
42 public class ControlLoopUpdate extends ParticipantMessage {
43
44     // The control loop
45     private ControlLoop controlLoop;
46
47     // A map with Participant ID as its key, and a map of ControlLoopElements as value.
48     private Map<ToscaConceptIdentifier, Map<UUID, ControlLoopElement>>
49             participantUpdateMap = new LinkedHashMap<>();
50
51     /**
52      * Constructor for instantiating ControlLoopUpdate class with message name.
53      *
54      */
55     public ControlLoopUpdate() {
56         super(ParticipantMessageType.CONTROL_LOOP_UPDATE);
57     }
58
59     /**
60      * Constructs the object, making a deep copy.
61      *
62      * @param source source from which to copy
63      */
64     public ControlLoopUpdate(ControlLoopUpdate source) {
65         super(source);
66
67         this.controlLoop = source.controlLoop;
68         this.participantUpdateMap = PfUtils.mapMap(source.participantUpdateMap,
69                 clElementMap -> PfUtils.mapMap(clElementMap, ControlLoopElement::new));
70     }
71 }