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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021 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.policy.clamp.acm.participant.simulator.simulation.rest;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.Authorization;
import io.swagger.annotations.Extension;
import io.swagger.annotations.ExtensionProperty;
import io.swagger.annotations.ResponseHeader;
import java.util.Map;
import java.util.UUID;
import org.onap.policy.clamp.acm.participant.simulator.main.rest.AbstractRestController;
import org.onap.policy.clamp.acm.participant.simulator.simulation.SimulationProvider;
import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElement;
import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions;
import org.onap.policy.clamp.models.acm.messages.rest.TypedSimpleResponse;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;
/**
* Class to provide REST end points for participant simulator to query/update details of automationCompositionElements.
*/
@RestController
public class SimulationElementController extends AbstractRestController {
/**
* Constructor.
*
* @param simulationProvider the Simulation Provider
*/
public SimulationElementController(SimulationProvider simulationProvider) {
super(simulationProvider);
}
/**
* Queries details of all automation composition element within the simulator.
*
* @param requestId request ID used in ONAP logging
* @param name the name of the Automation Composition element to get, null to get all
* @param version the version of the Automation Composition element to get, null to get all
* @return the automation composition elements
*/
// @formatter:off
@GetMapping("/elements/{name}/{version}")
@ApiOperation(
value = "Query details of the requested simulated automation composition elements",
notes = "Queries details of the requested simulated automation composition elements, "
+ "returning all automation composition element details",
response = AutomationCompositions.class,
tags = {
"Clamp Automation Composition Participant Simulator API"
},
authorizations = @Authorization(value = AUTHORIZATION_TYPE),
responseHeaders = {
@ResponseHeader(
name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
response = String.class),
@ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
response = UUID.class)},
extensions = {
@Extension
(
name = EXTENSION_NAME,
properties = {
@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
@ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
}
)
}
)
@ApiResponses(
value = {
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
}
)
// @formatter:on
public ResponseEntity<Map<UUID, AutomationCompositionElement>> elements(
@RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
@ApiParam(value = "Automation composition element name", required = true) @PathVariable("name") String name,
@ApiParam(
value = "Automation composition element version",
required = true) @PathVariable("version") String version) {
return ResponseEntity
.ok()
.headers(super.getCommonHeaders(requestId))
.body(getSimulationProvider().getAutomationCompositionElements(name, version));
}
/**
* Updates a automation composition element in the simulator.
*
* @param requestId request ID used in ONAP logging
* @param body the body of a automation composition element
* @return a response
*/
// @formatter:off
@PutMapping("/elements")
@ApiOperation(
value = "Updates simulated automation composition elements",
notes = "Updates simulated automation composition elements, "
+ "returning the updated automation composition definition IDs",
response = TypedSimpleResponse.class,
tags = {
"Clamp Automation Composition Participant Simulator API"
},
authorizations = @Authorization(value = AUTHORIZATION_TYPE),
responseHeaders = {
@ResponseHeader(
name = VERSION_MINOR_NAME,
description = VERSION_MINOR_DESCRIPTION,
response = String.class),
@ResponseHeader(
name = VERSION_PATCH_NAME,
description = VERSION_PATCH_DESCRIPTION,
response = String.class),
@ResponseHeader(
name = VERSION_LATEST_NAME,
description = VERSION_LATEST_DESCRIPTION,
response = String.class),
@ResponseHeader(
name = REQUEST_ID_NAME,
description = REQUEST_ID_HDR_DESCRIPTION,
response = UUID.class)
},
extensions = {
@Extension
(
name = EXTENSION_NAME,
properties = {
@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
@ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
}
)
}
)
@ApiResponses(
value = {
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
}
)
// @formatter:on
public ResponseEntity<TypedSimpleResponse<AutomationCompositionElement>> update(
@RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
@ApiParam(
value = "Body of a automation composition element",
required = true) @RequestBody AutomationCompositionElement body) {
return ResponseEntity
.ok()
.headers(super.getCommonHeaders(requestId))
.body(getSimulationProvider().updateAutomationCompositionElement(body));
}
}
|
