cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/event/lcm/LcmEventsCmHandleStateHandler.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2022 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 java.util.Map;
  24 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  25 import org.onap.cps.ncmp.api.inventory.CmHandleState;
  26 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  27
  28 /**
  29  * The implementation of it should handle the persisting of composite state and delegate the request to publish the
  30  * corresponding lcm event.
  31  */
  32 public interface LcmEventsCmHandleStateHandler {
  33
  34     /**
  35      * Updates the composite state of cmHandle based on cmHandleState.
  36      *
  37      * @param yangModelCmHandle   cm handle represented as yang model
  38      * @param targetCmHandleState target cm handle state
  39      */
  40     void updateCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState);
  41
  42     /**
  43      * Updates the composite state of cmHandle based on cmHandleState in batch.
  44      *
  45      * @param cmHandleStatePerCmHandle Map of Yang Model Cm Handle and corresponding cm handle state.
  46      */
  47     void updateCmHandleStateBatch(final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle);
  48
  49     /**
  50      * Publish LCM Event.
  51      *
  52      * @param targetNcmpServiceCmHandle  target NcmpServiceCmHandle
  53      * @param currentNcmpServiceCmHandle current NcmpServiceCmHandle
  54      */
  55     void publishLcmEventAsynchronously(final NcmpServiceCmHandle targetNcmpServiceCmHandle,
  56             final NcmpServiceCmHandle currentNcmpServiceCmHandle);
  57
  58 }