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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*******************************************************************************
* =============LICENSE_START=========================================================
*
* =================================================================================
* Copyright (c) 2019 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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=========================================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*******************************************************************************/
package org.onap.ccsdk.dashboard.rest;
import java.util.Map;
import org.onap.ccsdk.dashboard.model.CloudifyBlueprintContent;
import org.onap.ccsdk.dashboard.model.CloudifyBlueprintList;
import org.onap.ccsdk.dashboard.model.CloudifyBlueprintUpload;
import org.onap.ccsdk.dashboard.model.CloudifyDeployedTenantList;
import org.onap.ccsdk.dashboard.model.CloudifyDeploymentList;
import org.onap.ccsdk.dashboard.model.CloudifyDeploymentRequest;
import org.onap.ccsdk.dashboard.model.CloudifyDeploymentUpdateRequest;
import org.onap.ccsdk.dashboard.model.CloudifyDeploymentUpdateResponse;
import org.onap.ccsdk.dashboard.model.CloudifyEventList;
import org.onap.ccsdk.dashboard.model.CloudifyExecution;
import org.onap.ccsdk.dashboard.model.CloudifyExecutionList;
import org.onap.ccsdk.dashboard.model.CloudifyExecutionRequest;
import org.onap.ccsdk.dashboard.model.CloudifyNodeInstanceIdList;
import org.onap.ccsdk.dashboard.model.CloudifyNodeInstanceList;
import org.onap.ccsdk.dashboard.model.CloudifySecret;
import org.onap.ccsdk.dashboard.model.CloudifyTenantList;
/**
* @author rp5662
*
*/
public interface CloudifyClient {
/**
* Get the execution logs
*
*/
public CloudifyEventList getEventlogs(String execution_id, String tenant);
/**
* Gets the list of Cloudify tenants.
*
* @return CloudifyBlueprintList
*/
public CloudifyTenantList getTenants();
/**
* Starts a Cloudify execution.
*
* @param execution Execution details
* @return CloudifyExecution
*/
public CloudifyExecution startExecution(CloudifyExecutionRequest execution);
/**
* Deletes the Cloudify execution with the specified ids.
*
* @param executionId execution ID
* @param deploymentId Deployment ID
* @param action either "cancel" or "force-cancel"
* @return Status code; e.g., 200, 202, 204.
*/
public CloudifyExecution cancelExecution(final String executionId, Map<String, String> parameters,
final String tenant);
/**
* Get the node-instance-id.
*
* @param deploymentId deployment ID
* @param nodeId node ID
* @param tenant tenant name
* @return CloudifyNodeInstanceList
*/
public CloudifyNodeInstanceIdList getNodeInstanceId(String deploymentId, String nodeId, String tenant);
/**
* Gets all the deployments with include filters for tenant name
*
* @return List of CloudifyDeployedTenant objects
*/
public CloudifyDeployedTenantList getTenantInfoFromDeploy(String tenant);
/**
* Get the node-instance-id.
*
* @param deploymentId deployment ID
* @param tenant tenant name
*
* @return CloudifyNodeInstanceList
*/
public CloudifyNodeInstanceIdList getNodeInstanceId(String id, String tenant);
/**
* Query execution information for a deployment ID and execution ID passed as
* inputs
*
* @param executionId
* @param deploymentId
* @return
*/
public CloudifyExecutionList getExecution(String executionId, String deploymentId);
/**
* Initiate a deployment update in cloudify
*
* @param execution
* @return
*/
public CloudifyDeploymentUpdateResponse updateDeployment(CloudifyDeploymentUpdateRequest execution);
/**
* Query execution information for a deployment ID passed as input
*
* @param deploymentId
* @param tenant
* @return
*/
public CloudifyExecutionList getExecutions(final String deploymentId, final String tenant);
/**
* Query execution summary for a deployment ID passed as input
*
* @param deploymentId
* @param tenant
* @return
*/
public CloudifyExecutionList getExecutionsSummary(final String deploymentId, final String tenant);
/**
* Get cloudify node-instance-revisions.
*
* @param deploymentId deployment ID
* @param nodeId node ID
* @param tenant tenant name
* @return CloudifyNodeInstanceList
*/
public CloudifyNodeInstanceList getNodeInstanceVersion(String deploymentId, String nodeId, String tenant);
/**
* Get cloudify node-instance-revisions
*
* @param bp_id
* @param tenant
* @return
*/
public CloudifyNodeInstanceList getNodeInstanceVersion(String bp_id, String tenant);
/**
* Start Uninstall execution workflow in cloudify
*
* @param id
* @param ignoreLiveNodes
* @return
*/
public int deleteDeployment(String id, boolean ignoreLiveNodes);
/**
* Start install execution workflow in cloudify
*
* @param deployment
* @return
*/
public CloudifyDeploymentList createDeployment(CloudifyDeploymentRequest deployment);
/**
* Query deployment object from cloudify
*
* @param id
* @param tenant
* @return
*/
public CloudifyDeploymentList getDeployment(String id, String tenant);
/**
* Query deployment object from cloudify
*
* @param id
* @return
*/
public CloudifyDeploymentList getDeployment(String id);
/**
* Query deployments from cloudify
*
*/
public CloudifyDeploymentList getDeployments();
/**
* Remove blueprint referred by ID from cloudify
*
* @param id
* @return
*/
public int deleteBlueprint(String id);
/**
* Upload blueprint into cloudify
*
* @param blueprint
* @return
*/
public CloudifyBlueprintList uploadBlueprint(CloudifyBlueprintUpload blueprint);
/**
* View blueprint YAML text
*
* @param id
* @return
*/
public CloudifyBlueprintContent viewBlueprint(String id);
/**
* Query a blueprint object matching the blueprint ID in cloudify
*
* @param id
* @param tenant
* @return
*/
public CloudifyBlueprintList getBlueprint(String id, String tenant);
/**
* Query all the blueprints in cloudify
*
* @return
*/
public CloudifyBlueprintList getBlueprints();
/**
* Query deployment inputs for a deployment ID in the cloudify tenant
*
* @param id
* @param tenant
* @return
*/
public CloudifyDeploymentList getDeploymentInputs(String id, String tenant);
/**
* Query a secret object matching the input secret name in the cloudify tenant
*
* @param secretName
* @param tenant
* @return
*/
public CloudifySecret getSecret(String secretName, String tenant);
}
|
