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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 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.models.pdp.concepts;
  22
  23 import java.util.List;
  24 import java.util.stream.Collectors;
  25
  26 import lombok.Builder;
  27 import lombok.Data;
  28 import lombok.NonNull;
  29
  30 import org.apache.commons.lang3.ObjectUtils;
  31 import org.onap.policy.models.base.PfObjectFilter;
  32 import org.onap.policy.models.pdp.enums.PdpState;
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  34 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  35
  36 /**
  37  * Filter class for searches for {@link PdpGroup} instances. If any fields are null, they are ignored.
  38  *
  39  * @author Liam Fallon (liam.fallon@est.tech)
  40  */
  41 @Builder
  42 @Data
  43 public class PdpGroupFilter implements PfObjectFilter<PdpGroup> {
  44     public static final String LATEST_VERSION = "LATEST";
  45
  46     // Regular expression
  47     private String name;
  48
  49     // Regular Expression, set to LATEST_VERRSION to get the latest version
  50     private String version;
  51
  52     private PdpState groupState;
  53
  54     // Regular expression
  55     private String pdpType;
  56
  57     // Set regular expressions on fields to match policy type names and versions
  58     private ToscaPolicyTypeIdentifier policyType;
  59
  60     // Set regular expressions on fields to match policy names and versions
  61     private ToscaPolicyIdentifier policy;
  62
  63     private PdpState pdpState;
  64
  65     @Override
  66     public List<PdpGroup> filter(@NonNull final List<PdpGroup> originalList) {
  67
  68         // @formatter:off
  69         List<PdpGroup> returnList = originalList.stream()
  70                 .filter(p -> filterOnRegexp(p.getName(),    name))
  71                 .filter(p -> filterOnRegexp(p.getVersion(), version))
  72                 .filter(p -> ObjectUtils.compare(p.getPdpGroupState(), groupState) == 0)
  73                 .filter(p -> filterOnPdpType(p, pdpType))
  74                 .filter(p -> filterOnPolicyType(p, policyType))
  75                 .filter(p -> filterOnPolicy(p, policy))
  76                 .collect(Collectors.toList());
  77         // @formatter:off
  78
  79         if (LATEST_VERSION.equals(version)) {
  80             returnList = this.latestVersionFilter(returnList);
  81         }
  82
  83         return returnList;
  84     }
  85
  86     /**
  87      * Filter PDP groups on PDP type.
  88      *
  89      * @param pdpGroup the PDP group to check
  90      * @param pdpType the PDP type to check for
  91      * @return true if the filter should let this PDP group through
  92      */
  93     private boolean filterOnPdpType(final PdpGroup pdpGroup, final String pdpType) {
  94         if (pdpType == null) {
  95             return true;
  96         }
  97
  98         for (PdpSubGroup pdpSubGroup: pdpGroup.getPdpSubgroups()) {
  99             if (pdpSubGroup.getPdpType().equals(pdpType)) {
 100                 return true;
 101             }
 102         }
 103
 104         return false;
 105     }
 106
 107     /**
 108      * Filter PDP groups on policy type.
 109      *
 110      * @param pdpGroup the PDP group to check
 111      * @param policyTypeFilter the policy type regular expressions to check for
 112      * @return true if the filter should let this PDP group through
 113      */
 114     private boolean filterOnPolicyType(final PdpGroup pdpGroup, final ToscaPolicyTypeIdentifier policyTypeFiler) {
 115         if (policyTypeFiler == null) {
 116             return true;
 117         }
 118
 119         for (PdpSubGroup pdpSubGroup: pdpGroup.getPdpSubgroups()) {
 120             for (ToscaPolicyTypeIdentifier foundPolicyType : pdpSubGroup.getSupportedPolicyTypes()) {
 121                 if (foundPolicyType.getName().matches(policyTypeFiler.getName())
 122                         && foundPolicyType.getVersion().matches(policyTypeFiler.getVersion())) {
 123                     return true;
 124                 }
 125             }
 126         }
 127
 128         return false;
 129     }
 130
 131     /**
 132      * Filter PDP groups on policy.
 133      *
 134      * @param pdpGroup the PDP group to check
 135      * @param policyFilter the policy regular expressions to check for
 136      * @return true if the filter should let this PDP group through
 137      */
 138     private boolean filterOnPolicy(final PdpGroup pdpGroup, final ToscaPolicyIdentifier policyFiler) {
 139         if (policyFiler == null) {
 140             return true;
 141         }
 142
 143         for (PdpSubGroup pdpSubGroup: pdpGroup.getPdpSubgroups()) {
 144             for (ToscaPolicyIdentifier foundPolicy : pdpSubGroup.getPolicies()) {
 145                 if (foundPolicy.getName().matches(policyFiler.getName())
 146                         && foundPolicy.getVersion().matches(policyFiler.getVersion())) {
 147                     return true;
 148                 }
 149             }
 150         }
 151
 152         return false;
 153     }
 154 }