e3e33b454d29b05adefec6cf7b87c02a422cc86b
[policy/models.git] / models-pdp / src / main / java / org / onap / policy / models / pdp / concepts / PdpSubGroup.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2019-2020 Nordix Foundation.
4  *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
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.ArrayList;
25 import java.util.LinkedHashMap;
26 import java.util.List;
27 import java.util.Map;
28 import lombok.Data;
29 import lombok.NonNull;
30 import org.onap.policy.common.parameters.BeanValidationResult;
31 import org.onap.policy.common.parameters.ObjectValidationResult;
32 import org.onap.policy.common.parameters.ValidationResult;
33 import org.onap.policy.common.parameters.ValidationStatus;
34 import org.onap.policy.models.base.PfUtils;
35 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
36 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
37
38 /**
39  * Class to represent a group of all PDP's of the same pdp type running for a particular
40  * domain.
41  *
42  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
43  */
44 @Data
45 public class PdpSubGroup {
46     private String pdpType;
47     private List<ToscaPolicyTypeIdentifier> supportedPolicyTypes;
48     private List<ToscaPolicyIdentifier> policies;
49     private int currentInstanceCount;
50     private int desiredInstanceCount;
51     private Map<String, String> properties;
52     private List<Pdp> pdpInstances;
53
54     /**
55      * Constructs the object.
56      */
57     public PdpSubGroup() {
58         super();
59     }
60
61     /**
62      * Constructs the object, making a deep copy from the source.
63      *
64      * @param source source from which to copy fields
65      */
66     public PdpSubGroup(@NonNull final PdpSubGroup source) {
67         this.pdpType = source.pdpType;
68         this.supportedPolicyTypes = PfUtils.mapList(source.supportedPolicyTypes, ToscaPolicyTypeIdentifier::new,
69                         new ArrayList<>(0));
70         this.policies = PfUtils.mapList(source.policies, ToscaPolicyIdentifier::new, new ArrayList<>(0));
71         this.currentInstanceCount = source.currentInstanceCount;
72         this.desiredInstanceCount = source.desiredInstanceCount;
73         this.properties = (source.properties == null ? null : new LinkedHashMap<>(source.properties));
74         this.pdpInstances = PfUtils.mapList(source.pdpInstances, Pdp::new, new ArrayList<>(0));
75     }
76
77     /**
78      * Validates that appropriate fields are populated for an incoming call to the PAP
79      * REST API.
80      *
81      * @param updateGroupFlow if the operation is pdp group update
82      * @return the validation result
83      */
84     public ValidationResult validatePapRest(boolean updateGroupFlow) {
85         BeanValidationResult result = new BeanValidationResult("group", this);
86
87         result.validateNotNull("pdpType", pdpType);
88         // When doing PdpGroup Update operation, supported policy types and policies doesn't have to be validated.
89         if (!updateGroupFlow) {
90             result.validateNotNullList("policies", policies, ToscaPolicyIdentifier::validatePapRest);
91             result.validateNotNullList("supportedPolicyTypes", supportedPolicyTypes,
92                 ToscaPolicyTypeIdentifier::validatePapRest);
93
94             if (supportedPolicyTypes != null && supportedPolicyTypes.isEmpty()) {
95                 result.addResult(new ObjectValidationResult("supportedPolicyTypes", supportedPolicyTypes,
96                     ValidationStatus.INVALID, "empty list"));
97             }
98         }
99
100         if (desiredInstanceCount <= 0) {
101             result.addResult(new ObjectValidationResult("desiredInstanceCount", desiredInstanceCount,
102                             ValidationStatus.INVALID, "non-positive"));
103         }
104
105         return result;
106     }
107 }