2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2020 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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.pdp.concepts;
24 import java.util.List;
25 import java.util.stream.Collectors;
27 import lombok.Builder;
29 import lombok.NonNull;
31 import org.apache.commons.lang3.ObjectUtils;
32 import org.onap.policy.models.base.PfObjectFilter;
33 import org.onap.policy.models.pdp.enums.PdpState;
34 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
35 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
38 * Filter class for searches for {@link PdpGroup} instances. If any fields are null, they are ignored.
40 * @author Liam Fallon (liam.fallon@est.tech)
44 public class PdpGroupFilter implements PfObjectFilter<PdpGroup> {
49 private PdpState groupState;
52 private String pdpType;
54 // Set regular expressions on fields to match policy type names and versions
55 private List<ToscaPolicyTypeIdentifier> policyTypeList;
57 // If set, only PDP groups where policy types are matched exactly are returned
59 private boolean matchPolicyTypesExactly = false;
61 // Set regular expressions on fields to match policy names and versions
62 private List<ToscaPolicyIdentifier> policyList;
64 // If set, only PDP groups where policies are matched exactly are returned
66 private boolean matchPoliciesExactly = false;
68 // If set, only PDP groups with PDPs in this state are returned
69 private PdpState pdpState;
72 public List<PdpGroup> filter(@NonNull final List<PdpGroup> originalList) {
75 return originalList.stream()
76 .filter(p -> filterString(p.getName(), name))
77 .filter(p -> groupState == null || ObjectUtils.compare(p.getPdpGroupState(), groupState) == 0)
78 .filter(p -> filterOnPdpType(p, pdpType))
79 .filter(p -> filterOnPolicyTypeList(p, policyTypeList, matchPolicyTypesExactly))
80 .filter(p -> filterOnPolicyList(p, policyList, matchPoliciesExactly))
81 .filter(p -> filterOnPdpState(p, pdpState))
82 .collect(Collectors.toList());
87 * Filter PDP groups on PDP type.
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
93 private boolean filterOnPdpType(final PdpGroup pdpGroup, final String pdpType) {
94 if (pdpType == null) {
98 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
99 if (pdpSubGroup.getPdpType().equals(pdpType)) {
108 * Filter PDP groups on policy type.
110 * @param pdpGroup the PDP group to check
111 * @param typeFilter the policy type regular expressions to check for
112 * @param matchPolicyTypesExactly if true, only PDP groups where policy types are matched exactly are returned
113 * @return true if the filter should let this PDP group through
115 private boolean filterOnPolicyTypeList(final PdpGroup pdpGroup, final List<ToscaPolicyTypeIdentifier> typeFilter,
116 final boolean matchPolicyTypesExactly) {
117 if (typeFilter == null) {
121 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
122 if (matchPolicyTypesExactly) {
123 if (areListsIdentical(pdpSubGroup.getSupportedPolicyTypes(), typeFilter)) {
126 } else if (findSupportedPolicyType(pdpSubGroup.getSupportedPolicyTypes(), typeFilter)) {
136 * Find a single supported type.
138 * @param supportedPolicyTypes supported types
139 * @param typeFilter the list of types, one of which we wish to find supported by
140 * the list we are searching
141 * @return true if one element of the elements to find is supported by an element on
142 * the list we searched
144 private boolean findSupportedPolicyType(List<ToscaPolicyTypeIdentifier> supportedPolicyTypes,
145 List<ToscaPolicyTypeIdentifier> typeFilter) {
146 for (ToscaPolicyTypeIdentifier supportedPolicyType : supportedPolicyTypes) {
147 String supName = supportedPolicyType.getName();
148 if (supName.endsWith(".*")) {
149 String substr = supName.substring(0, supName.length() - 1);
150 if (typeFilter.stream().anyMatch(type -> type.getName().startsWith(substr))) {
153 } else if (typeFilter.contains(supportedPolicyType)) {
162 * Filter PDP groups on policy.
164 * @param pdpGroup the PDP group to check
165 * @param policyFilter the policy regular expressions to check for
166 * @param matchPoliciesExactly if true, only PDP groups where ps are matched exactly are returned
167 * @return true if the filter should let this PDP group through
169 private boolean filterOnPolicyList(final PdpGroup pdpGroup, final List<ToscaPolicyIdentifier> policyFilter,
170 final boolean matchPoliciesExactly) {
171 if (policyFilter == null) {
175 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
176 if (matchPoliciesExactly) {
177 if (areListsIdentical(pdpSubGroup.getPolicies(), policyFilter)) {
180 } else if (findSingleElement(pdpSubGroup.getPolicies(), policyFilter)) {
189 * Filter PDP groups on PDP state.
191 * @param pdpGroup the PDP group to check
192 * @param policyFilter the policy regular expressions to check for
193 * @return true if the filter should let this PDP group through
195 private boolean filterOnPdpState(final PdpGroup pdpGroup, final PdpState pdpState) {
196 if (pdpState == null) {
200 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
201 for (Pdp pdp : pdpSubGroup.getPdpInstances()) {
202 if (pdpState.equals(pdp.getPdpState())) {
212 * Check if two lists have identical content.
214 * @param leftList the left list
215 * @param rightList the right list
216 * @return true if the lists are identical
218 private <T> boolean areListsIdentical(final List<T> leftList, List<T> rightList) {
219 return leftList.equals(rightList);
223 * Find a single element of a list in a list.
225 * @param listToSearch the list in which we are searching for elements
226 * @param listOfElementsToFind the list of elements, one of which we wish to find on the list we are searching
227 * @return true if one element of the elements to find is found on the list we searched
229 private <T> boolean findSingleElement(final List<T> listToSearch, List<T> listOfElementsToFind) {
230 for (Object elementToFind : listOfElementsToFind) {
231 if (listToSearch.contains(elementToFind)) {