aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/inventory/CompositeStateUtils.java
blob: ef4b299e10195987c9b98438eeff548bc7b99855 (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
/*
 * ============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.inventory;

import java.util.function.Consumer;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

/**
 * It will have all the utility method responsible for handling the composite state.
 */
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class CompositeStateUtils {

    /**
     * Sets the cmHandleState to the provided state and updates the timestamp.
     *
     * @return Updated CompositeState
     */
    public static Consumer<CompositeState> setCompositeState(final CmHandleState cmHandleState) {
        return compositeState -> {
            compositeState.setCmHandleState(cmHandleState);
            compositeState.setLastUpdateTimeNow();
        };
    }

    /**
     * Set the Operational datastore sync state based on the global flag.
     *
     * @return Updated CompositeState
     */
    public static Consumer<CompositeState> setInitialDataStoreSyncState() {

        return compositeState -> {
            compositeState.setDataSyncEnabled(false);
            final CompositeState.Operational operational =
                    getInitialDataStoreSyncState(compositeState.getDataSyncEnabled());
            final CompositeState.DataStores dataStores =
                    CompositeState.DataStores.builder().operationalDataStore(operational).build();
            compositeState.setDataStores(dataStores);
        };
    }

    /**
     * Set the data sync enabled flag, along with the data store sync state based on this flag.
     *
     * @param dataSyncEnabled data sync enabled flag
     * @param compositeState  cm handle composite state
     */
    public static void setDataSyncEnabledFlagWithDataSyncState(final boolean dataSyncEnabled,
            final CompositeState compositeState) {
        compositeState.setDataSyncEnabled(dataSyncEnabled);
        compositeState.setLastUpdateTimeNow();
        final CompositeState.Operational operational = getInitialDataStoreSyncState(dataSyncEnabled);
        final CompositeState.DataStores dataStores =
                CompositeState.DataStores.builder().operationalDataStore(operational).build();
        compositeState.setDataStores(dataStores);
    }

    /**
     * Get initial data sync state based on data sync enabled boolean flag.
     *
     * @param dataSyncEnabled data sync enabled boolean flag
     * @return the data store sync state
     */
    private static CompositeState.Operational getInitialDataStoreSyncState(final boolean dataSyncEnabled) {
        final DataStoreSyncState dataStoreSyncState =
                dataSyncEnabled ? DataStoreSyncState.UNSYNCHRONIZED : DataStoreSyncState.NONE_REQUESTED;
        return CompositeState.Operational.builder().dataStoreSyncState(dataStoreSyncState).build();
    }

    /**
     * Sets the cmHandleState to ADVISED and retain the lock details. Used in retry scenarios.
     *
     * @return Updated CompositeState
     */
    public static Consumer<CompositeState> setCompositeStateForRetry() {
        return compositeState -> {
            compositeState.setCmHandleState(CmHandleState.ADVISED);
            compositeState.setLastUpdateTimeNow();
            final String oldLockReasonDetails = compositeState.getLockReason().getDetails();
            final CompositeState.LockReason lockReason =
                    CompositeState.LockReason.builder().details(oldLockReasonDetails).build();
            compositeState.setLockReason(lockReason);
        };
    }
}