aboutsummaryrefslogtreecommitdiffstats
path: root/bpmn/MSOCommonBPMN/src/main/java/org/onap/so/client/cds/GeneratePayloadForCds.java
blob: 12d5d06b53b930edde1fdf311cd95a664c610b1e (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 2019 Bell Canada
 * ================================================================================
 * Modifications Copyright (c) 2020 Nordix
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.so.client.cds;

import org.camunda.bpm.engine.delegate.DelegateExecution;
import org.onap.so.bpmn.common.BuildingBlockExecution;
import org.onap.so.bpmn.servicedecomposition.entities.BuildingBlock;
import org.onap.so.bpmn.servicedecomposition.entities.ExecuteBuildingBlock;
import org.onap.so.bpmn.servicedecomposition.tasks.ExtractPojosForBB;
import org.onap.so.client.cds.beans.AbstractCDSPropertiesBean;
import org.onap.so.client.exception.PayloadGenerationException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.UUID;

@Component
public class GeneratePayloadForCds {

    private static final String ORIGINATOR_ID = "SO";
    private static final String BUILDING_BLOCK = "buildingBlock";
    private static final String DEFAULT_SYNC_MODE = "sync";
    private static final String MSO_REQUEST_ID = "msoRequestId";

    @Autowired
    private VnfCDSRequestProvider vnfCDSRequestProvider;

    @Autowired
    private VfModuleCDSRequestProvider vfModuleCDSRequestProvider;

    @Autowired
    private ServiceCDSRequestProvider serviceCDSRequestProvider;

    @Autowired
    private ExtractPojosForBB extractPojosForBB;

    @Autowired
    private PnfCDSRequestProvider pnfCDSRequestProvider;

    @Autowired
    private NssiCDSRequestProvider nssiCDSRequestProvider;


    /**
     * Build properties like (blueprint name, version, action etc..) along with the request payload for vnf, vf-module
     * and service.
     *
     * @param execution - A building block execution object.
     * @return AbstractCDSPropertiesBean - A POJO which contains CDS related information.
     * @throws PayloadGenerationException - Throw an exception if it fails to build payload for CDS.
     */
    public AbstractCDSPropertiesBean buildCdsPropertiesBean(BuildingBlockExecution execution)
            throws PayloadGenerationException {

        ExecuteBuildingBlock executeBuildingBlock = execution.getVariable(BUILDING_BLOCK);
        BuildingBlock buildingBlock = executeBuildingBlock.getBuildingBlock();
        final String requestId = execution.getGeneralBuildingBlock().getRequestContext().getMsoRequestId();
        final String scope = buildingBlock.getBpmnScope();
        final String action = buildingBlock.getBpmnAction();


        CDSRequestProvider requestProvider = getRequestProviderByScope(scope);
        requestProvider.setExecutionObject(execution);

        final String requestPayload = requestProvider.buildRequestPayload(action)
                .orElseThrow(() -> new PayloadGenerationException("Failed to build payload for CDS"));

        return prepareAndSetCdsPropertyBean(requestProvider, requestPayload, requestId, action, DEFAULT_SYNC_MODE);
    }

    /**
     * Build properties like (blueprint name, version, action etc..) along with the request payload for pnf.
     *
     * @param execution - A building block execution object.
     * @return AbstractCDSPropertiesBean - A POJO which contains CDS related information.
     * @throws PayloadGenerationException - Throw an exception if it fails to build payload for CDS.
     */
    public AbstractCDSPropertiesBean buildCdsPropertiesBean(DelegateExecution execution)
            throws PayloadGenerationException {

        final String scope = String.valueOf(execution.getVariable(PayloadConstants.SCOPE));
        final String action = String.valueOf(execution.getVariable(PayloadConstants.ACTION));
        final String requestId = String.valueOf(execution.getVariable(MSO_REQUEST_ID));
        final String mode = extractAndSetMode(execution);

        CDSRequestProvider requestProvider = getRequestProviderByScope(scope);
        requestProvider.setExecutionObject(execution);

        final String requestPayload = requestProvider.buildRequestPayload(action)
                .orElseThrow(() -> new PayloadGenerationException("Failed to build payload for CDS"));

        return prepareAndSetCdsPropertyBean(requestProvider, requestPayload, requestId, action, mode);
    }

    private AbstractCDSPropertiesBean prepareAndSetCdsPropertyBean(CDSRequestProvider requestProvider,
            String requestPayload, String requestId, String action, String mode) {
        final AbstractCDSPropertiesBean cdsPropertiesBean = new AbstractCDSPropertiesBean();
        cdsPropertiesBean.setRequestObject(requestPayload);
        cdsPropertiesBean.setBlueprintName(requestProvider.getBlueprintName());
        cdsPropertiesBean.setBlueprintVersion(requestProvider.getBlueprintVersion());
        cdsPropertiesBean.setRequestId(requestId);
        cdsPropertiesBean.setOriginatorId(ORIGINATOR_ID);
        cdsPropertiesBean.setSubRequestId(UUID.randomUUID().toString());
        cdsPropertiesBean.setActionName(action);
        cdsPropertiesBean.setMode(mode);
        return cdsPropertiesBean;
    }

    private String extractAndSetMode(DelegateExecution execution) {
        String mode = DEFAULT_SYNC_MODE;
        Object obj = execution.getVariable(PayloadConstants.MODE);
        if (obj != null && !String.valueOf(obj).isEmpty()) {
            mode = String.valueOf(obj);
        }
        return mode;
    }

    private CDSRequestProvider getRequestProviderByScope(String scope) throws PayloadGenerationException {
        CDSRequestProvider requestProvider;
        switch (scope) {
            case PayloadConstants.VNF_SCOPE:
                requestProvider = vnfCDSRequestProvider;
                break;
            case PayloadConstants.VF_MODULE_SCOPE:
                requestProvider = vfModuleCDSRequestProvider;
                break;
            case PayloadConstants.SERVICE_SCOPE:
                requestProvider = serviceCDSRequestProvider;
                break;
            case PayloadConstants.PNF_SCOPE:
                requestProvider = pnfCDSRequestProvider;
                break;

            case PayloadConstants.NSSI_SCOPE:
                requestProvider = nssiCDSRequestProvider;
                break;
            default:
                throw new PayloadGenerationException("No scope defined with " + scope);
        }
        return requestProvider;
    }
}