42b9712e204938c91f8a5ee38cce2295a49e2d79
[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.ArrayList;
24 import java.util.List;
25 import lombok.Getter;
26 import lombok.Setter;
27 import lombok.ToString;
28 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantUpdates;
29 import org.onap.policy.models.base.PfUtils;
30
31 /**
32  * Class to represent the CONTROL_LOOP_UPDATE message that the control loop runtime sends to a participant.
33  * When a participant receives this message, it creates the control loop elements contained in the message and sets them
34  * to state PASSIVE. subsequent CONTROL_LOOP_STATE_CHANGE messages are used to activate the control loops.
35  */
36 @Getter
37 @Setter
38 @ToString(callSuper = true)
39 public class ControlLoopUpdate extends ParticipantMessage {
40
41     // A list of ParticipantUpdates instances which carries details of an updated participant.
42     private List<ParticipantUpdates> participantUpdatesList = new ArrayList<>();
43
44     /**
45      * Constructor for instantiating ControlLoopUpdate class with message name.
46      *
47      */
48     public ControlLoopUpdate() {
49         super(ParticipantMessageType.CONTROL_LOOP_UPDATE);
50     }
51
52     /**
53      * Constructs the object, making a deep copy.
54      *
55      * @param source source from which to copy
56      */
57     public ControlLoopUpdate(ControlLoopUpdate source) {
58         super(source);
59
60         this.participantUpdatesList = PfUtils.mapList(source.participantUpdatesList,
61             ParticipantUpdates::new);
62     }
63 }