2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
4 * Modifications Copyright (C) 2021-2022 Nordix Foundation
5 * Modifications Copyright (C) 2021 Pantheon.tech
6 * Modifications Copyright (C) 2021-2022 Bell Canada
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.ncmp.api.impl;
26 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
27 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
28 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
29 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
30 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
31 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
32 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
34 import com.google.common.base.Strings;
35 import java.util.ArrayList;
36 import java.util.Collection;
37 import java.util.HashMap;
38 import java.util.LinkedHashMap;
39 import java.util.List;
42 import java.util.stream.Collectors;
43 import lombok.RequiredArgsConstructor;
44 import lombok.extern.slf4j.Slf4j;
45 import org.onap.cps.api.CpsAdminService;
46 import org.onap.cps.api.CpsDataService;
47 import org.onap.cps.api.CpsModuleService;
48 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
49 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
50 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
51 import org.onap.cps.ncmp.api.impl.operations.YangModelCmHandleRetriever;
52 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
53 import org.onap.cps.ncmp.api.inventory.sync.ModuleSyncService;
54 import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
55 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
56 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError;
57 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
58 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
59 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
60 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
61 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
62 import org.onap.cps.spi.exceptions.DataValidationException;
63 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
64 import org.onap.cps.spi.model.ModuleReference;
65 import org.onap.cps.utils.CpsValidator;
66 import org.onap.cps.utils.JsonObjectMapper;
67 import org.springframework.http.ResponseEntity;
68 import org.springframework.stereotype.Service;
72 @RequiredArgsConstructor
73 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
75 private final CpsDataService cpsDataService;
77 private final JsonObjectMapper jsonObjectMapper;
79 private final DmiDataOperations dmiDataOperations;
81 private final CpsModuleService cpsModuleService;
83 private final CpsAdminService cpsAdminService;
85 private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
87 private final YangModelCmHandleRetriever yangModelCmHandleRetriever;
89 private final ModuleSyncService moduleSyncService;
92 public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
93 final DmiPluginRegistration dmiPluginRegistration) {
94 dmiPluginRegistration.validateDmiPluginRegistration();
95 final var dmiPluginRegistrationResponse = new DmiPluginRegistrationResponse();
96 dmiPluginRegistrationResponse.setRemovedCmHandles(
97 parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration.getRemovedCmHandles()));
98 if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
99 dmiPluginRegistrationResponse.setCreatedCmHandles(
100 parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration));
102 if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
103 dmiPluginRegistrationResponse.setUpdatedCmHandles(
104 networkCmProxyDataServicePropertyHandler
105 .updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()));
107 return dmiPluginRegistrationResponse;
111 public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
112 final String resourceIdentifier,
113 final String optionsParamInQuery,
114 final String topicParamInQuery,
115 final String requestId) {
116 final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
119 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL,
120 requestId, topicParamInQuery);
121 return responseEntity.getBody();
125 public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
126 final String resourceIdentifier,
127 final String optionsParamInQuery,
128 final String topicParamInQuery,
129 final String requestId) {
130 final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
133 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING,
134 requestId, topicParamInQuery);
135 return responseEntity.getBody();
139 public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
140 final String resourceIdentifier,
141 final OperationEnum operation,
142 final String requestData,
143 final String dataType) {
144 CpsValidator.validateNameCharacters(cmHandleId);
145 return dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(cmHandleId, resourceIdentifier, operation,
146 requestData, dataType);
151 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
152 CpsValidator.validateNameCharacters(cmHandleId);
153 return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
157 * Retrieve cm handle identifiers for the given list of module names.
159 * @param moduleNames module names.
160 * @return a collection of anchor identifiers
163 public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
164 return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
168 public Set<String> queryCmHandles(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
170 cmHandleQueryApiParameters.getPublicProperties().forEach((key, value) -> {
171 if (Strings.isNullOrEmpty(key)) {
172 throw new DataValidationException("Invalid Query Parameter.",
173 "Missing property name - please supply a valid name.");
177 return cpsAdminService.queryCmHandles(jsonObjectMapper.convertToValueType(cmHandleQueryApiParameters,
178 org.onap.cps.spi.model.CmHandleQueryParameters.class));
182 * Retrieve cm handle details for a given cm handle.
184 * @param cmHandleId cm handle identifier
185 * @return cm handle details
188 public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
189 CpsValidator.validateNameCharacters(cmHandleId);
190 final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
191 final YangModelCmHandle yangModelCmHandle =
192 yangModelCmHandleRetriever.getYangModelCmHandle(cmHandleId);
193 final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
194 final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
195 ncmpServiceCmHandle.setCmHandleId(yangModelCmHandle.getId());
196 setDmiProperties(dmiProperties, ncmpServiceCmHandle);
197 setPublicProperties(publicProperties, ncmpServiceCmHandle);
198 return ncmpServiceCmHandle;
202 * Get cm handle public properties for a given cm handle id.
204 * @param cmHandleId cm handle identifier
205 * @return cm handle public properties
208 public Map<String, String> getCmHandlePublicProperties(final String cmHandleId) {
209 CpsValidator.validateNameCharacters(cmHandleId);
210 final YangModelCmHandle yangModelCmHandle =
211 yangModelCmHandleRetriever.getYangModelCmHandle(cmHandleId);
212 final List<YangModelCmHandle.Property> yangModelPublicProperties = yangModelCmHandle.getPublicProperties();
213 final Map<String, String> cmHandlePublicProperties = new HashMap<>();
214 asPropertiesMap(yangModelPublicProperties, cmHandlePublicProperties);
215 return cmHandlePublicProperties;
219 * THis method registers a cm handle and initiates modules sync.
221 * @param dmiPluginRegistration dmi plugin registration information.
222 * @return cm-handle registration response for create cm-handle requests.
224 public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
225 final DmiPluginRegistration dmiPluginRegistration) {
226 List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>();
228 cmHandleRegistrationResponses = dmiPluginRegistration.getCreatedCmHandles().stream()
230 YangModelCmHandle.toYangModelCmHandle(
231 dmiPluginRegistration.getDmiPlugin(),
232 dmiPluginRegistration.getDmiDataPlugin(),
233 dmiPluginRegistration.getDmiModelPlugin(), cmHandle)
235 .map(this::registerAndSyncNewCmHandle)
236 .collect(Collectors.toList());
237 } catch (final DataValidationException dataValidationException) {
238 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createFailureResponse(dmiPluginRegistration
239 .getCreatedCmHandles().stream()
240 .map(NcmpServiceCmHandle::getCmHandleId).findFirst().orElse(null),
241 RegistrationError.CM_HANDLE_INVALID_ID));
243 return cmHandleRegistrationResponses;
246 protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
247 final String schemaSetName = moduleSyncService.syncAndCreateSchemaSet(yangModelCmHandle);
248 final String anchorName = yangModelCmHandle.getId();
249 cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
253 protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
254 final List<String> tobeRemovedCmHandles) {
255 final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
256 new ArrayList<>(tobeRemovedCmHandles.size());
257 for (final String cmHandle : tobeRemovedCmHandles) {
259 CpsValidator.validateNameCharacters(cmHandle);
260 deleteSchemaSetWithCascade(cmHandle);
261 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
262 "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
263 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
264 } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
265 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
266 cmHandle, dataNodeNotFoundException.getMessage());
267 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
268 .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
269 } catch (final DataValidationException dataValidationException) {
270 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
271 cmHandle, dataValidationException.getMessage());
272 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
273 .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_INVALID_ID));
274 } catch (final Exception exception) {
275 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
276 cmHandle, exception.getMessage());
277 cmHandleRegistrationResponses.add(
278 CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
281 return cmHandleRegistrationResponses;
284 private void deleteSchemaSetWithCascade(final String schemaSetName) {
286 cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
287 CASCADE_DELETE_ALLOWED);
288 } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
289 log.warn("Schema set {} does not exist or already deleted", schemaSetName);
293 private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
294 final NcmpServiceCmHandle ncmpServiceCmHandle) {
295 final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
296 asPropertiesMap(dmiProperties, dmiPropertiesMap);
297 ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
300 private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
301 final NcmpServiceCmHandle ncmpServiceCmHandle) {
302 final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
303 asPropertiesMap(publicProperties, publicPropertiesMap);
304 ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
307 private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
308 final Map<String, String> propertiesMap) {
309 for (final YangModelCmHandle.Property property: properties) {
310 propertiesMap.put(property.getName(), property.getValue());
314 private CmHandleRegistrationResponse registerAndSyncNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
316 final String cmHandleJsonData = String.format("{\"cm-handles\":[%s]}",
317 jsonObjectMapper.asJsonString(yangModelCmHandle));
318 cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
319 cmHandleJsonData, NO_TIMESTAMP);
320 syncModulesAndCreateAnchor(yangModelCmHandle);
321 return CmHandleRegistrationResponse.createSuccessResponse(yangModelCmHandle.getId());
322 } catch (final AlreadyDefinedException alreadyDefinedException) {
323 return CmHandleRegistrationResponse.createFailureResponse(
324 yangModelCmHandle.getId(), RegistrationError.CM_HANDLE_ALREADY_EXIST);
325 } catch (final Exception exception) {
326 return CmHandleRegistrationResponse.createFailureResponse(yangModelCmHandle.getId(), exception);