gerrit.onap Code Review - cps.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2022-2025 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
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.impl.inventory.sync.lcm;
  22
  23 import static org.onap.cps.ncmp.api.inventory.models.CmHandleState.ADVISED;
  24 import static org.onap.cps.ncmp.api.inventory.models.CmHandleState.DELETED;
  25 import static org.onap.cps.ncmp.api.inventory.models.CmHandleState.LOCKED;
  26 import static org.onap.cps.ncmp.api.inventory.models.CmHandleState.READY;
  27
  28 import io.micrometer.core.annotation.Timed;
  29 import java.util.ArrayList;
  30 import java.util.Collection;
  31 import java.util.HashMap;
  32 import java.util.LinkedHashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import lombok.Getter;
  36 import lombok.NoArgsConstructor;
  37 import lombok.RequiredArgsConstructor;
  38 import lombok.Setter;
  39 import lombok.extern.slf4j.Slf4j;
  40 import org.onap.cps.ncmp.api.inventory.models.CmHandleState;
  41 import org.onap.cps.ncmp.api.inventory.models.CompositeState;
  42 import org.onap.cps.ncmp.impl.inventory.CompositeStateUtils;
  43 import org.onap.cps.ncmp.impl.inventory.InventoryPersistence;
  44 import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle;
  45 import org.springframework.stereotype.Service;
  46
  47 @Slf4j
  48 @Service
  49 @RequiredArgsConstructor
  50 public class LcmEventsCmHandleStateHandlerImpl implements LcmEventsCmHandleStateHandler {
  51
  52     private final InventoryPersistence inventoryPersistence;
  53     private final LcmEventsCmHandleStateHandlerAsyncHelper lcmEventsCmHandleStateHandlerAsyncHelper;
  54     private final CmHandleStateMonitor cmHandleStateMonitor;
  55
  56     @Override
  57     @Timed(value = "cps.ncmp.cmhandle.state.update.batch",
  58             description = "Time taken to update a batch of cm handle states")
  59     public void updateCmHandleStateBatch(final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
  60         final Collection<CmHandleTransitionPair> cmHandleTransitionPairs =
  61                 prepareCmHandleTransitionBatch(cmHandleStatePerCmHandle);
  62         persistCmHandleBatch(cmHandleTransitionPairs);
  63         lcmEventsCmHandleStateHandlerAsyncHelper.publishLcmEventBatchAsynchronously(cmHandleTransitionPairs);
  64         cmHandleStateMonitor.updateCmHandleStateMetrics(cmHandleTransitionPairs);
  65     }
  66
  67     @Override
  68     public void initiateStateAdvised(final Collection<YangModelCmHandle> yangModelCmHandles) {
  69         final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle = new HashMap<>(yangModelCmHandles.size());
  70         for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandles) {
  71             cmHandleStatePerCmHandle.put(yangModelCmHandle, ADVISED);
  72         }
  73         updateCmHandleStateBatch(cmHandleStatePerCmHandle);
  74     }
  75
  76     private Collection<CmHandleTransitionPair> prepareCmHandleTransitionBatch(
  77             final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
  78         final List<CmHandleTransitionPair> cmHandleTransitionPairs = new ArrayList<>(cmHandleStatePerCmHandle.size());
  79         cmHandleStatePerCmHandle.forEach((yangModelCmHandle, targetCmHandleState) -> {
  80
  81             final CompositeState compositeState = yangModelCmHandle.getCompositeState();
  82
  83             if (isCompositeStateSame(compositeState, targetCmHandleState)) {
  84                 log.debug("CmHandle with id : {} already in state : {}", yangModelCmHandle.getId(),
  85                         targetCmHandleState);
  86             } else {
  87                 final CmHandleTransitionPair cmHandleTransitionPair = new CmHandleTransitionPair();
  88                 cmHandleTransitionPair.setCurrentYangModelCmHandle(YangModelCmHandle.deepCopyOf(yangModelCmHandle));
  89                 updateToSpecifiedCmHandleState(yangModelCmHandle, targetCmHandleState);
  90                 cmHandleTransitionPair.setTargetYangModelCmHandle(yangModelCmHandle);
  91                 cmHandleTransitionPairs.add(cmHandleTransitionPair);
  92             }
  93         });
  94         return cmHandleTransitionPairs;
  95     }
  96
  97     private void persistCmHandleBatch(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
  98
  99         final List<YangModelCmHandle> newCmHandles = new ArrayList<>();
 100         final Map<String, CompositeState> compositeStatePerCmHandleId = new LinkedHashMap<>();
 101
 102         cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> {
 103             if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState())) {
 104                 newCmHandles.add(cmHandleTransitionPair.getTargetYangModelCmHandle());
 105             } else if (!isDeleted(cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
 106                 compositeStatePerCmHandleId.put(cmHandleTransitionPair.getTargetYangModelCmHandle().getId(),
 107                         cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState());
 108             }
 109         });
 110
 111         inventoryPersistence.saveCmHandleBatch(newCmHandles);
 112         inventoryPersistence.saveCmHandleStateBatch(compositeStatePerCmHandleId);
 113
 114         logCmHandleStateChanges(cmHandleTransitionPairs);
 115     }
 116
 117     private void updateToSpecifiedCmHandleState(final YangModelCmHandle yangModelCmHandle,
 118                                                 final CmHandleState targetCmHandleState) {
 119
 120         if (READY == targetCmHandleState) {
 121             setInitialStates(yangModelCmHandle);
 122         } else if (ADVISED == targetCmHandleState) {
 123             if (yangModelCmHandle.getCompositeState() == null) {
 124                 registerNewCmHandle(yangModelCmHandle);
 125             } else if (yangModelCmHandle.getCompositeState().getCmHandleState() == LOCKED) {
 126                 retryCmHandle(yangModelCmHandle);
 127             }
 128         } else {
 129             setCmHandleState(yangModelCmHandle, targetCmHandleState);
 130         }
 131     }
 132
 133     private void setInitialStates(final YangModelCmHandle yangModelCmHandle) {
 134         CompositeStateUtils.setInitialDataStoreSyncState(yangModelCmHandle.getCompositeState());
 135         CompositeStateUtils.setCompositeState(READY, yangModelCmHandle.getCompositeState());
 136     }
 137
 138     private void retryCmHandle(final YangModelCmHandle yangModelCmHandle) {
 139         CompositeStateUtils.setCompositeStateForRetry(yangModelCmHandle.getCompositeState());
 140     }
 141
 142     private void registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 143         yangModelCmHandle.setCompositeState(new CompositeState());
 144         setCmHandleState(yangModelCmHandle, ADVISED);
 145     }
 146
 147     private void setCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState) {
 148         CompositeStateUtils.setCompositeState(targetCmHandleState, yangModelCmHandle.getCompositeState());
 149     }
 150
 151     private boolean isNew(final CompositeState existingCompositeState) {
 152         return (existingCompositeState == null);
 153     }
 154
 155     private boolean isDeleted(final CompositeState targetCompositeState) {
 156         return targetCompositeState.getCmHandleState() == DELETED;
 157     }
 158
 159     private boolean isCompositeStateSame(final CompositeState compositeState, final CmHandleState targetCmHandleState) {
 160         return (compositeState != null && compositeState.getCmHandleState() == targetCmHandleState);
 161     }
 162
 163     private static void logCmHandleStateChanges(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
 164         cmHandleTransitionPairs.stream()
 165                 .map(CmHandleTransitionPair::getTargetYangModelCmHandle)
 166                 .forEach(yangModelCmHandle -> log.info("{} is now in {} state", yangModelCmHandle.getId(),
 167                         yangModelCmHandle.getCompositeState().getCmHandleState().name()));
 168     }
 169
 170     @Getter
 171     @Setter
 172     @NoArgsConstructor
 173     public static class CmHandleTransitionPair {
 174
 175         private YangModelCmHandle currentYangModelCmHandle;
 176         private YangModelCmHandle targetYangModelCmHandle;
 177     }
 178 }