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