cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/lcm/LcmEventsCmHandleStateHandlerImpl.java

   1 /*
   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
   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.api.impl.events.lcm;
  22
  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;
  27
  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;
  33 import java.util.Map;
  34 import lombok.Getter;
  35 import lombok.NoArgsConstructor;
  36 import lombok.RequiredArgsConstructor;
  37 import lombok.Setter;
  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;
  47
  48 @Slf4j
  49 @Service
  50 @RequiredArgsConstructor
  51 public class LcmEventsCmHandleStateHandlerImpl implements LcmEventsCmHandleStateHandler {
  52
  53     private final InventoryPersistence inventoryPersistence;
  54     private final LcmEventsCmHandleStateHandlerAsyncHelper lcmEventsCmHandleStateHandlerAsyncHelper;
  55
  56     @Override
  57     public void updateCmHandleState(final YangModelCmHandle updatedYangModelCmHandle,
  58             final CmHandleState targetCmHandleState) {
  59
  60         final CompositeState compositeState = updatedYangModelCmHandle.getCompositeState();
  61
  62         if (isCompositeStateSame(compositeState, targetCmHandleState)) {
  63             log.debug("CmHandle with id : {} already in state : {}", updatedYangModelCmHandle.getId(),
  64                     targetCmHandleState);
  65         } else {
  66             final YangModelCmHandle currentYangModelCmHandle = YangModelCmHandle.deepCopyOf(updatedYangModelCmHandle);
  67             updateToSpecifiedCmHandleState(updatedYangModelCmHandle, targetCmHandleState);
  68             persistCmHandle(updatedYangModelCmHandle, currentYangModelCmHandle);
  69             lcmEventsCmHandleStateHandlerAsyncHelper.publishLcmEventAsynchronously(
  70                     toNcmpServiceCmHandle(updatedYangModelCmHandle),
  71                     toNcmpServiceCmHandle(currentYangModelCmHandle));
  72         }
  73     }
  74
  75     @Override
  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);
  83     }
  84
  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) -> {
  89
  90             final CompositeState compositeState = yangModelCmHandle.getCompositeState();
  91
  92             if (isCompositeStateSame(compositeState, targetCmHandleState)) {
  93                 log.debug("CmHandle with id : {} already in state : {}", yangModelCmHandle.getId(),
  94                         targetCmHandleState);
  95             } else {
  96                 final CmHandleTransitionPair cmHandleTransitionPair = new CmHandleTransitionPair();
  97                 cmHandleTransitionPair.setCurrentYangModelCmHandle(YangModelCmHandle.deepCopyOf(yangModelCmHandle));
  98                 updateToSpecifiedCmHandleState(yangModelCmHandle, targetCmHandleState);
  99                 cmHandleTransitionPair.setTargetYangModelCmHandle(yangModelCmHandle);
 100                 cmHandleTransitionPairs.add(cmHandleTransitionPair);
 101             }
 102         });
 103
 104         return cmHandleTransitionPairs;
 105     }
 106
 107
 108     private void persistCmHandle(final YangModelCmHandle targetYangModelCmHandle,
 109             final YangModelCmHandle currentYangModelCmHandle) {
 110         if (isNew(currentYangModelCmHandle.getCompositeState(), targetYangModelCmHandle.getCompositeState())) {
 111             log.debug("Registering a new cm handle {}", targetYangModelCmHandle.getId());
 112             inventoryPersistence.saveCmHandle(targetYangModelCmHandle);
 113         } else if (isDeleted(targetYangModelCmHandle.getCompositeState())) {
 114             log.info("CmHandle with Id : {} is DELETED", targetYangModelCmHandle.getId());
 115         } else {
 116             inventoryPersistence.saveCmHandleState(targetYangModelCmHandle.getId(),
 117                     targetYangModelCmHandle.getCompositeState());
 118         }
 119     }
 120
 121     private void persistCmHandleBatch(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
 122
 123         final List<YangModelCmHandle> newCmHandles = new ArrayList<>();
 124         final Map<String, CompositeState> compositeStatePerCmHandleId = new LinkedHashMap<>();
 125
 126         cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> {
 127             if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState(),
 128                     cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
 129                 newCmHandles.add(cmHandleTransitionPair.getTargetYangModelCmHandle());
 130             } else if (!isDeleted(cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
 131                 compositeStatePerCmHandleId.put(cmHandleTransitionPair.getTargetYangModelCmHandle().getId(),
 132                         cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState());
 133             }
 134         });
 135
 136         inventoryPersistence.saveCmHandleBatch(newCmHandles);
 137         inventoryPersistence.saveCmHandleStateBatch(compositeStatePerCmHandleId);
 138
 139     }
 140
 141     private void updateToSpecifiedCmHandleState(final YangModelCmHandle yangModelCmHandle,
 142             final CmHandleState targetCmHandleState) {
 143
 144         if (READY == targetCmHandleState) {
 145             setInitialStates(yangModelCmHandle);
 146         } else if (ADVISED == targetCmHandleState) {
 147             if (yangModelCmHandle.getCompositeState() == null) {
 148                 registerNewCmHandle(yangModelCmHandle);
 149             } else if (yangModelCmHandle.getCompositeState().getCmHandleState() == LOCKED) {
 150                 retryCmHandle(yangModelCmHandle);
 151             }
 152         } else {
 153             setCmHandleState(yangModelCmHandle, targetCmHandleState);
 154         }
 155     }
 156
 157     private void setInitialStates(final YangModelCmHandle yangModelCmHandle) {
 158         CompositeStateUtils.setInitialDataStoreSyncState().accept(yangModelCmHandle.getCompositeState());
 159         CompositeStateUtils.setCompositeState(READY).accept(yangModelCmHandle.getCompositeState());
 160     }
 161
 162     private void retryCmHandle(final YangModelCmHandle yangModelCmHandle) {
 163         CompositeStateUtils.setCompositeStateForRetry().accept(yangModelCmHandle.getCompositeState());
 164     }
 165
 166     private void registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 167         yangModelCmHandle.setCompositeState(new CompositeState());
 168         setCmHandleState(yangModelCmHandle, ADVISED);
 169     }
 170
 171     private void setCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState) {
 172         CompositeStateUtils.setCompositeState(targetCmHandleState).accept(yangModelCmHandle.getCompositeState());
 173     }
 174
 175     private boolean isNew(final CompositeState existingCompositeState, final CompositeState targetCompositeState) {
 176         return (existingCompositeState == null && targetCompositeState.getCmHandleState() == ADVISED);
 177     }
 178
 179     private boolean isDeleted(final CompositeState targetCompositeState) {
 180         return targetCompositeState.getCmHandleState() == DELETED;
 181     }
 182
 183     private boolean isCompositeStateSame(final CompositeState compositeState, final CmHandleState targetCmHandleState) {
 184         return (compositeState != null && compositeState.getCmHandleState() == targetCmHandleState);
 185     }
 186
 187     private NcmpServiceCmHandle toNcmpServiceCmHandle(final YangModelCmHandle yangModelCmHandle) {
 188         return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(yangModelCmHandle);
 189     }
 190
 191     @Getter
 192     @Setter
 193     @NoArgsConstructor
 194     static class CmHandleTransitionPair {
 195
 196         private YangModelCmHandle currentYangModelCmHandle;
 197         private YangModelCmHandle targetYangModelCmHandle;
 198     }
 199 }