diff options
Diffstat (limited to 'cps-ncmp-service/src/main')
10 files changed, 117 insertions, 35 deletions
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java index 1ad61e6a6d..ea27d4a1e9 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java @@ -33,6 +33,7 @@ import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters; import org.onap.cps.ncmp.api.models.DmiPluginRegistration; import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse; import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle; +import org.onap.cps.spi.model.ModuleDefinition; import org.onap.cps.spi.model.ModuleReference; /* @@ -107,6 +108,14 @@ public interface NetworkCmProxyDataService { Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandleId); /** + * Retrieve module definitions for the given cm handle. + * + * @param cmHandleId cm handle identifier + * @return a collection of module definition (moduleName, revision and yang resource content) + */ + Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(String cmHandleId); + + /** * Query cm handle details by cm handle's name. * * @param cmHandleId cm handle identifier 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 e118bf1e58..044a5a44f9 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 @@ -63,6 +63,7 @@ import org.onap.cps.spi.exceptions.DataNodeNotFoundException; import org.onap.cps.spi.exceptions.DataValidationException; import org.onap.cps.spi.exceptions.SchemaSetNotFoundException; import org.onap.cps.spi.model.CmHandleQueryServiceParameters; +import org.onap.cps.spi.model.ModuleDefinition; import org.onap.cps.spi.model.ModuleReference; import org.onap.cps.utils.CpsValidator; import org.onap.cps.utils.JsonObjectMapper; @@ -153,6 +154,12 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId); } + @Override + public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) { + CpsValidator.validateNameCharacters(cmHandleId); + return inventoryPersistence.getModuleDefinitionsByCmHandleId(cmHandleId); + } + /** * Retrieve cm handles with details for the given query parameters. * diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java index df303b5daa..e8fcaabe91 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeState.java @@ -94,7 +94,7 @@ public class CompositeState { public static class Operational { @JsonProperty("sync-state") - private SyncState syncState; + private DataStoreSyncState dataStoreSyncState; @JsonProperty("last-sync-time") private String lastSyncTime; diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeStateBuilder.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeStateBuilder.java index 91e92ea6f9..a0fc0c3a91 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeStateBuilder.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CompositeStateBuilder.java @@ -94,13 +94,14 @@ public class CompositeStateBuilder { /** * To use attributes for creating {@link CompositeState}. * - * @param syncState for the locked state + * @param dataStoreSyncState for the locked state * @param lastSyncTime for the locked state * @return CompositeStateBuilder */ - public CompositeStateBuilder withOperationalDataStores(final SyncState syncState, final String lastSyncTime) { + public CompositeStateBuilder withOperationalDataStores(final DataStoreSyncState dataStoreSyncState, + final String lastSyncTime) { this.datastores = DataStores.builder().operationalDataStore( - Operational.builder().syncState(syncState).lastSyncTime(lastSyncTime).build()).build(); + Operational.builder().dataStoreSyncState(dataStoreSyncState).lastSyncTime(lastSyncTime).build()).build(); return this; } @@ -133,7 +134,7 @@ public class CompositeStateBuilder { private Operational getOperationalDataStore(final DataNode dataStoreNodes) { return Operational.builder() - .syncState(SyncState.valueOf((String) dataStoreNodes.getLeaves().get("sync-state"))) + .dataStoreSyncState(DataStoreSyncState.valueOf((String) dataStoreNodes.getLeaves().get("sync-state"))) .lastSyncTime((String) dataStoreNodes.getLeaves().get("last-sync-time")) .build(); } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/SyncState.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/DataStoreSyncState.java index 9c7a476183..4dbedf5f1c 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/SyncState.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/DataStoreSyncState.java @@ -20,6 +20,6 @@ package org.onap.cps.ncmp.api.inventory; -public enum SyncState { +public enum DataStoreSyncState { SYNCHRONIZED, UNSYNCHRONIZED, NONE_REQUESTED } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/InventoryPersistence.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/InventoryPersistence.java index c24063cb45..d47da6c0cf 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/InventoryPersistence.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/InventoryPersistence.java @@ -21,15 +21,20 @@ package org.onap.cps.ncmp.api.inventory; +import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME; + import java.time.OffsetDateTime; +import java.util.Collection; import java.util.List; import lombok.RequiredArgsConstructor; import org.onap.cps.api.CpsDataService; +import org.onap.cps.api.CpsModuleService; import org.onap.cps.ncmp.api.impl.utils.YangDataConverter; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; import org.onap.cps.spi.CpsDataPersistenceService; import org.onap.cps.spi.FetchDescendantsOption; import org.onap.cps.spi.model.DataNode; +import org.onap.cps.spi.model.ModuleDefinition; import org.onap.cps.utils.CpsValidator; import org.onap.cps.utils.JsonObjectMapper; import org.springframework.stereotype.Component; @@ -42,15 +47,17 @@ public class InventoryPersistence { private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry"; - private static final String XPATH_TO_CM_HANDLE = "/dmi-registry/cm-handles[@id='" + "%s" + "']"; + private String xpathCmHandle = "/dmi-registry/cm-handles[@id='" + "%s" + "']"; + + private static final String ANCESTOR_CM_HANDLES = "\"]/ancestor::cm-handles"; private final JsonObjectMapper jsonObjectMapper; private final CpsDataService cpsDataService; - private final CpsDataPersistenceService cpsDataPersistenceService; + private final CpsModuleService cpsModuleService; - private static final CompositeStateBuilder compositeStateBuilder = new CompositeStateBuilder(); + private final CpsDataPersistenceService cpsDataPersistenceService; /** * Get the Cm Handle Composite State from the data node. @@ -60,9 +67,9 @@ public class InventoryPersistence { */ public CompositeState getCmHandleState(final String cmHandleId) { final DataNode stateAsDataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, - String.format(XPATH_TO_CM_HANDLE, cmHandleId) + "/state", + String.format(xpathCmHandle, cmHandleId) + "/state", FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS); - return compositeStateBuilder.fromDataNode(stateAsDataNode).build(); + return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build(); } /** @@ -75,7 +82,7 @@ public class InventoryPersistence { final String cmHandleJsonData = String.format("{\"state\":%s}", jsonObjectMapper.asJsonString(compositeState)); cpsDataService.replaceNodeTree(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, - String.format(XPATH_TO_CM_HANDLE, cmHandleId), + String.format(xpathCmHandle, cmHandleId), cmHandleJsonData, OffsetDateTime.now()); } @@ -88,7 +95,7 @@ public class InventoryPersistence { public List<DataNode> getCmHandlesByState(final CmHandleState cmHandleState) { return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "//state[@cm-handle-state=\"" - + cmHandleState + "\"]/ancestor::cm-handles", + + cmHandleState + ANCESTOR_CM_HANDLES, FetchDescendantsOption.OMIT_DESCENDANTS); } @@ -114,19 +121,19 @@ public class InventoryPersistence { public List<DataNode> getCmHandlesByIdAndState(final String cmHandleId, final CmHandleState cmHandleState) { return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "//cm-handles[@id='" + cmHandleId + "']/state[@cm-handle-state=\"" - + cmHandleState + "\"]/ancestor::cm-handles", + + cmHandleState + ANCESTOR_CM_HANDLES, FetchDescendantsOption.OMIT_DESCENDANTS); } /** * Method which returns cm handles by the operational sync state of cm handle. - * @param syncState sync state + * @param dataStoreSyncState sync state * @return a list of cm handles */ - public List<DataNode> getCmHandlesByOperationalSyncState(final SyncState syncState) { + public List<DataNode> getCmHandlesByOperationalSyncState(final DataStoreSyncState dataStoreSyncState) { return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "//state/datastores" - + "/operational[@sync-state=\"" + syncState + "\"]/ancestor::cm-handles", + + "/operational[@sync-state=\"" + dataStoreSyncState + ANCESTOR_CM_HANDLES, FetchDescendantsOption.OMIT_DESCENDANTS); } @@ -140,10 +147,20 @@ public class InventoryPersistence { return YangDataConverter.convertCmHandleToYangModel(getCmHandleDataNode(cmHandleId), cmHandleId); } + /** + * Method to return module definitions by cmHandleId. + * + * @param cmHandleId cm handle ID + * @return a collection of module definitions (moduleName, revision and yang resource content) + */ + public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) { + return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId); + } + private DataNode getCmHandleDataNode(final String cmHandle) { return cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, - String.format(XPATH_TO_CM_HANDLE, cmHandle), + String.format(xpathCmHandle, cmHandle), FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS); } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/DataSyncWatchdog.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/DataSyncWatchdog.java index 553db65dd0..adfa33ad81 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/DataSyncWatchdog.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/DataSyncWatchdog.java @@ -21,13 +21,14 @@ package org.onap.cps.ncmp.api.inventory.sync; import java.time.OffsetDateTime; +import java.util.function.Consumer; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.onap.cps.api.CpsDataService; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; import org.onap.cps.ncmp.api.inventory.CompositeState; +import org.onap.cps.ncmp.api.inventory.DataStoreSyncState; import org.onap.cps.ncmp.api.inventory.InventoryPersistence; -import org.onap.cps.ncmp.api.inventory.SyncState; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Service; @@ -60,15 +61,21 @@ public class DataSyncWatchdog { } else { cpsDataService.saveData("NFP-Operational", cmHandleId, resourceData, OffsetDateTime.now()); + setSyncStateToSynchronized().accept(compositeState); + inventoryPersistence.saveCmHandleState(cmHandleId, compositeState); } + unSynchronizedReadyCmHandle = syncUtils.getAnUnSynchronizedReadyCmHandle(); + } + log.debug("No Cm-Handles currently found in an READY State and Operational Sync State is UNSYNCHRONIZED"); + } + + private Consumer<CompositeState> setSyncStateToSynchronized() { + return compositeState -> { compositeState.setLastUpdateTimeNow(); compositeState.getDataStores() .setOperationalDataStore(CompositeState.Operational.builder() - .syncState(SyncState.SYNCHRONIZED) + .dataStoreSyncState(DataStoreSyncState.SYNCHRONIZED) .lastSyncTime(CompositeState.nowInSyncTimeFormat()).build()); - inventoryPersistence.saveCmHandleState(cmHandleId, compositeState); - unSynchronizedReadyCmHandle = syncUtils.getAnUnSynchronizedReadyCmHandle(); - } - log.debug("No Cm-Handles currently found in an READY State and Operational Sync State is UNSYNCHRONIZED"); + }; } } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncService.java index 58e2bf3450..c574aa61d9 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncService.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncService.java @@ -32,6 +32,8 @@ import org.onap.cps.api.CpsAdminService; import org.onap.cps.api.CpsModuleService; import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; +import org.onap.cps.spi.CascadeDeleteAllowed; +import org.onap.cps.spi.exceptions.SchemaSetNotFoundException; import org.onap.cps.spi.model.ModuleReference; import org.springframework.stereotype.Service; @@ -83,4 +85,21 @@ public class ModuleSyncService { schemaSetAndAnchorName); } + /** + * Deletes the SchemaSet for provided cmHandle if the SchemaSet Exists. + * + * @param yangModelCmHandle the yang model of cm handle. + */ + public void deleteSchemaSetIfExists(final YangModelCmHandle yangModelCmHandle) { + final String schemaSetAndAnchorName = yangModelCmHandle.getId(); + try { + cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetAndAnchorName, + CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED); + log.debug("SchemaSet for {} has been deleted. Ready to be recreated.", schemaSetAndAnchorName); + } catch (final SchemaSetNotFoundException e) { + log.debug("No SchemaSet for {}. Assuming CmHandle has not been previously Module Synced.", + schemaSetAndAnchorName); + } + } + } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncWatchdog.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncWatchdog.java index 402f9f6b4f..6ec44197d2 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncWatchdog.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncWatchdog.java @@ -22,11 +22,13 @@ package org.onap.cps.ncmp.api.inventory.sync; import java.util.List; +import java.util.function.Consumer; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; import org.onap.cps.ncmp.api.inventory.CmHandleState; import org.onap.cps.ncmp.api.inventory.CompositeState; +import org.onap.cps.ncmp.api.inventory.DataStoreSyncState; import org.onap.cps.ncmp.api.inventory.InventoryPersistence; import org.onap.cps.ncmp.api.inventory.LockReasonCategory; import org.springframework.scheduling.annotation.Scheduled; @@ -53,18 +55,16 @@ public class ModuleSyncWatchdog { final String cmHandleId = advisedCmHandle.getId(); final CompositeState compositeState = inventoryPersistence.getCmHandleState(cmHandleId); try { + moduleSyncService.deleteSchemaSetIfExists(advisedCmHandle); moduleSyncService.syncAndCreateSchemaSetAndAnchor(advisedCmHandle); - compositeState.setCmHandleState(CmHandleState.READY); + setCompositeStateToReadyWithInitialDataStoreSyncState().accept(compositeState); } catch (final Exception e) { - compositeState.setCmHandleState(CmHandleState.LOCKED); + setCompositeStateToLocked().accept(compositeState); syncUtils.updateLockReasonDetailsAndAttempts(compositeState, - LockReasonCategory.LOCKED_MISBEHAVING, - e.getMessage()); + LockReasonCategory.LOCKED_MISBEHAVING, e.getMessage()); } - compositeState.setLastUpdateTimeNow(); inventoryPersistence.saveCmHandleState(cmHandleId, compositeState); - log.info("{} is now in {} state", cmHandleId, - advisedCmHandle.getCompositeState().getCmHandleState()); + log.debug("{} is now in {} state", cmHandleId, compositeState.getCmHandleState().name()); advisedCmHandle = syncUtils.getAnAdvisedCmHandle(); } log.debug("No Cm-Handles currently found in an ADVISED state"); @@ -87,11 +87,33 @@ public class ModuleSyncWatchdog { } } + private Consumer<CompositeState> setCompositeStateToLocked() { + return compositeState -> { + compositeState.setCmHandleState(CmHandleState.LOCKED); + compositeState.setLastUpdateTimeNow(); + }; + } + + private Consumer<CompositeState> setCompositeStateToReadyWithInitialDataStoreSyncState() { + return compositeState -> { + compositeState.setCmHandleState(CmHandleState.READY); + final CompositeState.Operational operational = CompositeState.Operational.builder() + .dataStoreSyncState(DataStoreSyncState.UNSYNCHRONIZED) + .lastSyncTime(CompositeState.nowInSyncTimeFormat()) + .build(); + final CompositeState.DataStores dataStores = CompositeState.DataStores.builder() + .operationalDataStore(operational) + .build(); + compositeState.setDataStores(dataStores); + }; + } + private void setCompositeStateToAdvisedAndRetainOldLockReasonDetails(final CompositeState compositeState) { compositeState.setCmHandleState(CmHandleState.ADVISED); compositeState.setLastUpdateTimeNow(); final String oldLockReasonDetails = compositeState.getLockReason().getDetails(); - compositeState.setLockReason(CompositeState.LockReason.builder() - .details(oldLockReasonDetails).build()); + final CompositeState.LockReason lockReason = CompositeState.LockReason.builder() + .details(oldLockReasonDetails).build(); + compositeState.setLockReason(lockReason); } } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java index 8b7dfe6b81..0c3af6aaeb 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/SyncUtils.java @@ -43,9 +43,9 @@ import org.onap.cps.ncmp.api.impl.utils.YangDataConverter; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; import org.onap.cps.ncmp.api.inventory.CmHandleState; import org.onap.cps.ncmp.api.inventory.CompositeState; +import org.onap.cps.ncmp.api.inventory.DataStoreSyncState; import org.onap.cps.ncmp.api.inventory.InventoryPersistence; import org.onap.cps.ncmp.api.inventory.LockReasonCategory; -import org.onap.cps.ncmp.api.inventory.SyncState; import org.onap.cps.spi.FetchDescendantsOption; import org.onap.cps.spi.model.DataNode; import org.onap.cps.utils.JsonObjectMapper; @@ -92,7 +92,7 @@ public class SyncUtils { */ public YangModelCmHandle getAnUnSynchronizedReadyCmHandle() { final List<DataNode> unSynchronizedCmHandles = inventoryPersistence - .getCmHandlesByOperationalSyncState(SyncState.UNSYNCHRONIZED); + .getCmHandlesByOperationalSyncState(DataStoreSyncState.UNSYNCHRONIZED); if (unSynchronizedCmHandles.isEmpty()) { return null; } |