2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2023 Nordix Foundation
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api.impl.events.lcm;
23 import static org.onap.cps.ncmp.api.inventory.CmHandleState.ADVISED;
24 import static org.onap.cps.ncmp.api.inventory.CmHandleState.DELETED;
25 import static org.onap.cps.ncmp.api.inventory.CmHandleState.LOCKED;
26 import static org.onap.cps.ncmp.api.inventory.CmHandleState.READY;
28 import io.micrometer.core.annotation.Timed;
29 import java.util.ArrayList;
30 import java.util.Collection;
31 import java.util.LinkedHashMap;
32 import java.util.List;
35 import lombok.NoArgsConstructor;
36 import lombok.RequiredArgsConstructor;
38 import lombok.extern.slf4j.Slf4j;
39 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
40 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
41 import org.onap.cps.ncmp.api.inventory.CmHandleState;
42 import org.onap.cps.ncmp.api.inventory.CompositeState;
43 import org.onap.cps.ncmp.api.inventory.CompositeStateUtils;
44 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
45 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
46 import org.springframework.stereotype.Service;
50 @RequiredArgsConstructor
51 public class LcmEventsCmHandleStateHandlerImpl implements LcmEventsCmHandleStateHandler {
53 private final InventoryPersistence inventoryPersistence;
54 private final LcmEventsCmHandleStateHandlerAsyncHelper lcmEventsCmHandleStateHandlerAsyncHelper;
57 public void updateCmHandleState(final YangModelCmHandle updatedYangModelCmHandle,
58 final CmHandleState targetCmHandleState) {
60 final CompositeState compositeState = updatedYangModelCmHandle.getCompositeState();
62 if (isCompositeStateSame(compositeState, targetCmHandleState)) {
63 log.debug("CmHandle with id : {} already in state : {}", updatedYangModelCmHandle.getId(),
66 final YangModelCmHandle currentYangModelCmHandle = YangModelCmHandle.deepCopyOf(updatedYangModelCmHandle);
67 updateToSpecifiedCmHandleState(updatedYangModelCmHandle, targetCmHandleState);
68 persistCmHandle(updatedYangModelCmHandle, currentYangModelCmHandle);
69 lcmEventsCmHandleStateHandlerAsyncHelper.publishLcmEventAsynchronously(
70 toNcmpServiceCmHandle(updatedYangModelCmHandle),
71 toNcmpServiceCmHandle(currentYangModelCmHandle));
76 @Timed(value = "cps.ncmp.cmhandle.state.update.batch",
77 description = "Time taken to update a batch of cm handle states")
78 public void updateCmHandleStateBatch(final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
79 final Collection<CmHandleTransitionPair> cmHandleTransitionPairs =
80 prepareCmHandleTransitionBatch(cmHandleStatePerCmHandle);
81 persistCmHandleBatch(cmHandleTransitionPairs);
82 lcmEventsCmHandleStateHandlerAsyncHelper.publishLcmEventBatchAsynchronously(cmHandleTransitionPairs);
85 private Collection<CmHandleTransitionPair> prepareCmHandleTransitionBatch(
86 final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
87 final List<CmHandleTransitionPair> cmHandleTransitionPairs = new ArrayList<>(cmHandleStatePerCmHandle.size());
88 cmHandleStatePerCmHandle.forEach((yangModelCmHandle, targetCmHandleState) -> {
90 final CompositeState compositeState = yangModelCmHandle.getCompositeState();
92 if (isCompositeStateSame(compositeState, targetCmHandleState)) {
93 log.debug("CmHandle with id : {} already in state : {}", yangModelCmHandle.getId(),
96 final CmHandleTransitionPair cmHandleTransitionPair = new CmHandleTransitionPair();
97 cmHandleTransitionPair.setCurrentYangModelCmHandle(YangModelCmHandle.deepCopyOf(yangModelCmHandle));
98 updateToSpecifiedCmHandleState(yangModelCmHandle, targetCmHandleState);
99 cmHandleTransitionPair.setTargetYangModelCmHandle(yangModelCmHandle);
100 cmHandleTransitionPairs.add(cmHandleTransitionPair);
103 return cmHandleTransitionPairs;
107 private void persistCmHandle(final YangModelCmHandle targetYangModelCmHandle,
108 final YangModelCmHandle currentYangModelCmHandle) {
109 if (isNew(currentYangModelCmHandle.getCompositeState())) {
110 log.debug("Registering a new cm handle {}", targetYangModelCmHandle.getId());
111 inventoryPersistence.saveCmHandle(targetYangModelCmHandle);
112 } else if (isDeleted(targetYangModelCmHandle.getCompositeState())) {
113 log.info("CmHandle with Id : {} is DELETED", targetYangModelCmHandle.getId());
115 inventoryPersistence.saveCmHandleState(targetYangModelCmHandle.getId(),
116 targetYangModelCmHandle.getCompositeState());
120 private void persistCmHandleBatch(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
122 final List<YangModelCmHandle> newCmHandles = new ArrayList<>();
123 final Map<String, CompositeState> compositeStatePerCmHandleId = new LinkedHashMap<>();
125 cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> {
126 if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState()
128 newCmHandles.add(cmHandleTransitionPair.getTargetYangModelCmHandle());
129 } else if (!isDeleted(cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
130 compositeStatePerCmHandleId.put(cmHandleTransitionPair.getTargetYangModelCmHandle().getId(),
131 cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState());
135 inventoryPersistence.saveCmHandleBatch(newCmHandles);
136 inventoryPersistence.saveCmHandleStateBatch(compositeStatePerCmHandleId);
140 private void updateToSpecifiedCmHandleState(final YangModelCmHandle yangModelCmHandle,
141 final CmHandleState targetCmHandleState) {
143 if (READY == targetCmHandleState) {
144 setInitialStates(yangModelCmHandle);
145 } else if (ADVISED == targetCmHandleState) {
146 if (yangModelCmHandle.getCompositeState() == null) {
147 registerNewCmHandle(yangModelCmHandle);
148 } else if (yangModelCmHandle.getCompositeState().getCmHandleState() == LOCKED) {
149 retryCmHandle(yangModelCmHandle);
152 setCmHandleState(yangModelCmHandle, targetCmHandleState);
156 private void setInitialStates(final YangModelCmHandle yangModelCmHandle) {
157 CompositeStateUtils.setInitialDataStoreSyncState().accept(yangModelCmHandle.getCompositeState());
158 CompositeStateUtils.setCompositeState(READY).accept(yangModelCmHandle.getCompositeState());
161 private void retryCmHandle(final YangModelCmHandle yangModelCmHandle) {
162 CompositeStateUtils.setCompositeStateForRetry().accept(yangModelCmHandle.getCompositeState());
165 private void registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
166 yangModelCmHandle.setCompositeState(new CompositeState());
167 setCmHandleState(yangModelCmHandle, ADVISED);
170 private void setCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState) {
171 CompositeStateUtils.setCompositeState(targetCmHandleState).accept(yangModelCmHandle.getCompositeState());
174 private boolean isNew(final CompositeState existingCompositeState) {
175 return (existingCompositeState == null);
178 private boolean isDeleted(final CompositeState targetCompositeState) {
179 return targetCompositeState.getCmHandleState() == DELETED;
182 private boolean isCompositeStateSame(final CompositeState compositeState, final CmHandleState targetCmHandleState) {
183 return (compositeState != null && compositeState.getCmHandleState() == targetCmHandleState);
186 private NcmpServiceCmHandle toNcmpServiceCmHandle(final YangModelCmHandle yangModelCmHandle) {
187 return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(yangModelCmHandle);
193 static class CmHandleTransitionPair {
195 private YangModelCmHandle currentYangModelCmHandle;
196 private YangModelCmHandle targetYangModelCmHandle;