summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/lcm/LcmEventsCmHandleStateHandlerImpl.java
blob: f42cd39d4df9dba3593c2892dfe8f75a03eda373 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*
 * ============LICENSE_START=======================================================
 * Copyright (C) 2022-2023 Nordix Foundation
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.cps.ncmp.api.impl.events.lcm;

import static org.onap.cps.ncmp.api.inventory.CmHandleState.ADVISED;
import static org.onap.cps.ncmp.api.inventory.CmHandleState.DELETED;
import static org.onap.cps.ncmp.api.inventory.CmHandleState.LOCKED;
import static org.onap.cps.ncmp.api.inventory.CmHandleState.READY;

import io.micrometer.core.annotation.Timed;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
import org.onap.cps.ncmp.api.inventory.CmHandleState;
import org.onap.cps.ncmp.api.inventory.CompositeState;
import org.onap.cps.ncmp.api.inventory.CompositeStateUtils;
import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
import org.onap.cps.ncmp.events.lcm.v1.LcmEvent;
import org.onap.cps.ncmp.events.lcm.v1.LcmEventHeader;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

@Slf4j
@Service
@RequiredArgsConstructor
public class LcmEventsCmHandleStateHandlerImpl implements LcmEventsCmHandleStateHandler {

    private final InventoryPersistence inventoryPersistence;
    private final LcmEventsCreator lcmEventsCreator;
    private final LcmEventsService lcmEventsService;

    @Override
    public void updateCmHandleState(final YangModelCmHandle updatedYangModelCmHandle,
            final CmHandleState targetCmHandleState) {

        final CompositeState compositeState = updatedYangModelCmHandle.getCompositeState();

        if (isCompositeStateSame(compositeState, targetCmHandleState)) {
            log.debug("CmHandle with id : {} already in state : {}", updatedYangModelCmHandle.getId(),
                    targetCmHandleState);
        } else {
            final YangModelCmHandle currentYangModelCmHandle = YangModelCmHandle.deepCopyOf(updatedYangModelCmHandle);
            updateToSpecifiedCmHandleState(updatedYangModelCmHandle, targetCmHandleState);
            persistCmHandle(updatedYangModelCmHandle, currentYangModelCmHandle);
            publishLcmEventAsynchronously(toNcmpServiceCmHandle(updatedYangModelCmHandle),
                    toNcmpServiceCmHandle(currentYangModelCmHandle));
        }
    }

    @Override
    @Timed(value = "cps.ncmp.cmhandle.state.update.batch",
            description = "Time taken to update a batch of cm handle states")
    public void updateCmHandleStateBatch(final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
        final Collection<CmHandleTransitionPair> cmHandleTransitionPairs =
                prepareCmHandleTransitionBatch(cmHandleStatePerCmHandle);
        persistCmHandleBatch(cmHandleTransitionPairs);
        publishLcmEventBatchAsynchronously(cmHandleTransitionPairs);
    }

    @Async("notificationExecutor")
    @Override
    public void publishLcmEventAsynchronously(final NcmpServiceCmHandle targetNcmpServiceCmHandle,
            final NcmpServiceCmHandle currentNcmpServiceCmHandle) {
        publishLcmEvent(targetNcmpServiceCmHandle, currentNcmpServiceCmHandle);
    }

    /**
     * Publish LcmEvent in batches and in asynchronous manner.
     *
     * @param cmHandleTransitionPairs Pair of existing and modified cm handle represented as YangModelCmHandle
     */
    @Async("notificationExecutor")
    public void publishLcmEventBatchAsynchronously(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {
        cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> publishLcmEvent(
                toNcmpServiceCmHandle(cmHandleTransitionPair.getTargetYangModelCmHandle()),
                toNcmpServiceCmHandle(cmHandleTransitionPair.getCurrentYangModelCmHandle())));
    }

    private void publishLcmEvent(final NcmpServiceCmHandle targetNcmpServiceCmHandle,
            final NcmpServiceCmHandle existingNcmpServiceCmHandle) {
        final String cmHandleId = targetNcmpServiceCmHandle.getCmHandleId();
        final LcmEventHeader lcmEventHeader =
                lcmEventsCreator.populateLcmEventHeader(cmHandleId, targetNcmpServiceCmHandle,
                        existingNcmpServiceCmHandle);
        final LcmEvent lcmEvent =
                lcmEventsCreator.populateLcmEvent(cmHandleId, targetNcmpServiceCmHandle, existingNcmpServiceCmHandle);
        lcmEventsService.publishLcmEvent(cmHandleId, lcmEvent, lcmEventHeader);
    }

    private Collection<CmHandleTransitionPair> prepareCmHandleTransitionBatch(
            final Map<YangModelCmHandle, CmHandleState> cmHandleStatePerCmHandle) {
        final List<CmHandleTransitionPair> cmHandleTransitionPairs = new ArrayList<>(cmHandleStatePerCmHandle.size());
        cmHandleStatePerCmHandle.forEach((yangModelCmHandle, targetCmHandleState) -> {

            final CompositeState compositeState = yangModelCmHandle.getCompositeState();

            if (isCompositeStateSame(compositeState, targetCmHandleState)) {
                log.debug("CmHandle with id : {} already in state : {}", yangModelCmHandle.getId(),
                        targetCmHandleState);
            } else {
                final CmHandleTransitionPair cmHandleTransitionPair = new CmHandleTransitionPair();
                cmHandleTransitionPair.setCurrentYangModelCmHandle(YangModelCmHandle.deepCopyOf(yangModelCmHandle));
                updateToSpecifiedCmHandleState(yangModelCmHandle, targetCmHandleState);
                cmHandleTransitionPair.setTargetYangModelCmHandle(yangModelCmHandle);
                cmHandleTransitionPairs.add(cmHandleTransitionPair);
            }
        });

        return cmHandleTransitionPairs;
    }


    private void persistCmHandle(final YangModelCmHandle targetYangModelCmHandle,
            final YangModelCmHandle currentYangModelCmHandle) {
        if (isNew(currentYangModelCmHandle.getCompositeState(), targetYangModelCmHandle.getCompositeState())) {
            log.debug("Registering a new cm handle {}", targetYangModelCmHandle.getId());
            inventoryPersistence.saveCmHandle(targetYangModelCmHandle);
        } else if (isDeleted(targetYangModelCmHandle.getCompositeState())) {
            log.info("CmHandle with Id : {} is DELETED", targetYangModelCmHandle.getId());
        } else {
            inventoryPersistence.saveCmHandleState(targetYangModelCmHandle.getId(),
                    targetYangModelCmHandle.getCompositeState());
        }
    }

    private void persistCmHandleBatch(final Collection<CmHandleTransitionPair> cmHandleTransitionPairs) {

        final List<YangModelCmHandle> newCmHandles = new ArrayList<>();
        final Map<String, CompositeState> compositeStatePerCmHandleId = new LinkedHashMap<>();

        cmHandleTransitionPairs.forEach(cmHandleTransitionPair -> {
            if (isNew(cmHandleTransitionPair.getCurrentYangModelCmHandle().getCompositeState(),
                    cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
                newCmHandles.add(cmHandleTransitionPair.getTargetYangModelCmHandle());
            } else if (!isDeleted(cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState())) {
                compositeStatePerCmHandleId.put(cmHandleTransitionPair.getTargetYangModelCmHandle().getId(),
                        cmHandleTransitionPair.getTargetYangModelCmHandle().getCompositeState());
            }
        });

        inventoryPersistence.saveCmHandleBatch(newCmHandles);
        inventoryPersistence.saveCmHandleStateBatch(compositeStatePerCmHandleId);

    }

    private void updateToSpecifiedCmHandleState(final YangModelCmHandle yangModelCmHandle,
            final CmHandleState targetCmHandleState) {

        if (READY == targetCmHandleState) {
            setInitialStates(yangModelCmHandle);
        } else if (ADVISED == targetCmHandleState) {
            if (yangModelCmHandle.getCompositeState() == null) {
                registerNewCmHandle(yangModelCmHandle);
            } else if (yangModelCmHandle.getCompositeState().getCmHandleState() == LOCKED) {
                retryCmHandle(yangModelCmHandle);
            }
        } else {
            setCmHandleState(yangModelCmHandle, targetCmHandleState);
        }
    }

    private void setInitialStates(final YangModelCmHandle yangModelCmHandle) {
        CompositeStateUtils.setInitialDataStoreSyncState().accept(yangModelCmHandle.getCompositeState());
        CompositeStateUtils.setCompositeState(READY).accept(yangModelCmHandle.getCompositeState());
    }

    private void retryCmHandle(final YangModelCmHandle yangModelCmHandle) {
        CompositeStateUtils.setCompositeStateForRetry().accept(yangModelCmHandle.getCompositeState());
    }

    private void registerNewCmHandle(final YangModelCmHandle yangModelCmHandle) {
        yangModelCmHandle.setCompositeState(new CompositeState());
        setCmHandleState(yangModelCmHandle, ADVISED);
    }

    private void setCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState) {
        CompositeStateUtils.setCompositeState(targetCmHandleState).accept(yangModelCmHandle.getCompositeState());
    }

    private boolean isNew(final CompositeState existingCompositeState, final CompositeState targetCompositeState) {
        return (existingCompositeState == null && targetCompositeState.getCmHandleState() == ADVISED);
    }

    private boolean isDeleted(final CompositeState targetCompositeState) {
        return targetCompositeState.getCmHandleState() == DELETED;
    }

    private boolean isCompositeStateSame(final CompositeState compositeState, final CmHandleState targetCmHandleState) {
        return (compositeState != null && compositeState.getCmHandleState() == targetCmHandleState);
    }

    private NcmpServiceCmHandle toNcmpServiceCmHandle(final YangModelCmHandle yangModelCmHandle) {
        return YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle(yangModelCmHandle);
    }

    @Getter
    @Setter
    @NoArgsConstructor
    static class CmHandleTransitionPair {

        private YangModelCmHandle currentYangModelCmHandle;
        private YangModelCmHandle targetYangModelCmHandle;
    }
}