cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/event/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.event.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.onap.ncmp.cmhandle.event.lcm.LcmEvent;
  47 import org.springframework.scheduling.annotation.Async;
  48 import org.springframework.stereotype.Service;
  49
  50 @Slf4j
  51 @Service
  52 @RequiredArgsConstructor
  53 public class LcmEventsCmHandleStateHandlerImpl implements LcmEventsCmHandleStateHandler {
  54
  55     private final InventoryPersistence inventoryPersistence;
  56     private final LcmEventsCreator lcmEventsCreator;
  57     private final LcmEventsService lcmEventsService;
  58
  59     @Override
  60     public void updateCmHandleState(final YangModelCmHandle updatedYangModelCmHandle,
  61             final CmHandleState targetCmHandleState) {
  62
  63         final CompositeState compositeState = updatedYangModelCmHandle.getCompositeState();
  64
  65         if (isCompositeStateSame(compositeState, targetCmHandleState)) {
  66             log.debug("CmHandle with id : {} already in state : {}", updatedYangModelCmHandle.getId(),
  67                     targetCmHandleState);
  68         } else {
  69             final YangModelCmHandle currentYangModelCmHandle = YangModelCmHandle.deepCopyOf(updatedYangModelCmHandle);
  70             updateToSpecifiedCmHandleState(updatedYangModelCmHandle, targetCmHandleState);
  71             persistCmHandle(updatedYangModelCmHandle, currentYangModelCmHandle);
  72             publishLcmEventAsynchronously(toNcmpServiceCmHandle(updatedYangModelCmHandle),
  73                     toNcmpServiceCmHandle(currentYangModelCmHandle));
  74         }
  75     }
  76
  77     @Override
  78     @Timed(value = "cps.ncmp.cmhandle.state.update.batch",
  79         description = "Time taken to update a batch of cm handle states")
  80     public void updateCmHandleStateBatch(final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
  81         final Collection<CmHandleTransitionPair> cmHandleTransitionPairs =
  82                 prepareCmHandleTransitionBatch(cmHandleStatePerCmHandle);
  83         persistCmHandleBatch(cmHandleTransitionPairs);
  84         publishLcmEventBatchAsynchronously(cmHandleTransitionPairs);
  85     }
  86
  87     @Async("notificationExecutor")
  88     @Override
  89     public void publishLcmEventAsynchronously(final NcmpServiceCmHandle targetNcmpServiceCmHandle,
  90             final NcmpServiceCmHandle currentNcmpServiceCmHandle) {
  91         publishLcmEvent(targetNcmpServiceCmHandle, currentNcmpServiceCmHandle);
  92     }
  93
  94     /**
  95      * Publish LcmEvent in batches and in asynchronous manner.
  96      *
  97      * @param cmHandleTransitionPairs Pair of existing and modified cm handle represented as YangModelCmHandle
  98      */
  99     @Async("notificationExecutor")
 100     public void publishLcmEventBatchAsynchronously(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
 101         cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> publishLcmEvent(
 102                 toNcmpServiceCmHandle(cmHandleTransitionPair.getTargetYangModelCmHandle()),
 103                 toNcmpServiceCmHandle(cmHandleTransitionPair.getCurrentYangModelCmHandle())));
 104     }
 105
 106     private void publishLcmEvent(final NcmpServiceCmHandle targetNcmpServiceCmHandle,
 107             final NcmpServiceCmHandle existingNcmpServiceCmHandle) {
 108         final String cmHandleId = targetNcmpServiceCmHandle.getCmHandleId();
 109         final LcmEvent lcmEvent =
 110                 lcmEventsCreator.populateLcmEvent(cmHandleId, targetNcmpServiceCmHandle, existingNcmpServiceCmHandle);
 111         lcmEventsService.publishLcmEvent(cmHandleId, lcmEvent);
 112     }
 113
 114     private Collection<CmHandleTransitionPair> prepareCmHandleTransitionBatch(
 115             final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
 116         final List<CmHandleTransitionPair> cmHandleTransitionPairs = new ArrayList<>(cmHandleStatePerCmHandle.size());
 117         cmHandleStatePerCmHandle.forEach((yangModelCmHandle, targetCmHandleState) -> {
 118
 119             final CompositeState compositeState = yangModelCmHandle.getCompositeState();
 120
 121             if (isCompositeStateSame(compositeState, targetCmHandleState)) {
 122                 log.debug("CmHandle with id : {} already in state : {}", yangModelCmHandle.getId(),
 123                         targetCmHandleState);
 124             } else {
 125                 final CmHandleTransitionPair cmHandleTransitionPair = new CmHandleTransitionPair();
 126                 cmHandleTransitionPair.setCurrentYangModelCmHandle(YangModelCmHandle.deepCopyOf(yangModelCmHandle));
 127                 updateToSpecifiedCmHandleState(yangModelCmHandle, targetCmHandleState);
 128                 cmHandleTransitionPair.setTargetYangModelCmHandle(yangModelCmHandle);
 129                 cmHandleTransitionPairs.add(cmHandleTransitionPair);
 130             }
 131         });
 132
 133         return cmHandleTransitionPairs;
 134     }
 135
 136
 137     private void persistCmHandle(final YangModelCmHandle targetYangModelCmHandle,
 138             final YangModelCmHandle currentYangModelCmHandle) {
 139         if (isNew(currentYangModelCmHandle.getCompositeState(), targetYangModelCmHandle.getCompositeState())) {
 140             log.debug("Registering a new cm handle {}", targetYangModelCmHandle.getId());
 141             inventoryPersistence.saveCmHandle(targetYangModelCmHandle);
 142         } else if (isDeleted(targetYangModelCmHandle.getCompositeState())) {
 143             log.info("CmHandle with Id : {} is DELETED", targetYangModelCmHandle.getId());
 144         } else {
 145             inventoryPersistence.saveCmHandleState(targetYangModelCmHandle.getId(),
 146                     targetYangModelCmHandle.getCompositeState());
 147         }
 148     }
 149
 150     private void persistCmHandleBatch(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
 151
 152         final List<YangModelCmHandle> newCmHandles = new ArrayList<>();
 153         final Map<String, CompositeState> compositeStatePerCmHandleId = new LinkedHashMap<>();
 154
 155         cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> {
 156             if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState(),
 157                     cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
 158                 newCmHandles.add(cmHandleTransitionPair.getTargetYangModelCmHandle());
 159             } else if (!isDeleted(cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
 160                 compositeStatePerCmHandleId.put(cmHandleTransitionPair.getTargetYangModelCmHandle().getId(),
 161                         cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState());
 162             }
 163         });
 164
 165         inventoryPersistence.saveCmHandleBatch(newCmHandles);
 166         inventoryPersistence.saveCmHandleStateBatch(compositeStatePerCmHandleId);
 167
 168     }
 169
 170     private void updateToSpecifiedCmHandleState(final YangModelCmHandle yangModelCmHandle,
 171             final CmHandleState targetCmHandleState) {
 172
 173         if (READY == targetCmHandleState) {
 174             setInitialStates(yangModelCmHandle);
 175         } else if (ADVISED == targetCmHandleState) {
 176             if (yangModelCmHandle.getCompositeState() == null) {
 177                 registerNewCmHandle(yangModelCmHandle);
 178             } else if (yangModelCmHandle.getCompositeState().getCmHandleState() == LOCKED) {
 179                 retryCmHandle(yangModelCmHandle);
 180             }
 181         } else {
 182             setCmHandleState(yangModelCmHandle, targetCmHandleState);
 183         }
 184     }
 185
 186     private void setInitialStates(final YangModelCmHandle yangModelCmHandle) {
 187         CompositeStateUtils.setInitialDataStoreSyncState().accept(yangModelCmHandle.getCompositeState());
 188         CompositeStateUtils.setCompositeState(READY).accept(yangModelCmHandle.getCompositeState());
 189     }
 190
 191     private void retryCmHandle(final YangModelCmHandle yangModelCmHandle) {
 192         CompositeStateUtils.setCompositeStateForRetry().accept(yangModelCmHandle.getCompositeState());
 193     }
 194
 195     private void registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
 196         yangModelCmHandle.setCompositeState(new CompositeState());
 197         setCmHandleState(yangModelCmHandle, ADVISED);
 198     }
 199
 200     private void setCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState) {
 201         CompositeStateUtils.setCompositeState(targetCmHandleState).accept(yangModelCmHandle.getCompositeState());
 202     }
 203
 204     private boolean isNew(final CompositeState existingCompositeState, final CompositeState targetCompositeState) {
 205         return (existingCompositeState == null && targetCompositeState.getCmHandleState() == ADVISED);
 206     }
 207
 208     private boolean isDeleted(final CompositeState targetCompositeState) {
 209         return targetCompositeState.getCmHandleState() == DELETED;
 210     }
 211
 212     private boolean isCompositeStateSame(final CompositeState compositeState, final CmHandleState targetCmHandleState) {
 213         return (compositeState != null && compositeState.getCmHandleState() == targetCmHandleState);
 214     }
 215
 216     private NcmpServiceCmHandle toNcmpServiceCmHandle(final YangModelCmHandle yangModelCmHandle) {
 217         return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(yangModelCmHandle);
 218     }
 219
 220     @Getter
 221     @Setter
 222     @NoArgsConstructor
 223     static class CmHandleTransitionPair {
 224         private YangModelCmHandle currentYangModelCmHandle;
 225         private YangModelCmHandle targetYangModelCmHandle;
 226     }
 227 }