X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-service%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fcps%2Fncmp%2Fapi%2Fimpl%2FNetworkCmProxyDataServiceImpl.java;h=aac44e43ec1a2caf5394d71dab31fd3d8953cc56;hb=e0643ab5130dde375c229989e216341e623a9c55;hp=a8c92d11f51d8ede26dc1d5256e777346011e438;hpb=e8997342a99415555680eedcbe4e12722f55fc33;p=cps.git diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java index a8c92d11f..aac44e43e 100755 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java @@ -1,8 +1,9 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2021 highstreet technologies GmbH - * Modifications Copyright (C) 2021 Nordix Foundation + * Modifications Copyright (C) 2021-2022 Nordix Foundation * Modifications Copyright (C) 2021 Pantheon.tech + * Modifications Copyright (C) 2021 Bell Canada * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,258 +23,236 @@ package org.onap.cps.ncmp.api.impl; +import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME; +import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR; +import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT; +import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME; +import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP; +import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum; +import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED; + import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.databind.ObjectMapper; import java.util.Collection; -import java.util.Collections; -import java.util.LinkedHashMap; -import java.util.LinkedList; +import java.util.HashMap; import java.util.List; import java.util.Map; -import javax.validation.constraints.NotNull; +import java.util.stream.Collectors; +import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; +import org.onap.cps.api.CpsAdminService; import org.onap.cps.api.CpsDataService; -import org.onap.cps.api.CpsQueryService; +import org.onap.cps.api.CpsModuleService; import org.onap.cps.ncmp.api.NetworkCmProxyDataService; -import org.onap.cps.ncmp.api.impl.exception.NcmpException; -import org.onap.cps.ncmp.api.impl.operation.DmiOperations; +import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException; +import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations; +import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations; +import org.onap.cps.ncmp.api.impl.operations.DmiOperations; import org.onap.cps.ncmp.api.models.CmHandle; import org.onap.cps.ncmp.api.models.DmiPluginRegistration; -import org.onap.cps.ncmp.api.models.GenericRequestBody; import org.onap.cps.ncmp.api.models.PersistenceCmHandle; import org.onap.cps.ncmp.api.models.PersistenceCmHandlesList; -import org.onap.cps.spi.FetchDescendantsOption; +import org.onap.cps.spi.exceptions.DataNodeNotFoundException; import org.onap.cps.spi.exceptions.DataValidationException; -import org.onap.cps.spi.model.DataNode; -import org.springframework.http.HttpStatus; +import org.onap.cps.spi.model.ModuleReference; +import org.onap.cps.utils.JsonObjectMapper; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Service; -import org.springframework.util.StringUtils; - @Slf4j @Service +@RequiredArgsConstructor public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService { - private static final String NF_PROXY_DATASPACE_NAME = "NFP-Operational"; - - private static final String NCMP_DATASPACE_NAME = "NCMP-Admin"; - - private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry"; + private final CpsDataService cpsDataService; - private CpsDataService cpsDataService; + private final JsonObjectMapper jsonObjectMapper; - private ObjectMapper objectMapper; + private final DmiDataOperations dmiDataOperations; - private CpsQueryService cpsQueryService; + private final DmiModelOperations dmiModelOperations; - private DmiOperations dmiOperations; + private final CpsModuleService cpsModuleService; - /** - * Constructor Injection for Dependencies. - * - * @param dmiOperations dmi operation - * @param cpsDataService Data Service Interface - * @param cpsQueryService Query Service Interface - * @param objectMapper Object Mapper - */ - public NetworkCmProxyDataServiceImpl(final DmiOperations dmiOperations, final CpsDataService cpsDataService, - final CpsQueryService cpsQueryService, final ObjectMapper objectMapper) { - this.dmiOperations = dmiOperations; - this.cpsDataService = cpsDataService; - this.cpsQueryService = cpsQueryService; - this.objectMapper = objectMapper; - } + private final CpsAdminService cpsAdminService; - private String getDataspaceName() { - return NF_PROXY_DATASPACE_NAME; - } + private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler; @Override - public DataNode getDataNode(final String cmHandle, final String xpath, - final FetchDescendantsOption fetchDescendantsOption) { - return cpsDataService.getDataNode(getDataspaceName(), cmHandle, xpath, fetchDescendantsOption); + public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) { + dmiPluginRegistration.validateDmiPluginRegistration(); + try { + if (dmiPluginRegistration.getCreatedCmHandles() != null) { + parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration); + } + if (dmiPluginRegistration.getUpdatedCmHandles() != null) { + parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration); + } + if (dmiPluginRegistration.getRemovedCmHandles() != null) { + parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration); + } + } catch (final JsonProcessingException | DataNodeNotFoundException e) { + final String errorMessage = String.format( + "Error occurred while processing the CM-handle registration request, caused by : [%s]", + e.getMessage()); + throw new DataValidationException(errorMessage, e.getMessage(), e); + } } @Override - public Collection queryDataNodes(final String cmHandle, final String cpsPath, - final FetchDescendantsOption fetchDescendantsOption) { - return cpsQueryService.queryDataNodes(getDataspaceName(), cmHandle, cpsPath, fetchDescendantsOption); + public Object getResourceDataOperationalForCmHandle(final String cmHandle, + final String resourceIdentifier, + final String acceptParamInHeader, + final String optionsParamInQuery) { + return handleResponse(dmiDataOperations.getResourceDataFromDmi( + cmHandle, + resourceIdentifier, + optionsParamInQuery, + acceptParamInHeader, + DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL), "Not able to get resource data."); } @Override - public void createDataNode(final String cmHandle, final String parentNodeXpath, final String jsonData) { - if (!StringUtils.hasText(parentNodeXpath) || "/".equals(parentNodeXpath)) { - cpsDataService.saveData(getDataspaceName(), cmHandle, jsonData); - } else { - cpsDataService.saveData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData); - } + public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandle, + final String resourceIdentifier, + final String acceptParamInHeader, + final String optionsParamInQuery) { + return handleResponse(dmiDataOperations.getResourceDataFromDmi( + cmHandle, + resourceIdentifier, + optionsParamInQuery, + acceptParamInHeader, + DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING), "Not able to get resource data."); } @Override - public void addListNodeElements(final String cmHandle, final String parentNodeXpath, final String jsonData) { - cpsDataService.saveListNodeData(getDataspaceName(), cmHandle, parentNodeXpath, jsonData); + public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandle, + final String resourceIdentifier, + final OperationEnum operation, + final String requestData, + final String dataType) { + return handleResponse( + dmiDataOperations.writeResourceDataPassThroughRunningFromDmi( + cmHandle, resourceIdentifier, operation, requestData, dataType), + "Not able to " + operation + " resource data."); } + @Override - public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) { - cpsDataService.updateNodeLeaves(getDataspaceName(), cmHandle, parentNodeXpath, jsonData); + public Collection getYangResourcesModuleReferences(final String cmHandle) { + return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandle); } + /** + * Retrieve cm handle identifiers for the given list of module names. + * + * @param moduleNames module names. + * @return a collection of anchor identifiers + */ @Override - public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) { - cpsDataService.replaceNodeTree(getDataspaceName(), cmHandle, parentNodeXpath, jsonData); + public Collection executeCmHandleHasAllModulesSearch(final Collection moduleNames) { + return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames); } - @Override - public void updateDmiPluginRegistration(final DmiPluginRegistration dmiPluginRegistration) { - if (dmiPluginRegistration.getCreatedCmHandles() != null) { - parseAndCreateCmHandlesInDmiRegistration(dmiPluginRegistration); - } - if (dmiPluginRegistration.getUpdatedCmHandles() != null) { - parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration); - } + /** + * THis method registers a cm handle and intiates modules sync. + * + * @param dmiPluginRegistration dmi plugin registration information. + * @throws JsonProcessingException thrown if json is malformed or missing. + */ + public void parseAndCreateCmHandlesInDmiRegistrationAndSyncModules( + final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException { + final PersistenceCmHandlesList createdPersistenceCmHandlesList = + getUpdatedPersistenceCmHandlesList(dmiPluginRegistration, dmiPluginRegistration.getCreatedCmHandles()); + registerAndSyncNewCmHandles(createdPersistenceCmHandlesList); } - private void parseAndCreateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) { - try { - final List createdPersistenceCmHandles = - new LinkedList<>(); - for (final CmHandle cmHandle : dmiPluginRegistration.getCreatedCmHandles()) { - createdPersistenceCmHandles.add(toPersistenceCmHandle(dmiPluginRegistration, cmHandle)); - } - final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList(); - persistenceCmHandlesList.setCmHandles(createdPersistenceCmHandles); - final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList); - cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry", - cmHandleJsonData); - } catch (final JsonProcessingException e) { - log.error("Parsing error occurred while converting Object to JSON for Dmi Registry."); - throw new DataValidationException( - "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e - .getMessage(), e); + private static Object handleResponse(final ResponseEntity responseEntity, + final String exceptionMessage) { + if (responseEntity.getStatusCode().is2xxSuccessful()) { + return responseEntity.getBody(); + } else { + throw new ServerNcmpException(exceptionMessage, + "DMI status code: " + responseEntity.getStatusCodeValue() + + ", DMI response body: " + responseEntity.getBody()); } } private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) { - try { - final List updatedPersistenceCmHandles = - new LinkedList<>(); - for (final CmHandle cmHandle : dmiPluginRegistration.getUpdatedCmHandles()) { - updatedPersistenceCmHandles.add(toPersistenceCmHandle(dmiPluginRegistration, cmHandle)); - } - final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList(); - persistenceCmHandlesList.setCmHandles(updatedPersistenceCmHandles); - final String cmHandlesJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList); - cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, - "/dmi-registry", cmHandlesJsonData); - } catch (final JsonProcessingException e) { - log.error("Parsing error occurred while converting Object to JSON Dmi Registry."); - throw new DataValidationException( - "Parsing error occurred while processing DMI Plugin Registration" + dmiPluginRegistration, e - .getMessage(), e); - } + networkCmProxyDataServicePropertyHandler.updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()); } - @Override - public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle, - final @NotNull String resourceIdentifier, - final String acceptParam, - final String fieldsQueryParam, - final Integer depthQueryParam) { - - final var dataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle); - final var dmiServiceName = String.valueOf(dataNode.getLeaves().get("dmi-service-name")); - final Collection additionalPropsList = dataNode.getChildDataNodes(); - final var jsonBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList); - final ResponseEntity response = dmiOperations.getResouceDataOperationalFromDmi(dmiServiceName, - cmHandle, - resourceIdentifier, - fieldsQueryParam, - depthQueryParam, - acceptParam, - jsonBody); - return handleResponse(response); + private PersistenceCmHandlesList getUpdatedPersistenceCmHandlesList( + final DmiPluginRegistration dmiPluginRegistration, + final List updatedCmHandles) { + return PersistenceCmHandlesList.toPersistenceCmHandlesList( + dmiPluginRegistration.getDmiPlugin(), + dmiPluginRegistration.getDmiDataPlugin(), + dmiPluginRegistration.getDmiModelPlugin(), + updatedCmHandles); } - @Override - public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle, - final @NotNull String resourceIdentifier, - final String accept, - final String fields, - final Integer depth) { - final var cmHandleDataNode = fetchDataNodeFromDmiRegistryForCmHandle(cmHandle); - final var dmiServiceName = String.valueOf(cmHandleDataNode.getLeaves().get("dmi-service-name")); - final Collection additionalPropsList = cmHandleDataNode.getChildDataNodes(); - final var dmiRequesBody = prepareOperationBody(GenericRequestBody.OperationEnum.READ, additionalPropsList); - final ResponseEntity response = dmiOperations.getResouceDataPassThroughRunningFromDmi(dmiServiceName, - cmHandle, - resourceIdentifier, - fields, - depth, - accept, - dmiRequesBody); - return handleResponse(response); - } + private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList) { + final String cmHandleJsonData = jsonObjectMapper.asJsonString(persistenceCmHandlesList); + cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT, + cmHandleJsonData, NO_TIMESTAMP); - private DataNode fetchDataNodeFromDmiRegistryForCmHandle(final String cmHandle) { - final String xpathForDmiRegistryToFetchCmHandle = "/dmi-registry/cm-handles[@id='" + cmHandle + "']"; - final var dataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, - NCMP_DMI_REGISTRY_ANCHOR, - xpathForDmiRegistryToFetchCmHandle, - FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS); - return dataNode; + for (final PersistenceCmHandle persistenceCmHandle : persistenceCmHandlesList.getPersistenceCmHandles()) { + syncModulesAndCreateAnchor(persistenceCmHandle); + } } - private String prepareOperationBody(final GenericRequestBody.OperationEnum operation, - final Collection additionalPropertyList) { - final var requestBody = new GenericRequestBody(); - final Map additionalPropertyMap = getAdditionalPropertiesMap(additionalPropertyList); - requestBody.setOperation(GenericRequestBody.OperationEnum.READ); - requestBody.setCmHandleProperties(additionalPropertyMap); - try { - final var requestJson = objectMapper.writeValueAsString(requestBody); - return requestJson; - } catch (final JsonProcessingException je) { - log.error("Parsing error occurred while converting Object to JSON."); - throw new NcmpException("Parsing error occurred while converting given object to JSON.", - je.getMessage()); - } + protected void syncModulesAndCreateAnchor(final PersistenceCmHandle persistenceCmHandle) { + syncAndCreateSchemaSet(persistenceCmHandle); + createAnchor(persistenceCmHandle); } - private Map getAdditionalPropertiesMap(final Collection additionalPropertyList) { - if (additionalPropertyList == null || additionalPropertyList.size() == 0) { - return null; - } - final Map additionalPropertyMap = new LinkedHashMap<>(); - for (final var node : additionalPropertyList) { - additionalPropertyMap.put(String.valueOf(node.getLeaves().get("name")), - String.valueOf(node.getLeaves().get("value"))); + private void parseAndRemoveCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) { + for (final String cmHandle : dmiPluginRegistration.getRemovedCmHandles()) { + try { + attemptToDeleteSchemaSetWithCascade(cmHandle); + cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, + "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP); + } catch (final DataNodeNotFoundException e) { + log.warn("Datanode {} not deleted message {}", cmHandle, e.getMessage()); + } } - return additionalPropertyMap; } - private Object handleResponse(final ResponseEntity responseEntity) { - if (responseEntity.getStatusCode() == HttpStatus.OK) { - return responseEntity.getBody(); - } else { - throw new NcmpException("Not able to get resource data.", - "DMI status code: " + responseEntity.getStatusCodeValue() - + ", DMI response body: " + responseEntity.getBody()); + private void attemptToDeleteSchemaSetWithCascade(final String schemaSetName) { + try { + cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName, + CASCADE_DELETE_ALLOWED); + } catch (final Exception e) { + log.warn("Schema set {} delete failed, reason {}", schemaSetName, e.getMessage()); } } - private PersistenceCmHandle toPersistenceCmHandle(final DmiPluginRegistration dmiPluginRegistration, - final CmHandle cmHandle) { - final PersistenceCmHandle persistenceCmHandle = new PersistenceCmHandle(); - persistenceCmHandle.setDmiServiceName(dmiPluginRegistration.getDmiPlugin()); - persistenceCmHandle.setId(cmHandle.getCmHandleID()); - if (cmHandle.getCmHandleProperties() == null) { - persistenceCmHandle.setAdditionalProperties(Collections.EMPTY_MAP); + private void syncAndCreateSchemaSet(final PersistenceCmHandle persistenceCmHandle) { + final Collection moduleReferencesFromCmHandle = + dmiModelOperations.getModuleReferences(persistenceCmHandle); + + final Collection identifiedNewModuleReferencesFromCmHandle = cpsModuleService + .identifyNewModuleReferences(moduleReferencesFromCmHandle); + + final Collection existingModuleReferencesFromCmHandle = + moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle -> + !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle) + ).collect(Collectors.toList()); + + final Map newModuleNameToContentMap; + if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) { + newModuleNameToContentMap = new HashMap<>(); } else { - persistenceCmHandle.setAdditionalProperties(cmHandle.getCmHandleProperties()); + newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(persistenceCmHandle, + identifiedNewModuleReferencesFromCmHandle); } - return persistenceCmHandle; + cpsModuleService + .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, persistenceCmHandle.getId(), + newModuleNameToContentMap, existingModuleReferencesFromCmHandle); } + private void createAnchor(final PersistenceCmHandle persistenceCmHandle) { + cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, persistenceCmHandle.getId(), + persistenceCmHandle.getId()); + } }