models-pdp/src/main/java/org/onap/policy/models/pdp/concepts/PdpSubGroup.java

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