Add "source" to PAP-PDP messages
[policy/models.git] / models-pdp / src / main / java / org / onap / policy / models / pdp / concepts / PdpUpdate.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2019 Nordix Foundation.
4  *  Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
5  *  Modifications Copyright (C) 2021 Nordix Foundation.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  * SPDX-License-Identifier: Apache-2.0
20  * ============LICENSE_END=========================================================
21  */
22
23 package org.onap.policy.models.pdp.concepts;
24
25 import java.util.LinkedList;
26 import java.util.List;
27 import java.util.stream.Collectors;
28 import lombok.Getter;
29 import lombok.Setter;
30 import lombok.ToString;
31 import org.onap.policy.models.pdp.enums.PdpMessageType;
32 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
33 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
34
35 /**
36  * Class to represent the PDP_UPDATE message that PAP will send to a PDP. When a PDP
37  * receives this message, it should save the group and subgroup and pass them to
38  * {@link #appliesTo(String, String, String)} of subsequent messages that it receives.
39  *
40  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
41  */
42 @Getter
43 @Setter
44 @ToString(callSuper = true)
45 public class PdpUpdate extends PdpMessage {
46
47     /**
48      * System from which the message originated.
49      */
50     private String source;
51
52     /**
53      * Description of the PDP group.
54      */
55     private String description;
56
57     private Long pdpHeartbeatIntervalMs;
58
59     /**
60      * Policies that the PDP should deploy.
61      */
62     private List<ToscaPolicy> policiesToBeDeployed = new LinkedList<>();
63
64     /**
65      * Policies that the PDP should undeploy.
66      */
67     private List<ToscaConceptIdentifier> policiesToBeUndeployed = new LinkedList<>();
68
69     /**
70      * Constructor for instantiating PdpUpdate class with message name.
71      *
72      */
73     public PdpUpdate() {
74         super(PdpMessageType.PDP_UPDATE);
75     }
76
77     /**
78      * Constructs the object, making a deep copy.
79      *
80      * @param source source from which to copy
81      */
82     public PdpUpdate(PdpUpdate source) {
83         super(source);
84
85         this.source = source.source;
86         this.description = source.description;
87         this.pdpHeartbeatIntervalMs = source.pdpHeartbeatIntervalMs;
88         this.policiesToBeDeployed = (source.policiesToBeDeployed == null ? null
89                 : source.policiesToBeDeployed.stream().map(ToscaPolicy::new).collect(Collectors.toList()));
90         this.policiesToBeUndeployed = (source.policiesToBeUndeployed == null ? null
91                 : source.policiesToBeUndeployed.stream().map(ToscaConceptIdentifier::new).collect(Collectors.toList()));
92     }
93 }