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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2022-2023 Nordix Foundation
* Modifications Copyright (C) 2023 TechMahindra Ltd.
* ================================================================================
* 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.cps.ncmp.api.impl;
import static org.onap.cps.ncmp.api.impl.utils.RestQueryParametersValidator.validateCpsPathConditionProperties;
import static org.onap.cps.ncmp.api.impl.utils.RestQueryParametersValidator.validateModuleNameConditionProperties;
import static org.onap.cps.ncmp.api.impl.utils.YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle;
import static org.onap.cps.spi.FetchDescendantsOption.DIRECT_CHILDREN_ONLY;
import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.cpspath.parser.PathParsingException;
import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService;
import org.onap.cps.ncmp.api.impl.utils.CmHandleQueryConditions;
import org.onap.cps.ncmp.api.impl.utils.InventoryQueryConditions;
import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
import org.onap.cps.ncmp.api.inventory.CmHandleQueries;
import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
import org.onap.cps.ncmp.api.inventory.enums.PropertyType;
import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
import org.onap.cps.spi.exceptions.DataValidationException;
import org.onap.cps.spi.model.ConditionProperties;
import org.onap.cps.spi.model.DataNode;
import org.springframework.stereotype.Service;
@Service
@Slf4j
@RequiredArgsConstructor
public class NetworkCmProxyCmHandlerQueryServiceImpl implements NetworkCmProxyCmHandlerQueryService {
private static final Map<String, NcmpServiceCmHandle> NO_QUERY_TO_EXECUTE = null;
private final CmHandleQueries cmHandleQueries;
private final InventoryPersistence inventoryPersistence;
/**
* Query and return cm handles that match the given query parameters.
*
* @param cmHandleQueryServiceParameters the cm handle query parameters
* @return collection of cm handles
*/
@Override
public Set<NcmpServiceCmHandle> queryCmHandles(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) {
return getAllCmHandles();
}
final Map<String, NcmpServiceCmHandle> combinedQueryResult = executeInventoryQueries(
cmHandleQueryServiceParameters);
return new HashSet<>(combineWithModuleNameQuery(cmHandleQueryServiceParameters, combinedQueryResult).values());
}
/**
* Query and return cm handles that match the given query parameters.
*
* @param cmHandleQueryServiceParameters the cm handle query parameters
* @return collection of cm handle ids
*/
@Override
public Set<String> queryCmHandleIds(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) {
return getAllCmHandleIds();
}
final Map<String, NcmpServiceCmHandle> combinedQueryResult = executeInventoryQueries(
cmHandleQueryServiceParameters);
final Collection<String> moduleNamesForQuery =
getModuleNamesForQuery(cmHandleQueryServiceParameters.getCmHandleQueryParameters());
if (moduleNamesForQuery.isEmpty()) {
return combinedQueryResult.keySet();
}
final Set<String> moduleNameQueryResult =
new HashSet<>(inventoryPersistence.getCmHandleIdsWithGivenModules(moduleNamesForQuery));
if (combinedQueryResult == NO_QUERY_TO_EXECUTE) {
return moduleNameQueryResult;
}
moduleNameQueryResult.retainAll(combinedQueryResult.keySet());
return moduleNameQueryResult;
}
@Override
public Set<String> queryCmHandleIdsForInventory(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
if (cmHandleQueryServiceParameters.getCmHandleQueryParameters().isEmpty()) {
return getAllCmHandleIds();
}
final Map<String, NcmpServiceCmHandle> publicPropertiesQueryResult = queryCmHandlesByPublicProperties(
cmHandleQueryServiceParameters);
if (publicPropertiesQueryResult != null && publicPropertiesQueryResult.isEmpty()) {
return Collections.emptySet();
}
final Map<String, NcmpServiceCmHandle> privatePropertiesQueryResult = queryCmHandlesByPrivateProperties(
cmHandleQueryServiceParameters);
if (privatePropertiesQueryResult != null && privatePropertiesQueryResult.isEmpty()) {
return Collections.emptySet();
}
final Map<String, NcmpServiceCmHandle> dmiPropertiesQueryResult = queryCmHandlesByDmiPlugin(
cmHandleQueryServiceParameters);
if (dmiPropertiesQueryResult != null && dmiPropertiesQueryResult.isEmpty()) {
return Collections.emptySet();
}
final Map<String, NcmpServiceCmHandle> combinedResult =
combineQueryResults(publicPropertiesQueryResult, privatePropertiesQueryResult, dmiPropertiesQueryResult);
return combinedResult.keySet();
}
private Map<String, NcmpServiceCmHandle> queryCmHandlesByDmiPlugin(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
final Map<String, String> dmiPropertyQueryPairs =
getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
InventoryQueryConditions.CM_HANDLE_WITH_DMI_PLUGIN.getName());
if (dmiPropertyQueryPairs.isEmpty()) {
return NO_QUERY_TO_EXECUTE;
}
final String dmiPluginIdentifierValue = dmiPropertyQueryPairs.get(
PropertyType.DMI_PLUGIN.getYangContainerName());
final Set<NcmpServiceCmHandle> cmHandlesByDmiPluginIdentifier = cmHandleQueries
.getCmHandlesByDmiPluginIdentifier(dmiPluginIdentifierValue);
return cmHandlesByDmiPluginIdentifier.stream()
.collect(Collectors.toMap(NcmpServiceCmHandle::getCmHandleId, cmH -> cmH));
}
private Map<String, NcmpServiceCmHandle> queryCmHandlesByPrivateProperties(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
final Map<String, String> privatePropertyQueryPairs =
getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
InventoryQueryConditions.HAS_ALL_ADDITIONAL_PROPERTIES.getName());
return privatePropertyQueryPairs.isEmpty()
? NO_QUERY_TO_EXECUTE
: cmHandleQueries.queryCmHandleAdditionalProperties(privatePropertyQueryPairs);
}
private Map<String, NcmpServiceCmHandle> queryCmHandlesByPublicProperties(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
final Map<String, String> publicPropertyQueryPairs =
getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
CmHandleQueryConditions.HAS_ALL_PROPERTIES.getConditionName());
return publicPropertyQueryPairs.isEmpty()
? NO_QUERY_TO_EXECUTE
: cmHandleQueries.queryCmHandlePublicProperties(publicPropertyQueryPairs);
}
private Map<String, NcmpServiceCmHandle> combineQueryResults(
final Map<String, NcmpServiceCmHandle> publicPropertiesQueryResult,
final Map<String, NcmpServiceCmHandle> privatePropertiesQueryResult,
final Map<String, NcmpServiceCmHandle> dmiPropertiesQueryResult) {
final Map<String, NcmpServiceCmHandle> propertiesCombinedResult = cmHandleQueries
.combineCmHandleQueries(publicPropertiesQueryResult, privatePropertiesQueryResult);
return cmHandleQueries
.combineCmHandleQueries(propertiesCombinedResult, dmiPropertiesQueryResult);
}
private Map<String, NcmpServiceCmHandle> combineWithModuleNameQuery(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
final Map<String, NcmpServiceCmHandle> previousQueryResult) {
final Collection<String> moduleNamesForQuery =
getModuleNamesForQuery(cmHandleQueryServiceParameters.getCmHandleQueryParameters());
if (moduleNamesForQuery.isEmpty()) {
return previousQueryResult;
}
final Collection<String> cmHandleIdsByModuleName =
inventoryPersistence.getCmHandleIdsWithGivenModules(moduleNamesForQuery);
if (cmHandleIdsByModuleName.isEmpty()) {
return Collections.emptyMap();
}
final Map<String, NcmpServiceCmHandle> queryResult = new HashMap<>(cmHandleIdsByModuleName.size());
if (previousQueryResult == NO_QUERY_TO_EXECUTE) {
cmHandleIdsByModuleName.forEach(cmHandleId ->
queryResult.put(cmHandleId, createNcmpServiceCmHandle(inventoryPersistence
.getDataNode("/dmi-registry/cm-handles[@id='" + cmHandleId + "']").iterator().next()))
);
return queryResult;
}
previousQueryResult.keySet().retainAll(cmHandleIdsByModuleName);
queryResult.putAll(previousQueryResult);
return queryResult;
}
private Map<String, NcmpServiceCmHandle> executeInventoryQueries(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
final Map<String, String> cpsPath = getCpsPath(cmHandleQueryServiceParameters.getCmHandleQueryParameters());
if (!validateCpsPathConditionProperties(cpsPath)) {
return Collections.emptyMap();
}
final Map<String, NcmpServiceCmHandle> cpsPathQueryResult;
if (cpsPath.isEmpty()) {
cpsPathQueryResult = NO_QUERY_TO_EXECUTE;
} else {
try {
cpsPathQueryResult = cmHandleQueries.queryCmHandleDataNodesByCpsPath(
cpsPath.get("cpsPath"), INCLUDE_ALL_DESCENDANTS)
.stream().map(this::createNcmpServiceCmHandle)
.collect(Collectors.toMap(NcmpServiceCmHandle::getCmHandleId,
Function.identity()));
} catch (final PathParsingException pathParsingException) {
throw new DataValidationException(pathParsingException.getMessage(), pathParsingException.getDetails(),
pathParsingException);
}
if (cpsPathQueryResult.isEmpty()) {
return Collections.emptyMap();
}
}
final Map<String, String> publicPropertyQueryPairs =
getPropertyPairs(cmHandleQueryServiceParameters.getCmHandleQueryParameters(),
CmHandleQueryConditions.HAS_ALL_PROPERTIES.getConditionName());
final Map<String, NcmpServiceCmHandle> propertiesQueryResult = publicPropertyQueryPairs.isEmpty()
? NO_QUERY_TO_EXECUTE : cmHandleQueries.queryCmHandlePublicProperties(publicPropertyQueryPairs);
return cmHandleQueries.combineCmHandleQueries(cpsPathQueryResult, propertiesQueryResult);
}
private Collection<String> getModuleNamesForQuery(final List<ConditionProperties> conditionProperties) {
final List<String> result = new ArrayList<>();
getConditions(conditionProperties, CmHandleQueryConditions.HAS_ALL_MODULES.getConditionName())
.parallelStream().forEach(
conditionProperty -> {
validateModuleNameConditionProperties(conditionProperty);
result.add(conditionProperty.get("moduleName"));
}
);
return result;
}
private Map<String, String> getCpsPath(final List<ConditionProperties> conditionProperties) {
final Map<String, String> result = new HashMap<>();
getConditions(conditionProperties, CmHandleQueryConditions.WITH_CPS_PATH.getConditionName()).forEach(
result::putAll);
return result;
}
private Map<String, String> getPropertyPairs(final List<ConditionProperties> conditionProperties,
final String queryProperty) {
final Map<String, String> result = new HashMap<>();
getConditions(conditionProperties, queryProperty).forEach(result::putAll);
return result;
}
private List<Map<String, String>> getConditions(final List<ConditionProperties> conditionProperties,
final String name) {
for (final ConditionProperties conditionProperty : conditionProperties) {
if (conditionProperty.getConditionName().equals(name)) {
return conditionProperty.getConditionParameters();
}
}
return Collections.emptyList();
}
private Set<NcmpServiceCmHandle> getAllCmHandles() {
final DataNode dataNode = inventoryPersistence.getDataNode("/dmi-registry").iterator().next();
return dataNode.getChildDataNodes().stream().map(this::createNcmpServiceCmHandle).collect(Collectors.toSet());
}
private Set<String> getAllCmHandleIds() {
final DataNode dataNodes = inventoryPersistence.getDataNode("/dmi-registry", DIRECT_CHILDREN_ONLY)
.iterator().next();
return dataNodes.getChildDataNodes().stream().map(dataNode -> dataNode.getLeaves().get("id").toString())
.collect(Collectors.toSet());
}
private NcmpServiceCmHandle createNcmpServiceCmHandle(final DataNode dataNode) {
return convertYangModelCmHandleToNcmpServiceCmHandle(YangDataConverter
.convertCmHandleToYangModel(dataNode, dataNode.getLeaves().get("id").toString()));
}
}
|