2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022 Nordix Foundation
4 * Modifications Copyright (C) 2022 Bell Canada
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.api.inventory.sync;
24 import java.util.List;
25 import java.util.function.Consumer;
26 import lombok.RequiredArgsConstructor;
27 import lombok.extern.slf4j.Slf4j;
28 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
29 import org.onap.cps.ncmp.api.inventory.CmHandleState;
30 import org.onap.cps.ncmp.api.inventory.CompositeState;
31 import org.onap.cps.ncmp.api.inventory.DataStoreSyncState;
32 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
33 import org.onap.cps.ncmp.api.inventory.LockReasonCategory;
34 import org.springframework.beans.factory.annotation.Value;
35 import org.springframework.scheduling.annotation.Scheduled;
36 import org.springframework.stereotype.Component;
39 @RequiredArgsConstructor
41 public class ModuleSyncWatchdog {
43 private final InventoryPersistence inventoryPersistence;
45 private final SyncUtils syncUtils;
47 private final ModuleSyncService moduleSyncService;
49 @Value("${data-sync.cache.enabled:false}")
50 private boolean isGlobalDataSyncCacheEnabled;
53 * Execute Cm Handle poll which changes the cm handle state from 'ADVISED' to 'READY'.
55 @Scheduled(fixedDelayString = "${timers.advised-modules-sync.sleep-time-ms:30000}")
56 public void executeAdvisedCmHandlePoll() {
57 syncUtils.getAdvisedCmHandles().stream().forEach(advisedCmHandle -> {
58 final String cmHandleId = advisedCmHandle.getId();
59 final CompositeState compositeState = inventoryPersistence.getCmHandleState(cmHandleId);
61 moduleSyncService.deleteSchemaSetIfExists(advisedCmHandle);
62 moduleSyncService.syncAndCreateSchemaSetAndAnchor(advisedCmHandle);
63 setCompositeStateToReadyWithInitialDataStoreSyncState().accept(compositeState);
64 } catch (final Exception e) {
65 setCompositeStateToLocked().accept(compositeState);
66 syncUtils.updateLockReasonDetailsAndAttempts(compositeState,
67 LockReasonCategory.LOCKED_MODULE_SYNC_FAILED, e.getMessage());
69 inventoryPersistence.saveCmHandleState(cmHandleId, compositeState);
70 log.debug("{} is now in {} state", cmHandleId, compositeState.getCmHandleState().name());
72 log.debug("No Cm-Handles currently found in an ADVISED state");
76 * Execute Cm Handle poll which changes the cm handle state from 'LOCKED' to 'ADVISED'.
78 @Scheduled(fixedDelayString = "${timers.locked-modules-sync.sleep-time-ms:300000}")
79 public void executeLockedCmHandlePoll() {
80 final List<YangModelCmHandle> lockedCmHandles = syncUtils.getModuleSyncFailedCmHandles();
81 for (final YangModelCmHandle lockedCmHandle : lockedCmHandles) {
82 final CompositeState compositeState = lockedCmHandle.getCompositeState();
83 final boolean isReadyForRetry = syncUtils.isReadyForRetry(compositeState);
84 if (isReadyForRetry) {
85 setCompositeStateToAdvisedAndRetainOldLockReasonDetails(compositeState);
86 log.debug("Locked cm handle {} is being re-synced", lockedCmHandle.getId());
87 inventoryPersistence.saveCmHandleState(lockedCmHandle.getId(), compositeState);
92 private Consumer<CompositeState> setCompositeStateToLocked() {
93 return compositeState -> {
94 compositeState.setCmHandleState(CmHandleState.LOCKED);
95 compositeState.setLastUpdateTimeNow();
99 private Consumer<CompositeState> setCompositeStateToReadyWithInitialDataStoreSyncState() {
100 return compositeState -> {
101 compositeState.setDataSyncEnabled(isGlobalDataSyncCacheEnabled);
102 compositeState.setCmHandleState(CmHandleState.READY);
103 final CompositeState.Operational operational = getDataStoreSyncState(compositeState.getDataSyncEnabled());
104 final CompositeState.DataStores dataStores = CompositeState.DataStores.builder()
105 .operationalDataStore(operational)
107 compositeState.setDataStores(dataStores);
111 private void setCompositeStateToAdvisedAndRetainOldLockReasonDetails(final CompositeState compositeState) {
112 compositeState.setCmHandleState(CmHandleState.ADVISED);
113 compositeState.setLastUpdateTimeNow();
114 final String oldLockReasonDetails = compositeState.getLockReason().getDetails();
115 final CompositeState.LockReason lockReason = CompositeState.LockReason.builder()
116 .details(oldLockReasonDetails).build();
117 compositeState.setLockReason(lockReason);
120 private CompositeState.Operational getDataStoreSyncState(final boolean dataSyncEnabled) {
121 final DataStoreSyncState dataStoreSyncState = dataSyncEnabled
122 ? DataStoreSyncState.UNSYNCHRONIZED : DataStoreSyncState.NONE_REQUESTED;
123 return CompositeState.Operational.builder().dataStoreSyncState(dataStoreSyncState).build();