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.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
27 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
28 import static org.onap.cps.utils.CmHandleQueryRestParametersValidator.validateCmHandleQueryParameters;
30 import java.time.OffsetDateTime;
31 import java.util.ArrayList;
32 import java.util.Collection;
33 import java.util.HashMap;
34 import java.util.HashSet;
35 import java.util.List;
38 import java.util.stream.Collectors;
39 import lombok.RequiredArgsConstructor;
40 import lombok.extern.slf4j.Slf4j;
41 import org.onap.cps.api.CpsDataService;
42 import org.onap.cps.ncmp.api.NetworkCmProxyCmHandlerQueryService;
43 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
44 import org.onap.cps.ncmp.api.impl.event.lcm.LcmEventsCmHandleStateHandler;
45 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
46 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
47 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
48 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
49 import org.onap.cps.ncmp.api.inventory.CmHandleQueries;
50 import org.onap.cps.ncmp.api.inventory.CmHandleState;
51 import org.onap.cps.ncmp.api.inventory.CompositeState;
52 import org.onap.cps.ncmp.api.inventory.CompositeStateUtils;
53 import org.onap.cps.ncmp.api.inventory.DataStoreSyncState;
54 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
55 import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
56 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
57 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError;
58 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
59 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
60 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
61 import org.onap.cps.spi.FetchDescendantsOption;
62 import org.onap.cps.spi.exceptions.AlreadyDefinedExceptionBatch;
63 import org.onap.cps.spi.exceptions.CpsException;
64 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
65 import org.onap.cps.spi.exceptions.DataValidationException;
66 import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
67 import org.onap.cps.spi.model.ModuleDefinition;
68 import org.onap.cps.spi.model.ModuleReference;
69 import org.onap.cps.utils.CpsValidator;
70 import org.onap.cps.utils.JsonObjectMapper;
71 import org.springframework.http.ResponseEntity;
72 import org.springframework.stereotype.Service;
76 @RequiredArgsConstructor
77 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
79 private final JsonObjectMapper jsonObjectMapper;
81 private final DmiDataOperations dmiDataOperations;
83 private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
85 private final InventoryPersistence inventoryPersistence;
87 private final CmHandleQueries cmHandleQueries;
89 private final NetworkCmProxyCmHandlerQueryService networkCmProxyCmHandlerQueryService;
91 private final LcmEventsCmHandleStateHandler lcmEventsCmHandleStateHandler;
93 private final CpsDataService cpsDataService;
96 public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
97 final DmiPluginRegistration dmiPluginRegistration) {
98 dmiPluginRegistration.validateDmiPluginRegistration();
99 final DmiPluginRegistrationResponse dmiPluginRegistrationResponse = new DmiPluginRegistrationResponse();
100 dmiPluginRegistrationResponse.setRemovedCmHandles(
101 parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration.getRemovedCmHandles()));
102 if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
103 dmiPluginRegistrationResponse.setCreatedCmHandles(
104 parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration));
106 if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
107 dmiPluginRegistrationResponse.setUpdatedCmHandles(
108 networkCmProxyDataServicePropertyHandler
109 .updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()));
111 return dmiPluginRegistrationResponse;
115 public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
116 final String resourceIdentifier,
117 final String optionsParamInQuery,
118 final String topicParamInQuery,
119 final String requestId) {
120 final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
123 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL,
124 requestId, topicParamInQuery);
125 return responseEntity.getBody();
129 public Object getResourceDataOperational(final String cmHandleId,
130 final String resourceIdentifier,
131 final FetchDescendantsOption fetchDescendantsOption) {
132 return cpsDataService.getDataNode(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId, resourceIdentifier,
133 fetchDescendantsOption);
137 public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
138 final String resourceIdentifier,
139 final String optionsParamInQuery,
140 final String topicParamInQuery,
141 final String requestId) {
142 final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(cmHandleId,
145 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING,
146 requestId, topicParamInQuery);
147 return responseEntity.getBody();
151 public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
152 final String resourceIdentifier,
153 final OperationEnum operation,
154 final String requestData,
155 final String dataType) {
156 CpsValidator.validateNameCharacters(cmHandleId);
157 return dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(cmHandleId, resourceIdentifier, operation,
158 requestData, dataType);
162 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
163 CpsValidator.validateNameCharacters(cmHandleId);
164 return inventoryPersistence.getYangResourcesModuleReferences(cmHandleId);
168 public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
169 CpsValidator.validateNameCharacters(cmHandleId);
170 return inventoryPersistence.getModuleDefinitionsByCmHandleId(cmHandleId);
174 * Retrieve cm handles with details for the given query parameters.
176 * @param cmHandleQueryApiParameters cm handle query parameters
177 * @return cm handles with details
180 public Set<NcmpServiceCmHandle> executeCmHandleSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
181 final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
182 cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
184 validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
186 return networkCmProxyCmHandlerQueryService.queryCmHandles(cmHandleQueryServiceParameters);
190 * Retrieve cm handle ids for the given query parameters.
192 * @param cmHandleQueryApiParameters cm handle query parameters
193 * @return cm handle ids
196 public Set<String> executeCmHandleIdSearch(final CmHandleQueryApiParameters cmHandleQueryApiParameters) {
197 final CmHandleQueryServiceParameters cmHandleQueryServiceParameters = jsonObjectMapper.convertToValueType(
198 cmHandleQueryApiParameters, CmHandleQueryServiceParameters.class);
200 validateCmHandleQueryParameters(cmHandleQueryServiceParameters);
202 return networkCmProxyCmHandlerQueryService.queryCmHandleIds(cmHandleQueryServiceParameters);
206 * Set the data sync enabled flag, along with the data sync state
207 * based on the data sync enabled boolean for the cm handle id provided.
209 * @param cmHandleId cm handle id
210 * @param dataSyncEnabled data sync enabled flag
213 public void setDataSyncEnabled(final String cmHandleId, final boolean dataSyncEnabled) {
214 CpsValidator.validateNameCharacters(cmHandleId);
215 final CompositeState compositeState = inventoryPersistence
216 .getCmHandleState(cmHandleId);
217 if (compositeState.getDataSyncEnabled().equals(dataSyncEnabled)) {
218 log.info("Data-Sync Enabled flag is already: {} ", dataSyncEnabled);
219 } else if (compositeState.getCmHandleState() != CmHandleState.READY) {
220 throw new CpsException("State mismatch exception.", "Cm-Handle not in READY state. Cm handle state is: "
221 + compositeState.getCmHandleState());
223 final DataStoreSyncState dataStoreSyncState = compositeState.getDataStores()
224 .getOperationalDataStore().getDataStoreSyncState();
225 if (!dataSyncEnabled && dataStoreSyncState == DataStoreSyncState.SYNCHRONIZED) {
226 cpsDataService.deleteDataNode(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId,
227 "/netconf-state", OffsetDateTime.now());
229 CompositeStateUtils.setDataSyncEnabledFlagWithDataSyncState(dataSyncEnabled, compositeState);
230 inventoryPersistence.saveCmHandleState(cmHandleId,
236 * Get all cm handle IDs by DMI plugin identifier.
238 * @param dmiPluginIdentifier DMI plugin identifier
239 * @return set of cm handle IDs
242 public Set<String> getAllCmHandleIdsByDmiPluginIdentifier(final String dmiPluginIdentifier) {
243 final Set<NcmpServiceCmHandle> ncmpServiceCmHandles =
244 cmHandleQueries.getCmHandlesByDmiPluginIdentifier(dmiPluginIdentifier);
245 final Set<String> cmHandleIds = new HashSet<>(ncmpServiceCmHandles.size());
246 ncmpServiceCmHandles.forEach(cmHandle -> cmHandleIds.add(cmHandle.getCmHandleId()));
251 * Retrieve cm handle details for a given cm handle.
253 * @param cmHandleId cm handle identifier
254 * @return cm handle details
257 public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
258 CpsValidator.validateNameCharacters(cmHandleId);
259 return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(
260 inventoryPersistence.getYangModelCmHandle(cmHandleId));
264 * Get cm handle public properties for a given cm handle id.
266 * @param cmHandleId cm handle identifier
267 * @return cm handle public properties
270 public Map<String, String> getCmHandlePublicProperties(final String cmHandleId) {
271 CpsValidator.validateNameCharacters(cmHandleId);
272 final YangModelCmHandle yangModelCmHandle =
273 inventoryPersistence.getYangModelCmHandle(cmHandleId);
274 final List<YangModelCmHandle.Property> yangModelPublicProperties = yangModelCmHandle.getPublicProperties();
275 final Map<String, String> cmHandlePublicProperties = new HashMap<>();
276 YangDataConverter.asPropertiesMap(yangModelPublicProperties, cmHandlePublicProperties);
277 return cmHandlePublicProperties;
281 * Get cm handle composite state for a given cm handle id.
283 * @param cmHandleId cm handle identifier
284 * @return cm handle state
287 public CompositeState getCmHandleCompositeState(final String cmHandleId) {
288 CpsValidator.validateNameCharacters(cmHandleId);
289 return inventoryPersistence.getYangModelCmHandle(cmHandleId).getCompositeState();
293 * THis method registers a cm handle and initiates modules sync.
295 * @param dmiPluginRegistration dmi plugin registration information.
296 * @return cm-handle registration response for create cm-handle requests.
298 public List<CmHandleRegistrationResponse> parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
299 final DmiPluginRegistration dmiPluginRegistration) {
300 List<CmHandleRegistrationResponse> cmHandleRegistrationResponses = new ArrayList<>();
301 final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle = new HashMap<>();
303 dmiPluginRegistration.getCreatedCmHandles()
304 .forEach(cmHandle -> {
305 final YangModelCmHandle yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle(
306 dmiPluginRegistration.getDmiPlugin(),
307 dmiPluginRegistration.getDmiDataPlugin(),
308 dmiPluginRegistration.getDmiModelPlugin(),
310 cmHandleStatePerCmHandle.put(yangModelCmHandle, CmHandleState.ADVISED);
312 cmHandleRegistrationResponses = registerNewCmHandles(cmHandleStatePerCmHandle);
313 } catch (final DataValidationException dataValidationException) {
314 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createFailureResponse(dmiPluginRegistration
315 .getCreatedCmHandles().stream()
316 .map(NcmpServiceCmHandle::getCmHandleId).findFirst().orElse(null),
317 RegistrationError.CM_HANDLE_INVALID_ID));
319 return cmHandleRegistrationResponses;
322 protected List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
323 final List<String> tobeRemovedCmHandles) {
324 final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
325 new ArrayList<>(tobeRemovedCmHandles.size());
326 for (final String cmHandleId : tobeRemovedCmHandles) {
328 CpsValidator.validateNameCharacters(cmHandleId);
329 final YangModelCmHandle yangModelCmHandle = inventoryPersistence.getYangModelCmHandle(cmHandleId);
330 lcmEventsCmHandleStateHandler.updateCmHandleState(yangModelCmHandle,
331 CmHandleState.DELETING);
332 deleteCmHandleByCmHandleId(cmHandleId);
333 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandleId));
334 lcmEventsCmHandleStateHandler.updateCmHandleState(yangModelCmHandle,
335 CmHandleState.DELETED);
336 } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
337 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
338 cmHandleId, dataNodeNotFoundException.getMessage());
339 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
340 .createFailureResponse(cmHandleId, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
341 } catch (final DataValidationException dataValidationException) {
342 log.error("Unable to de-register cm-handle id: {}, caused by: {}",
343 cmHandleId, dataValidationException.getMessage());
344 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
345 .createFailureResponse(cmHandleId, RegistrationError.CM_HANDLE_INVALID_ID));
346 } catch (final Exception exception) {
347 log.error("Unable to de-register cm-handle id : {} , caused by : {}",
348 cmHandleId, exception.getMessage());
349 cmHandleRegistrationResponses.add(
350 CmHandleRegistrationResponse.createFailureResponse(cmHandleId, exception));
353 return cmHandleRegistrationResponses;
356 private void deleteCmHandleByCmHandleId(final String cmHandleId) {
357 inventoryPersistence.deleteSchemaSetWithCascade(cmHandleId);
358 inventoryPersistence.deleteListOrListElement("/dmi-registry/cm-handles[@id='" + cmHandleId + "']");
361 private List<CmHandleRegistrationResponse> registerNewCmHandles(final Map<YangModelCmHandle, CmHandleState>
362 cmHandleStatePerCmHandle) {
363 final List<String> cmHandleIds = cmHandleStatePerCmHandle.keySet().stream().map(YangModelCmHandle::getId)
364 .collect(Collectors.toList());
366 lcmEventsCmHandleStateHandler.updateCmHandleStateBatch(cmHandleStatePerCmHandle);
367 return CmHandleRegistrationResponse.createSuccessResponses(cmHandleIds);
368 } catch (final AlreadyDefinedExceptionBatch alreadyDefinedExceptionBatch) {
369 return CmHandleRegistrationResponse.createFailureResponses(
370 alreadyDefinedExceptionBatch.getAlreadyDefinedCmHandleIds(),
371 RegistrationError.CM_HANDLE_ALREADY_EXIST);
372 } catch (final Exception exception) {
373 return CmHandleRegistrationResponse.createFailureResponses(cmHandleIds, exception);