gerrit.onap Code Review - cps.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2022-2024 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.impl.inventory.models.CmHandleState.ADVISED;
  24 import static org.onap.cps.ncmp.impl.inventory.models.CmHandleState.DELETED;
  25 import static org.onap.cps.ncmp.impl.inventory.models.CmHandleState.LOCKED;
  26 import static org.onap.cps.ncmp.impl.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.CompositeState;
  41 import org.onap.cps.ncmp.impl.inventory.CompositeStateUtils;
  42 import org.onap.cps.ncmp.impl.inventory.InventoryPersistence;
  43 import org.onap.cps.ncmp.impl.inventory.models.CmHandleState;
  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
  55     @Override
  56     @Timed(value = "cps.ncmp.cmhandle.state.update.batch",
  57             description = "Time taken to update a batch of cm handle states")
  58     public void updateCmHandleStateBatch(final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
  59         final Collection<CmHandleTransitionPair> cmHandleTransitionPairs =
  60                 prepareCmHandleTransitionBatch(cmHandleStatePerCmHandle);
  61         persistCmHandleBatch(cmHandleTransitionPairs);
  62         lcmEventsCmHandleStateHandlerAsyncHelper.publishLcmEventBatchAsynchronously(cmHandleTransitionPairs);
  63     }
  64
  65     @Override
  66     public void initiateStateAdvised(final Collection<YangModelCmHandle> yangModelCmHandles) {
  67         final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle = new HashMap<>(yangModelCmHandles.size());
  68         for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandles) {
  69             cmHandleStatePerCmHandle.put(yangModelCmHandle, ADVISED);
  70         }
  71         updateCmHandleStateBatch(cmHandleStatePerCmHandle);
  72     }
  73
  74     private Collection<CmHandleTransitionPair> prepareCmHandleTransitionBatch(
  75             final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
  76         final List<CmHandleTransitionPair> cmHandleTransitionPairs = new ArrayList<>(cmHandleStatePerCmHandle.size());
  77         cmHandleStatePerCmHandle.forEach((yangModelCmHandle, targetCmHandleState) -> {
  78
  79             final CompositeState compositeState = yangModelCmHandle.getCompositeState();
  80
  81             if (isCompositeStateSame(compositeState, targetCmHandleState)) {
  82                 log.debug("CmHandle with id : {} already in state : {}", yangModelCmHandle.getId(),
  83                         targetCmHandleState);
  84             } else {
  85                 final CmHandleTransitionPair cmHandleTransitionPair = new CmHandleTransitionPair();
  86                 cmHandleTransitionPair.setCurrentYangModelCmHandle(YangModelCmHandle.deepCopyOf(yangModelCmHandle));
  87                 updateToSpecifiedCmHandleState(yangModelCmHandle, targetCmHandleState);
  88                 cmHandleTransitionPair.setTargetYangModelCmHandle(yangModelCmHandle);
  89                 cmHandleTransitionPairs.add(cmHandleTransitionPair);
  90             }
  91         });
  92         return cmHandleTransitionPairs;
  93     }
  94
  95     private void persistCmHandleBatch(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
  96
  97         final List<YangModelCmHandle> newCmHandles = new ArrayList<>();
  98         final Map<String, CompositeState> compositeStatePerCmHandleId = new LinkedHashMap<>();
  99
 100         cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> {
 101             if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState())) {
 102                 newCmHandles.add(cmHandleTransitionPair.getTargetYangModelCmHandle());
 103             } else if (!isDeleted(cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
 104                 compositeStatePerCmHandleId.put(cmHandleTransitionPair.getTargetYangModelCmHandle().getId(),
 105                         cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState());
 106             }
 107         });
 108
 109         inventoryPersistence.saveCmHandleBatch(newCmHandles);
 110         inventoryPersistence.saveCmHandleStateBatch(compositeStatePerCmHandleId);
 111
 112         logCmHandleStateChanges(cmHandleTransitionPairs);
 113     }
 114
 115     private void updateToSpecifiedCmHandleState(final YangModelCmHandle yangModelCmHandle,
 116                                                 final CmHandleState targetCmHandleState) {
 117
 118         if (READY == targetCmHandleState) {
 119             setInitialStates(yangModelCmHandle);
 120         } else if (ADVISED == targetCmHandleState) {
 121             if (yangModelCmHandle.getCompositeState() == null) {
 122                 registerNewCmHandle(yangModelCmHandle);
 123             } else if (yangModelCmHandle.getCompositeState().getCmHandleState() == LOCKED) {
 124                 retryCmHandle(yangModelCmHandle);
 125             }
 126         } else {
 127             setCmHandleState(yangModelCmHandle, targetCmHandleState);
 128         }
 129     }
 130
 131     private void setInitialStates(final YangModelCmHandle yangModelCmHandle) {
 132         CompositeStateUtils.setInitialDataStoreSyncState(yangModelCmHandle.getCompositeState());
 133         CompositeStateUtils.setCompositeState(READY, yangModelCmHandle.getCompositeState());
 134     }
 135
 136     private void retryCmHandle(final YangModelCmHandle yangModelCmHandle) {
 137         CompositeStateUtils.setCompositeStateForRetry(yangModelCmHandle.getCompositeState());
 138     }
 139
 140     private void registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 141         yangModelCmHandle.setCompositeState(new CompositeState());
 142         setCmHandleState(yangModelCmHandle, ADVISED);
 143     }
 144
 145     private void setCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState) {
 146         CompositeStateUtils.setCompositeState(targetCmHandleState, yangModelCmHandle.getCompositeState());
 147     }
 148
 149     private boolean isNew(final CompositeState existingCompositeState) {
 150         return (existingCompositeState == null);
 151     }
 152
 153     private boolean isDeleted(final CompositeState targetCompositeState) {
 154         return targetCompositeState.getCmHandleState() == DELETED;
 155     }
 156
 157     private boolean isCompositeStateSame(final CompositeState compositeState, final CmHandleState targetCmHandleState) {
 158         return (compositeState != null && compositeState.getCmHandleState() == targetCmHandleState);
 159     }
 160
 161     private static void logCmHandleStateChanges(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
 162         cmHandleTransitionPairs.stream()
 163                 .map(CmHandleTransitionPair::getTargetYangModelCmHandle)
 164                 .forEach(yangModelCmHandle -> log.info("{} is now in {} state", yangModelCmHandle.getId(),
 165                         yangModelCmHandle.getCompositeState().getCmHandleState().name()));
 166     }
 167
 168     @Getter
 169     @Setter
 170     @NoArgsConstructor
 171     static class CmHandleTransitionPair {
 172
 173         private YangModelCmHandle currentYangModelCmHandle;
 174         private YangModelCmHandle targetYangModelCmHandle;
 175     }
 176 }