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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*-
* ============LICENSE_START=======================================================
* ONAP Policy API
* ================================================================================
* Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2019-2021 Nordix Foundation.
* Modifications Copyright (C) 2022 Bell Canada. 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.api.main.rest.provider;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.BiConsumer;
import javax.ws.rs.core.Response;
import org.apache.commons.lang3.tuple.Pair;
import org.onap.policy.models.base.PfConceptKey;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.pdp.concepts.PdpGroup;
import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
import org.onap.policy.models.pdp.concepts.PdpSubGroup;
import org.onap.policy.models.pdp.enums.PdpState;
import org.onap.policy.models.provider.PolicyModelsProvider;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* Super class for providers that use a model provider.
*/
public class CommonModelProvider {
protected final PolicyModelsProvider modelsProvider;
/**
* Constructs the object, populating {@link #modelsProvider}.
*
*/
public CommonModelProvider(PolicyModelsProvider modelsProvider) {
this.modelsProvider = modelsProvider;
}
/**
* Collects all deployed versions of specified policy in all pdp groups.
*
* @param policyId the ID of policy
* @param policyType the concept key of policy type
* @param getter the custom generic getter Bifunction
* @param consumer the BiConsumer
* @param data the data structure storing retrieved deployed policies
*
* @return a map between pdp group and deployed versions of specified policy in that group
*
* @throws PfModelException the PfModel parsing exception
*/
protected <T, R> Map<Pair<String, String>, T> collectDeployedPolicies(String policyId, PfConceptKey policyType,
BiFunctionWithEx<String, String, R> getter, BiConsumer<T, R> consumer, T data) throws PfModelException {
List<PdpGroup> pdpGroups = getPolicyTypeFilteredPdpGroups(policyType);
hasActivePdpGroup(pdpGroups, policyType, policyId);
return constructDeployedPolicyMap(pdpGroups, policyId, policyType, getter, consumer, data);
}
@FunctionalInterface
protected interface BiFunctionWithEx<T, U, R> {
public R apply(T value1, U value2) throws PfModelException;
}
/**
* Checks if the list of pdp groups is empty. If so, throws exception saying specified policy deployment is not
* found in all existing pdp groups.
*
* @param pdpGroups the list of pdp groups to check against
* @param policyType the concept key of policy type
* @param policyId the ID of policy
*
* @throws PfModelException the PfModel parsing exception
*/
private void hasActivePdpGroup(List<PdpGroup> pdpGroups, PfConceptKey policyType, String policyId)
throws PfModelException {
if (pdpGroups.isEmpty()) {
throw new PfModelException(Response.Status.NOT_FOUND,
constructDeploymentNotFoundMessage(policyType, policyId));
}
}
/**
* Retrieves all pdp groups supporting specified policy type.
*
* @param policyType the policy type
*
* @return a list of pdp groups supporting specified policy type
*
* @throws PfModelException the PfModel parsing exception
*/
private List<PdpGroup> getPolicyTypeFilteredPdpGroups(PfConceptKey policyType) throws PfModelException {
List<ToscaConceptIdentifier> policyTypes = new ArrayList<>();
policyTypes.add(new ToscaConceptIdentifier(policyType.getName(), policyType.getVersion()));
var pdpGroupFilter = PdpGroupFilter.builder().policyTypeList(policyTypes).groupState(PdpState.ACTIVE)
.pdpState(PdpState.ACTIVE).build();
return modelsProvider.getFilteredPdpGroups(pdpGroupFilter);
}
/**
* Constructs the map of deployed pdp groups and deployed policies.
*
* @param pdpGroups the list of pdp groups that contain the specified policy
* @param policyId the ID of policy
* @param policyType the concept key of policy type
* @param getter the custom generic getter BiFunction
* @param consumer the BiConsumer
* @param data the data structure storing retrieved deployed policies
*
* @return the constructed map of pdp groups and deployed policies
*
* @throws PfModelException the PfModel parsing exception
*/
private <T, R> Map<Pair<String, String>, T> constructDeployedPolicyMap(List<PdpGroup> pdpGroups, String policyId,
PfConceptKey policyType, BiFunctionWithEx<String, String, R> getter, BiConsumer<T, R> consumer, T data)
throws PfModelException {
Map<Pair<String, String>, T> deployedPolicyMap = new HashMap<>();
for (PdpGroup pdpGroup : pdpGroups) {
List<ToscaConceptIdentifier> policyIdentifiers = extractPolicyIdentifiers(policyId, pdpGroup, policyType);
var deployedPolicies = getDeployedPolicies(policyIdentifiers, policyType, getter, consumer, data);
deployedPolicyMap.put(Pair.of(pdpGroup.getName(), pdpGroup.getVersion()), deployedPolicies);
}
return deployedPolicyMap;
}
/**
* Extracts policy identifiers matching specified policy ID from specified pdp group.
*
* @param policyId the ID of policy to match
* @param pdpGroup the target pdp group to search
* @param policyType the concept key of policy type
*
* @return the list of policy identifiers
*
* @throws PfModelException the PfModel parsing exception
*/
private List<ToscaConceptIdentifier> extractPolicyIdentifiers(String policyId, PdpGroup pdpGroup,
PfConceptKey policyType) throws PfModelException {
List<ToscaConceptIdentifier> policyIdentifiers = new ArrayList<>();
for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
for (ToscaConceptIdentifier policyIdentifier : pdpSubGroup.getPolicies()) {
if (policyId.equalsIgnoreCase(policyIdentifier.getName())) {
policyIdentifiers.add(policyIdentifier);
}
}
}
if (policyIdentifiers.isEmpty()) {
throw new PfModelException(Response.Status.NOT_FOUND,
constructDeploymentNotFoundMessage(policyType, policyId));
}
return policyIdentifiers;
}
/**
* Retrieves deployed policies in a generic way.
*
* @param policyIdentifiers the identifiers of the policies to return
* @param policyType the concept key of current policy type
* @param getter the method reference of getting deployed policies
* @param consumer the method reference of consuming the returned policies
* @param data the data structure of deployed policies to return
*
* @return the generic type of policy data structure to return
*
* @throws PfModelException the PfModel parsing exception
*/
private <T, R> T getDeployedPolicies(List<ToscaConceptIdentifier> policyIdentifiers, PfConceptKey policyType,
BiFunctionWithEx<String, String, R> getter, BiConsumer<T, R> consumer, T data) throws PfModelException {
for (ToscaConceptIdentifier policyIdentifier : policyIdentifiers) {
var result = getter.apply(policyIdentifier.getName(),
getTrimedVersionForLegacyType(policyIdentifier.getVersion(), policyType));
consumer.accept(data, result);
}
return data;
}
/**
* Trims the version for legacy policies.
*
* @param fullVersion the full version format with major, minor, patch
* @param policyType the concept key of policy type
*
* @return the trimmed version
*/
private String getTrimedVersionForLegacyType(String fullVersion, PfConceptKey policyType) {
return (policyType.getName().contains("guard") || policyType.getName().contains("Operational"))
? fullVersion.split("\\.")[0]
: fullVersion;
}
/**
* Constructs returned message for not found policy deployment.
*
* @param policyType the concept key of policy type
* @param policyId the ID of policy
*
* @return constructed message
*/
private String constructDeploymentNotFoundMessage(PfConceptKey policyType, String policyId) {
return "could not find policy with ID " + policyId + " and type " + policyType.getName() + ":"
+ policyType.getVersion() + " deployed in any pdp group";
}
}
|
