1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*-
* ============LICENSE_START=======================================================
* ONAP POLICY-CLAMP
* ================================================================================
* Copyright (C) 2021 AT&T Intellectual Property. All rights
* reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END============================================
* ===================================================================
*
*/
package org.onap.policy.clamp.policy.pdpgroup;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.commons.collections4.CollectionUtils;
import org.onap.policy.clamp.clds.util.JsonUtils;
import org.onap.policy.clamp.loop.template.PolicyModel;
import org.onap.policy.models.pdp.concepts.PdpGroup;
import org.onap.policy.models.pdp.concepts.PdpGroups;
import org.onap.policy.models.pdp.concepts.PdpSubGroup;
import org.onap.policy.models.pdp.enums.PdpState;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* This is an utility class to do searching in pdp groups and create json object describing the result.
*/
public class PdpGroupsAnalyzer {
public static final String ASSIGNED_PDP_GROUPS_INFO = "pdpGroupInfo";
public static final String SUPPORTED_PDP_GROUPS_INFO = "supportedPdpGroups";
/**
* This structure holds the map of PdpGroups per policies, policies are identifed by ToscaConceptIdentifier.
*/
private final Map<ToscaConceptIdentifier, Map<String, PdpGroup>> pdpGroupsDeploymentPerPolicy =
new ConcurrentHashMap<>();
/**
* Constructor taking he PDPGroups info from the PEF.
* It then caches the groups per policies and per types.
*
* @param pdpGroups The pdpgroup info from the PEF
*/
public PdpGroupsAnalyzer(PdpGroups pdpGroups) {
this.analyzePdpGroups(pdpGroups);
}
/**
* Getter of the GroupDeploymentPerPolicy structure.
*
* @return The map of policies.
*/
public Map<ToscaConceptIdentifier, Map<String, PdpGroup>> getPdpGroupsDeploymentPerPolicy() {
return pdpGroupsDeploymentPerPolicy;
}
private static void addInfoToPdpGroupsStructure(ToscaConceptIdentifier toscaId,
Map<ToscaConceptIdentifier,
Map<String,
PdpGroup>> pdpGroupsDeploymentPerToscaIdentifier,
PdpGroup pdpGroupSource,
PdpSubGroup pdpSubGroupSource) {
// Copy the subgroup but empty the policies & types
pdpGroupsDeploymentPerToscaIdentifier.computeIfAbsent(toscaId, toscaKey -> new ConcurrentHashMap<>())
.computeIfAbsent(pdpGroupSource.getName(), pdpGroupName -> {
PdpGroup pdpGroupCopy = new PdpGroup(pdpGroupSource);
pdpGroupCopy.setPdpSubgroups(new ArrayList<>());
return pdpGroupCopy;
}).getPdpSubgroups().add(new PdpSubGroup(pdpSubGroupSource));
}
private void analyzePdpGroups(PdpGroups pdpGroups) {
CollectionUtils.emptyIfNull(pdpGroups.getGroups()).stream()
.forEach(group -> CollectionUtils.emptyIfNull(group.getPdpSubgroups()).stream().forEach(subGroup ->
CollectionUtils.emptyIfNull(subGroup.getPolicies()).parallelStream().forEach(policy ->
PdpGroupsAnalyzer.addInfoToPdpGroupsStructure(policy, this.pdpGroupsDeploymentPerPolicy,
group, subGroup))));
}
/**
* This method retrieves all pdpGroups and subgroups where a specific policy name/version is deployed.
*
* @param policyName The policy name that must be used for searching
* @param version THe policy version that must be used for searching
* @return It returns a JsonObject containing each pdpGroup and subgroups associated
*/
public JsonObject getPdpGroupsForPolicy(String policyName, String version) {
Map<String, PdpGroup> mapOfGroups =
this.pdpGroupsDeploymentPerPolicy.get(new ToscaConceptIdentifier(policyName, version));
if (mapOfGroups != null) {
JsonObject policyPdpGroups = new JsonObject();
JsonArray pdpGroupsArray = new JsonArray();
policyPdpGroups.add(ASSIGNED_PDP_GROUPS_INFO, pdpGroupsArray);
pdpGroupsArray.add(JsonUtils.GSON
.toJsonTree(mapOfGroups));
return policyPdpGroups;
}
return null;
}
/**
* Get supported subGroups based on the defined policy type and version for specific PDPGroup.
* It returns null if the Group is TERMINATED or if the policytype/version has not been found in the PDPSubgroups.
*
* @param pdpGroup The pdpGroup that must be analyzed
* @param policyType The policy type
* @param version The version
* @return The supported subGroups list in Json format
* @see org.onap.policy.models.pdp.concepts.PdpGroup
* @see org.onap.policy.models.pdp.enums.PdpState
*/
private static JsonObject getSupportedPdpSubgroupsForModelType(PdpGroup pdpGroup, String policyType,
String version) {
if (PdpState.TERMINATED.equals(pdpGroup.getPdpGroupState())) {
return null;
}
JsonObject supportedPdpGroup = new JsonObject();
JsonArray supportedSubgroups = new JsonArray();
supportedPdpGroup.add(pdpGroup.getName(), supportedSubgroups);
pdpGroup.getPdpSubgroups().stream().forEach(pdpSubGroup -> {
if (pdpSubGroup.getSupportedPolicyTypes().stream().anyMatch(policyTypeIdentifier ->
policyType.matches(policyTypeIdentifier.getName().replace(".", "\\.").replace("*", ".*"))
&& version.equals(policyTypeIdentifier.getVersion()))) {
supportedSubgroups.add(pdpSubGroup.getPdpType());
}
});
return supportedSubgroups.size() == 0 ? null : supportedPdpGroup;
}
/**
* This method retrieves all supported pdpGroups and subgroups for a specific policy type/version.
*
* @param pdpGroups The PdpGroups object containing all PEF pdp groups info
* @param policyType The policy type that must be used for searching
* @param version THe policy type version that must be used for searching
* @return It returns a JsonObject containing each pdpGroup and subgroups associated
*/
public static JsonObject getSupportedPdpGroupsForModelType(PdpGroups pdpGroups, String policyType, String version) {
JsonObject supportedPdpGroups = new JsonObject();
JsonArray pdpGroupsArray = new JsonArray();
supportedPdpGroups.add(SUPPORTED_PDP_GROUPS_INFO, pdpGroupsArray);
pdpGroups.getGroups().stream().map(pdpGroup -> PdpGroupsAnalyzer.getSupportedPdpSubgroupsForModelType(pdpGroup,
policyType, version)).filter(Objects::nonNull)
.forEach(pdpGroupsArray::add);
return pdpGroupsArray.size() != 0 ? supportedPdpGroups : null;
}
/**
* This method updates each element in the policyModelsList given in argument based on the pdpGroups given.
*
* @param policyModelsList The list of Policy Models where each PolicyModel will be updated
* @param pdpGroups The PdpGroups containing all PDP group definition
*/
public static void updatePdpGroupOfPolicyModels(List<PolicyModel> policyModelsList, PdpGroups pdpGroups) {
policyModelsList.parallelStream().forEach(policyModel -> policyModel
.setPolicyPdpGroup(getSupportedPdpGroupsForModelType(pdpGroups, policyModel.getPolicyModelType(),
policyModel.getVersion())));
}
}
|
