blob: e01de69b7423c845e7092c76d15b2550b72fbb42 (
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
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2019 Bell Canada
* ================================================================================
* 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 com.google.gson.JsonObject;
import org.onap.so.client.exception.PayloadGenerationException;
import java.util.Optional;
import static org.onap.so.client.cds.PayloadConstants.REQUEST;
import static org.onap.so.client.cds.PayloadConstants.SEPARATOR;
public interface CDSRequestProvider {
/**
* Build entire payload for CDS.
*
* @param action - action could be assign/deploy/undeploy etc.
* @return "payload":{ "config-<action>-<scope>":{ // information about resolution key, property configuration and
* template prefix based on the scope and action}
* @throws PayloadGenerationException If fail to build the payload.
*/
Optional<String> buildRequestPayload(String action) throws PayloadGenerationException;
/**
* Get the blueprint name for CDS payload
*
* @return blueprint name
*/
String getBlueprintName();
/**
* Get the blueprint version for CDS payload
*
* @return blueprint version
*/
String getBlueprintVersion();
/**
* Set the executionObject(BuildingBlockExecution or DelegateExecution for PNF)
*
* @param executionObject object could be BuildingBlockExecution or DelegateExecution.
*/
<T> void setExecutionObject(T executionObject);
/**
* Build Request payload for CDS
*
* @param cdsPropertyObject - Json Object
* @param action - action could be assign/deploy/undeploy etc.
* @return Request Payload
*/
default String buildRequestJsonObject(JsonObject cdsPropertyObject, String action) {
String requestBasedOnAction = action.concat(SEPARATOR).concat(REQUEST);
JsonObject requestObject = new JsonObject();
requestObject.add(requestBasedOnAction, cdsPropertyObject);
return requestObject.toString();
}
}
|
