2 * ============LICENSE_START=======================================================
\r
4 * ================================================================================
\r
5 * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
\r
6 * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
\r
7 * Modifications Copyright (C) 2020,2022 Nordix Foundation.
\r
8 * Modifications Copyright (C) 2020-2022 Bell Canada. All rights reserved.
\r
9 * ================================================================================
\r
10 * Licensed under the Apache License, Version 2.0 (the "License");
\r
11 * you may not use this file except in compliance with the License.
\r
12 * You may obtain a copy of the License at
\r
14 * http://www.apache.org/licenses/LICENSE-2.0
\r
16 * Unless required by applicable law or agreed to in writing, software
\r
17 * distributed under the License is distributed on an "AS IS" BASIS,
\r
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
19 * See the License for the specific language governing permissions and
\r
20 * limitations under the License.
\r
22 * SPDX-License-Identifier: Apache-2.0
\r
23 * ============LICENSE_END=========================================================
\r
26 package org.onap.policy.api.main.rest;
\r
28 import io.swagger.annotations.Api;
\r
29 import io.swagger.annotations.ApiOperation;
\r
30 import io.swagger.annotations.ApiParam;
\r
31 import io.swagger.annotations.ApiResponse;
\r
32 import io.swagger.annotations.ApiResponses;
\r
33 import io.swagger.annotations.Authorization;
\r
34 import io.swagger.annotations.BasicAuthDefinition;
\r
35 import io.swagger.annotations.Extension;
\r
36 import io.swagger.annotations.ExtensionProperty;
\r
37 import io.swagger.annotations.Info;
\r
38 import io.swagger.annotations.ResponseHeader;
\r
39 import io.swagger.annotations.SecurityDefinition;
\r
40 import io.swagger.annotations.SwaggerDefinition;
\r
41 import java.net.HttpURLConnection;
\r
42 import java.util.List;
\r
43 import java.util.UUID;
\r
44 import javax.ws.rs.core.Response.Status;
\r
45 import org.onap.policy.api.main.exception.PolicyApiRuntimeException;
\r
46 import org.onap.policy.api.main.rest.provider.HealthCheckProvider;
\r
47 import org.onap.policy.api.main.rest.provider.PolicyProvider;
\r
48 import org.onap.policy.api.main.rest.provider.PolicyTypeProvider;
\r
49 import org.onap.policy.api.main.rest.provider.StatisticsProvider;
\r
50 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
\r
51 import org.onap.policy.common.endpoints.report.HealthCheckReport;
\r
52 import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
\r
53 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
\r
54 import org.onap.policy.models.base.PfModelException;
\r
55 import org.onap.policy.models.base.PfModelRuntimeException;
\r
56 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
\r
57 import org.slf4j.Logger;
\r
58 import org.slf4j.LoggerFactory;
\r
59 import org.springframework.beans.factory.annotation.Autowired;
\r
60 import org.springframework.http.HttpMethod;
\r
61 import org.springframework.http.HttpStatus;
\r
62 import org.springframework.http.ResponseEntity;
\r
63 import org.springframework.web.bind.annotation.DeleteMapping;
\r
64 import org.springframework.web.bind.annotation.GetMapping;
\r
65 import org.springframework.web.bind.annotation.PathVariable;
\r
66 import org.springframework.web.bind.annotation.PostMapping;
\r
67 import org.springframework.web.bind.annotation.RequestBody;
\r
68 import org.springframework.web.bind.annotation.RequestHeader;
\r
69 import org.springframework.web.bind.annotation.RequestMapping;
\r
70 import org.springframework.web.bind.annotation.RequestParam;
\r
71 import org.springframework.web.bind.annotation.RestController;
\r
74 * Class to provide REST API services.
\r
76 * @author Chenfei Gao (cgao@research.att.com)
\r
79 @RequestMapping(path = "/policy/api/v1", produces = { "application/json", "application/yaml" })
\r
80 @Api(value = "Policy Design API")
\r
83 description = "Policy Design API is publicly exposed for clients to Create/Read/Update/Delete"
\r
84 + " policy types, policy type implementation and policies which can be recognized"
\r
85 + " and executable by incorporated policy engines. It is an"
\r
86 + " independent component running rest service that takes all policy design API calls"
\r
87 + " from clients and then assign them to different API working functions. Besides"
\r
88 + " that, API is also exposed for clients to retrieve healthcheck status of this API"
\r
89 + " rest service and the statistics report including the counters of API invocation.",
\r
90 version = "1.0.0", title = "Policy Design",
\r
91 extensions = {@Extension(properties = {@ExtensionProperty(name = "planned-retirement-date", value = "tbd"),
\r
92 @ExtensionProperty(name = "component", value = "Policy Framework")})}),
\r
93 schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
\r
94 securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
\r
95 public class ApiRestController extends CommonRestController {
\r
97 private enum Target {
\r
104 private PolicyProvider policyProvider;
\r
107 private HealthCheckProvider healthCheckProvider;
\r
110 private PolicyTypeProvider policyTypeProvider;
\r
113 private ApiStatisticsManager mgr;
\r
116 private StatisticsProvider statisticsProvider;
\r
119 * Retrieves the healthcheck status of the API component.
\r
121 * @return the Response object containing the results of the API operation
\r
123 @GetMapping("/healthcheck")
\r
124 @ApiOperation(value = "Perform a system healthcheck", notes = "Returns healthy status of the Policy API component",
\r
125 response = HealthCheckReport.class,
\r
126 responseHeaders = {
\r
127 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
128 description = VERSION_MINOR_DESCRIPTION,
\r
129 response = String.class),
\r
130 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
131 description = VERSION_PATCH_DESCRIPTION,
\r
132 response = String.class),
\r
133 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
134 response = String.class),
\r
135 @ResponseHeader(name = REQUEST_ID_NAME,
\r
136 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
137 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"HealthCheck", },
\r
139 @Extension(name = EXTENSION_NAME, properties = {
\r
140 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
141 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
142 @ApiResponses(value = {
\r
143 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
144 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
145 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
146 public ResponseEntity<HealthCheckReport> getHealthCheck(
\r
147 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
148 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
149 updateApiStatisticsCounter(Target.OTHER, HttpStatus.OK, HttpMethod.GET);
\r
150 return makeOkResponse(requestId, healthCheckProvider.performHealthCheck());
\r
154 * Retrieves the statistics report of the API component.
\r
156 * @return the Response object containing the results of the API operation
\r
158 @GetMapping("/statistics")
\r
159 @ApiOperation(value = "Retrieve current statistics",
\r
160 notes = "Returns current statistics including the counters of API invocation",
\r
161 response = StatisticsReport.class,
\r
162 responseHeaders = {
\r
163 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
164 description = VERSION_MINOR_DESCRIPTION,
\r
165 response = String.class),
\r
166 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
167 description = VERSION_PATCH_DESCRIPTION,
\r
168 response = String.class),
\r
169 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
170 response = String.class),
\r
171 @ResponseHeader(name = REQUEST_ID_NAME,
\r
172 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
173 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Statistics", },
\r
175 @Extension(name = EXTENSION_NAME, properties = {
\r
176 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
177 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
178 @ApiResponses(value = {
\r
179 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
180 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
181 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
182 public ResponseEntity<StatisticsReport> getStatistics(
\r
183 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
184 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
185 updateApiStatisticsCounter(Target.OTHER, HttpStatus.OK, HttpMethod.GET);
\r
186 return makeOkResponse(requestId, statisticsProvider.fetchCurrentStatistics());
\r
190 * Retrieves all available policy types.
\r
192 * @return the Response object containing the results of the API operation
\r
194 @GetMapping("/policytypes")
\r
195 @ApiOperation(value = "Retrieve existing policy types",
\r
196 notes = "Returns a list of existing policy types stored in Policy Framework",
\r
197 response = ToscaServiceTemplate.class,
\r
198 responseHeaders = {
\r
199 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
200 description = VERSION_MINOR_DESCRIPTION,
\r
201 response = String.class),
\r
202 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
203 description = VERSION_PATCH_DESCRIPTION,
\r
204 response = String.class),
\r
205 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
206 response = String.class),
\r
207 @ResponseHeader(name = REQUEST_ID_NAME,
\r
208 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
209 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },
\r
211 @Extension(name = EXTENSION_NAME, properties = {
\r
212 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
213 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
214 @ApiResponses(value = {
\r
215 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
216 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
217 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
218 public ResponseEntity<ToscaServiceTemplate> getAllPolicyTypes(
\r
219 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
220 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
222 ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(null, null);
\r
223 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);
\r
224 return makeOkResponse(requestId, serviceTemplate);
\r
225 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
226 final var msg = "GET /policytypes";
\r
227 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
228 .getStatusCode()), HttpMethod.GET);
\r
229 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
234 * Retrieves all versions of a particular policy type.
\r
236 * @param policyTypeId the ID of specified policy type
\r
238 * @return the Response object containing the results of the API operation
\r
240 @GetMapping("/policytypes/{policyTypeId}")
\r
241 @ApiOperation(value = "Retrieve all available versions of a policy type",
\r
242 notes = "Returns a list of all available versions for the specified policy type",
\r
243 response = ToscaServiceTemplate.class,
\r
244 responseHeaders = {
\r
245 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
246 description = VERSION_MINOR_DESCRIPTION,
\r
247 response = String.class),
\r
248 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
249 description = VERSION_PATCH_DESCRIPTION,
\r
250 response = String.class),
\r
251 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
252 response = String.class),
\r
253 @ResponseHeader(name = REQUEST_ID_NAME,
\r
254 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
255 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },
\r
257 @Extension(name = EXTENSION_NAME, properties = {
\r
258 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
259 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
260 @ApiResponses(value = {
\r
261 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
262 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
263 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
264 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
265 public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicyType(
\r
266 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
267 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
268 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
270 ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(policyTypeId, null);
\r
271 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);
\r
272 return makeOkResponse(requestId, serviceTemplate);
\r
273 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
274 var msg = String.format("GET /policytypes/%s", policyTypeId);
\r
275 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
276 .getStatusCode()), HttpMethod.GET);
\r
277 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
282 * Retrieves specified version of a particular policy type.
\r
284 * @param policyTypeId the ID of specified policy type
\r
285 * @param versionId the version of specified policy type
\r
287 * @return the Response object containing the results of the API operation
\r
289 @GetMapping("/policytypes/{policyTypeId}/versions/{versionId}")
\r
290 @ApiOperation(value = "Retrieve one particular version of a policy type",
\r
291 notes = "Returns a particular version for the specified policy type", response = ToscaServiceTemplate.class,
\r
292 responseHeaders = {
\r
293 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
294 description = VERSION_MINOR_DESCRIPTION,
\r
295 response = String.class),
\r
296 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
297 description = VERSION_PATCH_DESCRIPTION,
\r
298 response = String.class),
\r
299 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
300 response = String.class),
\r
301 @ResponseHeader(name = REQUEST_ID_NAME,
\r
302 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
303 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },
\r
305 @Extension(name = EXTENSION_NAME, properties = {
\r
306 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
307 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
308 @ApiResponses(value = {
\r
309 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
310 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
311 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
312 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
313 public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicyType(
\r
314 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
315 @PathVariable("versionId") @ApiParam(value = "Version of policy type", required = true) String versionId,
\r
316 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
317 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
319 ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(policyTypeId, versionId);
\r
320 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);
\r
321 return makeOkResponse(requestId, serviceTemplate);
\r
322 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
323 var msg = String.format("GET /policytypes/%s/versions/%s", policyTypeId, versionId);
\r
324 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
325 .getStatusCode()), HttpMethod.GET);
\r
326 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
331 * Retrieves latest version of a particular policy type.
\r
333 * @param policyTypeId the ID of specified policy type
\r
335 * @return the Response object containing the results of the API operation
\r
337 @GetMapping("/policytypes/{policyTypeId}/versions/latest")
\r
338 @ApiOperation(value = "Retrieve latest version of a policy type",
\r
339 notes = "Returns latest version for the specified policy type", response = ToscaServiceTemplate.class,
\r
340 responseHeaders = {
\r
341 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
342 description = VERSION_MINOR_DESCRIPTION,
\r
343 response = String.class),
\r
344 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
345 description = VERSION_PATCH_DESCRIPTION,
\r
346 response = String.class),
\r
347 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
348 response = String.class),
\r
349 @ResponseHeader(name = REQUEST_ID_NAME,
\r
350 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
351 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },
\r
353 @Extension(name = EXTENSION_NAME, properties = {
\r
354 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
355 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
356 @ApiResponses(value = {
\r
357 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
358 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
359 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
360 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
361 public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicyType(
\r
362 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
363 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
364 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
366 ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchLatestPolicyTypes(policyTypeId);
\r
367 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);
\r
368 return makeOkResponse(requestId, serviceTemplate);
\r
369 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
370 var msg = String.format("GET /policytypes/%s/versions/latest", policyTypeId);
\r
371 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
372 .getStatusCode()), HttpMethod.GET);
\r
373 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
378 * Creates a new policy type.
\r
380 * @param body the body of policy type following TOSCA definition
\r
382 * @return the Response object containing the results of the API operation
\r
384 @PostMapping("/policytypes")
\r
385 @ApiOperation(value = "Create a new policy type", notes = "Client should provide TOSCA body of the new policy type",
\r
386 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },
\r
387 response = ToscaServiceTemplate.class,
\r
388 responseHeaders = {
\r
389 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
390 description = VERSION_MINOR_DESCRIPTION,
\r
391 response = String.class),
\r
392 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
393 description = VERSION_PATCH_DESCRIPTION,
\r
394 response = String.class),
\r
395 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
396 response = String.class),
\r
397 @ResponseHeader(name = REQUEST_ID_NAME,
\r
398 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
400 @Extension(name = EXTENSION_NAME, properties = {
\r
401 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
402 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
403 @ApiResponses(value = {
\r
404 @ApiResponse(code = HttpURLConnection.HTTP_BAD_REQUEST, message = INVALID_BODY_MESSAGE),
\r
405 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
406 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
407 @ApiResponse(code = HttpURLConnection.HTTP_NOT_ACCEPTABLE, message = INVALID_PAYLOAD_MESSAGE),
\r
408 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
409 public ResponseEntity<ToscaServiceTemplate> createPolicyType(
\r
410 @RequestBody @ApiParam(value = "Entity body of policy type", required = true) ToscaServiceTemplate body,
\r
411 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
412 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
413 if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
\r
414 NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policytypes", toJson(body));
\r
417 ToscaServiceTemplate serviceTemplate = policyTypeProvider.createPolicyType(body);
\r
418 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.POST);
\r
419 return makeOkResponse(requestId, serviceTemplate);
\r
420 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
421 final var msg = "POST /policytypes";
\r
422 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
423 .getStatusCode()), HttpMethod.POST);
\r
424 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
429 * Deletes specified version of a particular policy type.
\r
431 * @param policyTypeId the ID of specified policy type
\r
432 * @param versionId the version of specified policy type
\r
434 * @return the Response object containing the results of the API operation
\r
436 @DeleteMapping("/policytypes/{policyTypeId}/versions/{versionId}")
\r
437 @ApiOperation(value = "Delete one version of a policy type",
\r
438 notes = "Rule 1: pre-defined policy types cannot be deleted;"
\r
439 + "Rule 2: policy types that are in use (parameterized by a TOSCA policy) cannot be deleted."
\r
440 + "The parameterizing TOSCA policies must be deleted first;",
\r
441 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },
\r
442 response = ToscaServiceTemplate.class,
\r
443 responseHeaders = {
\r
444 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
445 description = VERSION_MINOR_DESCRIPTION,
\r
446 response = String.class),
\r
447 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
448 description = VERSION_PATCH_DESCRIPTION,
\r
449 response = String.class),
\r
450 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
451 response = String.class),
\r
452 @ResponseHeader(name = REQUEST_ID_NAME,
\r
453 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
455 @Extension(name = EXTENSION_NAME, properties = {
\r
456 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
457 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
458 @ApiResponses(value = {
\r
459 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
460 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
461 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
462 @ApiResponse(code = HttpURLConnection.HTTP_CONFLICT, message = HTTP_CONFLICT_MESSAGE),
\r
463 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
464 public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicyType(
\r
465 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
466 @PathVariable("versionId") @ApiParam(value = "Version of policy type", required = true) String versionId,
\r
467 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
468 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
470 ToscaServiceTemplate serviceTemplate = policyTypeProvider.deletePolicyType(policyTypeId, versionId);
\r
471 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.DELETE);
\r
472 return makeOkResponse(requestId, serviceTemplate);
\r
473 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
474 var msg = String.format("DELETE /policytypes/%s/versions/%s", policyTypeId, versionId);
\r
475 updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
476 .getStatusCode()), HttpMethod.DELETE);
\r
477 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
482 * Retrieves all versions of a particular policy.
\r
484 * @param policyTypeId the ID of specified policy type
\r
485 * @param policyTypeVersion the version of specified policy type
\r
487 * @return the Response object containing the results of the API operation
\r
489 @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")
\r
491 value = "Retrieve all versions of a policy created for a particular policy type version",
\r
492 notes = "Returns a list of all versions of specified policy created for the specified policy type version",
\r
493 response = ToscaServiceTemplate.class,
\r
494 responseHeaders = {
\r
495 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
496 description = VERSION_MINOR_DESCRIPTION,
\r
497 response = String.class),
\r
498 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
499 description = VERSION_PATCH_DESCRIPTION,
\r
500 response = String.class),
\r
501 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
502 response = String.class),
\r
503 @ResponseHeader(name = REQUEST_ID_NAME,
\r
504 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
505 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy,"},
\r
507 @Extension(name = EXTENSION_NAME, properties = {
\r
508 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
509 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")
\r
513 @ApiResponses(value = {
\r
514 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
515 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
516 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
517 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)
\r
519 public ResponseEntity<ToscaServiceTemplate> getAllPolicies(
\r
520 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
521 @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",
\r
522 required = true) String policyTypeVersion,
\r
523 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
524 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
525 @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare"
\r
526 + " policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {
\r
528 ToscaServiceTemplate serviceTemplate =
\r
529 policyProvider.fetchPolicies(policyTypeId, policyTypeVersion, null, null, mode);
\r
530 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.GET);
\r
531 return makeOkResponse(requestId, serviceTemplate);
\r
532 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
533 var msg = String.format("GET /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);
\r
534 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
535 .getStatusCode()), HttpMethod.GET);
\r
536 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
541 * Retrieves all versions of a particular policy.
\r
543 * @param policyTypeId the ID of specified policy type
\r
544 * @param policyTypeVersion the version of specified policy type
\r
545 * @param policyId the ID of specified policy
\r
547 * @return the Response object containing the results of the API operation
\r
549 @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}")
\r
550 @ApiOperation(value = "Retrieve all version details of a policy created for a particular policy type version",
\r
551 notes = "Returns a list of all version details of the specified policy", response = ToscaServiceTemplate.class,
\r
552 responseHeaders = {
\r
553 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
554 description = VERSION_MINOR_DESCRIPTION,
\r
555 response = String.class),
\r
556 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
557 description = VERSION_PATCH_DESCRIPTION,
\r
558 response = String.class),
\r
559 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
560 response = String.class),
\r
561 @ResponseHeader(name = REQUEST_ID_NAME,
\r
562 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
563 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
565 @Extension(name = EXTENSION_NAME, properties = {
\r
566 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
567 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")
\r
571 @ApiResponses(value = {
\r
572 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
573 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
574 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
575 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)
\r
577 public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicy(
\r
578 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
579 @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",
\r
580 required = true) String policyTypeVersion,
\r
581 @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,
\r
582 @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
583 @RequestParam(name = "mode", defaultValue = "bare")
\r
584 @ApiParam("Fetch mode for policies, BARE for bare policies (default),"
\r
585 + " REFERENCED for fully referenced policies") PolicyFetchMode mode) {
\r
587 ToscaServiceTemplate serviceTemplate =
\r
588 policyProvider.fetchPolicies(policyTypeId, policyTypeVersion, policyId, null, mode);
\r
589 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.GET);
\r
590 return makeOkResponse(requestId, serviceTemplate);
\r
591 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
592 var msg = String.format("/policytypes/%s/versions/$s/policies/%s",
\r
593 policyTypeId, policyTypeVersion, policyId);
\r
594 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
595 .getStatusCode()), HttpMethod.GET);
\r
596 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
601 * Retrieves the specified version of a particular policy.
\r
603 * @param policyTypeId the ID of specified policy type
\r
604 * @param policyTypeVersion the version of specified policy type
\r
605 * @param policyId the ID of specified policy
\r
606 * @param policyVersion the version of specified policy
\r
608 * @return the Response object containing the results of the API operation
\r
610 @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}")
\r
611 @ApiOperation(value = "Retrieve one version of a policy created for a particular policy type version",
\r
612 notes = "Returns a particular version of specified policy created for the specified policy type version",
\r
613 response = ToscaServiceTemplate.class,
\r
614 responseHeaders = {
\r
615 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
616 description = VERSION_MINOR_DESCRIPTION,
\r
617 response = String.class),
\r
618 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
619 description = VERSION_PATCH_DESCRIPTION,
\r
620 response = String.class),
\r
621 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
622 response = String.class),
\r
623 @ResponseHeader(name = REQUEST_ID_NAME,
\r
624 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
625 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
627 @Extension(name = EXTENSION_NAME, properties = {
\r
628 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
629 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")
\r
633 @ApiResponses(value = {
\r
634 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
635 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
636 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
637 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)
\r
639 public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicy(
\r
640 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
641 @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",
\r
642 required = true) String policyTypeVersion,
\r
643 @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,
\r
644 @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,
\r
645 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
646 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
647 @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare policies"
\r
648 + " (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {
\r
650 ToscaServiceTemplate serviceTemplate =
\r
651 policyProvider.fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion, mode);
\r
652 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.GET);
\r
653 return makeOkResponse(requestId, serviceTemplate);
\r
654 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
655 var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/%s",
\r
656 policyTypeId, policyTypeVersion, policyId, policyVersion);
\r
657 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
658 .getStatusCode()), HttpMethod.GET);
\r
659 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
664 * Retrieves the latest version of a particular policy.
\r
666 * @param policyTypeId the ID of specified policy type
\r
667 * @param policyTypeVersion the version of specified policy type
\r
668 * @param policyId the ID of specified policy
\r
670 * @return the Response object containing the results of the API operation
\r
672 @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/latest")
\r
673 @ApiOperation(value = "Retrieve the latest version of a particular policy",
\r
674 notes = "Returns the latest version of specified policy", response = ToscaServiceTemplate.class,
\r
675 responseHeaders = {
\r
676 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
677 description = VERSION_MINOR_DESCRIPTION,
\r
678 response = String.class),
\r
679 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
680 description = VERSION_PATCH_DESCRIPTION,
\r
681 response = String.class),
\r
682 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
683 response = String.class),
\r
684 @ResponseHeader(name = REQUEST_ID_NAME,
\r
685 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
686 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
688 @Extension(name = EXTENSION_NAME, properties = {
\r
689 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
690 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
691 @ApiResponses(value = {
\r
692 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
693 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
694 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
695 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
696 public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicy(
\r
697 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
698 @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",
\r
699 required = true) String policyTypeVersion,
\r
700 @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,
\r
701 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
702 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
703 @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, TERSE for bare "
\r
704 + "policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {
\r
706 ToscaServiceTemplate serviceTemplate =
\r
707 policyProvider.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId, mode);
\r
708 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.GET);
\r
709 return makeOkResponse(requestId, serviceTemplate);
\r
710 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
711 var msg = String.format("GET /policytypes/%s/versions/%s/policies/%s/versions/latest",
\r
712 policyTypeId, policyTypeVersion, policyId);
\r
713 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
714 .getStatusCode()), HttpMethod.GET);
\r
715 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
720 * Creates a new policy for a particular policy type and version.
\r
722 * @param policyTypeId the ID of specified policy type
\r
723 * @param policyTypeVersion the version of specified policy type
\r
724 * @param body the body of policy following TOSCA definition
\r
726 * @return the Response object containing the results of the API operation
\r
728 @PostMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")
\r
729 @ApiOperation(value = "Create a new policy for a policy type version",
\r
730 notes = "Client should provide TOSCA body of the new policy",
\r
731 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
732 response = ToscaServiceTemplate.class,
\r
733 responseHeaders = {
\r
734 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
735 description = VERSION_MINOR_DESCRIPTION,
\r
736 response = String.class),
\r
737 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
738 description = VERSION_PATCH_DESCRIPTION,
\r
739 response = String.class),
\r
740 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
741 response = String.class),
\r
742 @ResponseHeader(name = REQUEST_ID_NAME,
\r
743 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
745 @Extension(name = EXTENSION_NAME, properties = {
\r
746 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
747 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
748 @ApiResponses(value = {
\r
749 @ApiResponse(code = HttpURLConnection.HTTP_BAD_REQUEST, message = INVALID_BODY_MESSAGE),
\r
750 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
751 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
752 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
753 @ApiResponse(code = HttpURLConnection.HTTP_NOT_ACCEPTABLE, message = INVALID_PAYLOAD_MESSAGE),
\r
754 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
755 public ResponseEntity<ToscaServiceTemplate> createPolicy(
\r
756 @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,
\r
757 @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",
\r
758 required = true) String policyTypeVersion,
\r
759 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
760 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
761 @RequestBody @ApiParam(value = "Entity body of policy", required = true) ToscaServiceTemplate body) {
\r
762 if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
\r
763 NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST,
\r
764 "/policytypes/" + policyTypeId + "/versions/" + policyTypeVersion + "/policies", toJson(body));
\r
767 ToscaServiceTemplate serviceTemplate = policyProvider.createPolicy(policyTypeId, policyTypeVersion, body);
\r
768 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.POST);
\r
769 return makeOkResponse(requestId, serviceTemplate);
\r
770 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
771 var msg = String.format("POST /policytypes/%s/versions/%s/policies", policyTypeId, policyTypeVersion);
\r
772 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
773 .getStatusCode()), HttpMethod.POST);
\r
774 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
779 * Deletes the specified version of a particular policy.
\r
781 * @param policyTypeId the ID of specified policy type
\r
782 * @param policyTypeVersion the version of specified policy type
\r
783 * @param policyId the ID of specified policy
\r
784 * @param policyVersion the version of specified policy
\r
786 * @return the Response object containing the results of the API operation
\r
788 @DeleteMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/"
\r
789 + "versions/{policyVersion}")
\r
790 @ApiOperation(value = "Delete a particular version of a policy",
\r
791 notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",
\r
792 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
793 response = ToscaServiceTemplate.class,
\r
794 responseHeaders = {
\r
795 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
796 description = VERSION_MINOR_DESCRIPTION,
\r
797 response = String.class),
\r
798 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
799 description = VERSION_PATCH_DESCRIPTION,
\r
800 response = String.class),
\r
801 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
802 response = String.class),
\r
803 @ResponseHeader(name = REQUEST_ID_NAME,
\r
804 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
806 @Extension(name = EXTENSION_NAME, properties = {
\r
807 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
808 @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})
\r
809 @ApiResponses(value = {
\r
810 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
811 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
812 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
813 @ApiResponse(code = HttpURLConnection.HTTP_CONFLICT, message = HTTP_CONFLICT_MESSAGE),
\r
814 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
815 public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicy(
\r
816 @PathVariable("policyTypeId") @ApiParam(value = "PolicyType ID", required = true) String policyTypeId,
\r
817 @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",
\r
818 required = true) String policyTypeVersion,
\r
819 @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,
\r
820 @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,
\r
821 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
822 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
824 ToscaServiceTemplate serviceTemplate =
\r
825 policyProvider.deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);
\r
826 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.DELETE);
\r
827 return makeOkResponse(requestId, serviceTemplate);
\r
828 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
829 var msg = String.format("DELETE /policytypes/%s/versions/%s/policies/%s/versions/%s",
\r
830 policyTypeId, policyTypeVersion, policyId, policyVersion);
\r
831 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
832 .getStatusCode()), HttpMethod.DELETE);
\r
833 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
838 * Retrieves all the available policies.
\r
840 * @return the Response object containing the results of the API operation
\r
842 @GetMapping("/policies")
\r
843 @ApiOperation(value = "Retrieve all versions of available policies",
\r
844 notes = "Returns all version of available policies",
\r
845 response = ToscaServiceTemplate.class,
\r
846 responseHeaders = {
\r
847 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
848 description = VERSION_MINOR_DESCRIPTION,
\r
849 response = String.class),
\r
850 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
851 description = VERSION_PATCH_DESCRIPTION,
\r
852 response = String.class),
\r
853 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
854 response = String.class),
\r
855 @ResponseHeader(name = REQUEST_ID_NAME,
\r
856 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
857 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
859 @Extension(name = EXTENSION_NAME, properties = {
\r
860 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
861 @ExtensionProperty(name = LAST_MOD_NAME, value = "Guilin")
\r
865 @ApiResponses(value = {
\r
866 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
867 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
868 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
869 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)
\r
871 public ResponseEntity<ToscaServiceTemplate> getPolicies(
\r
872 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
873 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
874 @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare"
\r
875 + " policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {
\r
877 ToscaServiceTemplate serviceTemplate =
\r
878 policyProvider.fetchPolicies(null, null, null, null, mode);
\r
879 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.GET);
\r
880 return makeOkResponse(requestId, serviceTemplate);
\r
881 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
882 final var msg = "GET /policies/ --";
\r
883 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
884 .getStatusCode()), HttpMethod.GET);
\r
885 if (pfme.getErrorResponse().getResponseCode().equals(Status.NOT_FOUND)) {
\r
886 pfme.getErrorResponse().setErrorMessage(ERROR_MESSAGE_NO_POLICIES_FOUND);
\r
887 pfme.getErrorResponse().setErrorDetails(List.of(ERROR_MESSAGE_NO_POLICIES_FOUND));
\r
889 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
894 * Retrieves the specified version of a particular policy.
\r
896 * @param policyId the Name of specified policy
\r
897 * @param policyVersion the version of specified policy
\r
899 * @return the Response object containing the results of the API operation
\r
901 @GetMapping("/policies/{policyId}/versions/{policyVersion}")
\r
902 @ApiOperation(value = "Retrieve specific version of a specified policy",
\r
903 notes = "Returns a particular version of specified policy",
\r
904 response = ToscaServiceTemplate.class,
\r
905 responseHeaders = {
\r
906 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
907 description = VERSION_MINOR_DESCRIPTION,
\r
908 response = String.class),
\r
909 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
910 description = VERSION_PATCH_DESCRIPTION,
\r
911 response = String.class),
\r
912 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
913 response = String.class),
\r
914 @ResponseHeader(name = REQUEST_ID_NAME,
\r
915 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
916 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
918 @Extension(name = EXTENSION_NAME, properties = {
\r
919 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
920 @ExtensionProperty(name = LAST_MOD_NAME, value = "Guilin")
\r
924 @ApiResponses(value = {
\r
925 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
926 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
927 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
928 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)
\r
930 public ResponseEntity<ToscaServiceTemplate> getSpecificPolicy(
\r
931 @PathVariable("policyId") @ApiParam(value = "Name of policy", required = true) String policyId,
\r
932 @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,
\r
933 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
934 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
935 @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare"
\r
936 + " policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {
\r
938 ToscaServiceTemplate serviceTemplate =
\r
939 policyProvider.fetchPolicies(null, null, policyId, policyVersion, mode);
\r
940 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.GET);
\r
941 return makeOkResponse(requestId, serviceTemplate);
\r
942 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
943 var msg = String.format("GET /policies/%s/versions/%s", policyId, policyVersion);
\r
944 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
945 .getStatusCode()), HttpMethod.GET);
\r
946 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
951 * Creates one or more new policies in one call.
\r
953 * @param body the body of policy following TOSCA definition
\r
955 * @return the Response object containing the results of the API operation
\r
957 @PostMapping("/policies")
\r
958 @ApiOperation(value = "Create one or more new policies",
\r
959 notes = "Client should provide TOSCA body of the new polic(ies)",
\r
960 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
961 response = ToscaServiceTemplate.class,
\r
962 responseHeaders = {
\r
963 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
964 description = VERSION_MINOR_DESCRIPTION,
\r
965 response = String.class),
\r
966 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
967 description = VERSION_PATCH_DESCRIPTION,
\r
968 response = String.class),
\r
969 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
970 response = String.class),
\r
971 @ResponseHeader(name = REQUEST_ID_NAME,
\r
972 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
974 @Extension(name = EXTENSION_NAME, properties = {
\r
975 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
976 @ExtensionProperty(name = LAST_MOD_NAME, value = "El Alto")})})
\r
977 @ApiResponses(value = {
\r
978 @ApiResponse(code = HttpURLConnection.HTTP_BAD_REQUEST, message = INVALID_BODY_MESSAGE),
\r
979 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
980 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
981 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
982 @ApiResponse(code = HttpURLConnection.HTTP_NOT_ACCEPTABLE, message = INVALID_PAYLOAD_MESSAGE),
\r
983 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
984 public ResponseEntity<ToscaServiceTemplate> createPolicies(
\r
985 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
986 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
\r
987 @RequestBody @ApiParam(value = "Entity body of policy", required = true) ToscaServiceTemplate body) {
\r
988 if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {
\r
989 NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policies", toJson(body));
\r
992 ToscaServiceTemplate serviceTemplate = policyProvider.createPolicies(body);
\r
993 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.POST);
\r
994 return makeOkResponse(requestId, serviceTemplate);
\r
995 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
996 final var msg = "POST /policies";
\r
997 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
998 .getStatusCode()), HttpMethod.POST);
\r
999 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
1004 * Deletes the specified version of a particular policy.
\r
1006 * @param policyId the ID of specified policy
\r
1007 * @param policyVersion the version of specified policy
\r
1009 * @return the Response object containing the results of the API operation
\r
1011 @DeleteMapping("/policies/{policyId}/versions/{policyVersion}")
\r
1012 @ApiOperation(value = "Delete a particular version of a policy",
\r
1013 notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",
\r
1014 authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },
\r
1015 response = ToscaServiceTemplate.class,
\r
1016 responseHeaders = {
\r
1017 @ResponseHeader(name = VERSION_MINOR_NAME,
\r
1018 description = VERSION_MINOR_DESCRIPTION,
\r
1019 response = String.class),
\r
1020 @ResponseHeader(name = VERSION_PATCH_NAME,
\r
1021 description = VERSION_PATCH_DESCRIPTION,
\r
1022 response = String.class),
\r
1023 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
\r
1024 response = String.class),
\r
1025 @ResponseHeader(name = REQUEST_ID_NAME,
\r
1026 description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},
\r
1028 @Extension(name = EXTENSION_NAME, properties = {
\r
1029 @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
\r
1030 @ExtensionProperty(name = LAST_MOD_NAME, value = "Guilin")})})
\r
1031 @ApiResponses(value = {
\r
1032 @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),
\r
1033 @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),
\r
1034 @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),
\r
1035 @ApiResponse(code = HttpURLConnection.HTTP_CONFLICT, message = HTTP_CONFLICT_MESSAGE),
\r
1036 @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})
\r
1037 public ResponseEntity<ToscaServiceTemplate> deleteSpecificPolicy(
\r
1038 @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,
\r
1039 @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,
\r
1040 @RequestHeader(name = REQUEST_ID_NAME, required = false)
\r
1041 @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {
\r
1043 ToscaServiceTemplate serviceTemplate =
\r
1044 policyProvider.deletePolicy(null, null, policyId, policyVersion);
\r
1045 updateApiStatisticsCounter(Target.POLICY, HttpStatus.OK, HttpMethod.DELETE);
\r
1046 return makeOkResponse(requestId, serviceTemplate);
\r
1047 } catch (PfModelException | PfModelRuntimeException pfme) {
\r
1048 var msg = String.format("DELETE /policies/%s/versions/%s", policyId, policyVersion);
\r
1049 updateApiStatisticsCounter(Target.POLICY, HttpStatus.resolve(pfme.getErrorResponse().getResponseCode()
\r
1050 .getStatusCode()), HttpMethod.DELETE);
\r
1051 throw new PolicyApiRuntimeException(msg, pfme.getCause(), pfme.getErrorResponse(), requestId);
\r
1055 private void updateApiStatisticsCounter(Target target, HttpStatus result, HttpMethod http) {
\r
1056 mgr.updateTotalApiCallCount();
\r
1059 updatePolicyStats(result, http);
\r
1062 updatePolicyTypeStats(result, http);
\r
1065 mgr.updateApiCallSuccessCount();
\r
1070 private void updatePolicyStats(HttpStatus result, HttpMethod http) {
\r
1071 if (result.equals(HttpStatus.OK)) {
\r
1074 mgr.updateApiCallSuccessCount();
\r
1075 mgr.updateTotalPolicyGetCount();
\r
1076 mgr.updatePolicyGetSuccessCount();
\r
1079 mgr.updateApiCallSuccessCount();
\r
1080 mgr.updateTotalPolicyPostCount();
\r
1081 mgr.updatePolicyPostSuccessCount();
\r
1084 mgr.updateApiCallSuccessCount();
\r
1085 mgr.updateTotalPolicyDeleteCount();
\r
1086 mgr.updatePolicyDeleteSuccessCount();
\r
1089 mgr.updateApiCallSuccessCount();
\r
1095 mgr.updateApiCallFailureCount();
\r
1096 mgr.updateTotalPolicyGetCount();
\r
1097 mgr.updatePolicyGetFailureCount();
\r
1100 mgr.updateApiCallFailureCount();
\r
1101 mgr.updateTotalPolicyPostCount();
\r
1102 mgr.updatePolicyPostFailureCount();
\r
1105 mgr.updateApiCallFailureCount();
\r
1106 mgr.updateTotalPolicyDeleteCount();
\r
1107 mgr.updatePolicyDeleteFailureCount();
\r
1110 mgr.updateApiCallFailureCount();
\r
1116 private void updatePolicyTypeStats(HttpStatus result, HttpMethod http) {
\r
1117 if (result.equals(HttpStatus.OK)) {
\r
1120 mgr.updateApiCallSuccessCount();
\r
1121 mgr.updateTotalPolicyTypeGetCount();
\r
1122 mgr.updatePolicyTypeGetSuccessCount();
\r
1125 mgr.updateApiCallSuccessCount();
\r
1126 mgr.updateTotalPolicyTypePostCount();
\r
1127 mgr.updatePolicyTypePostSuccessCount();
\r
1130 mgr.updateApiCallSuccessCount();
\r
1131 mgr.updateTotalPolicyTypeDeleteCount();
\r
1132 mgr.updatePolicyTypeDeleteSuccessCount();
\r
1135 mgr.updateApiCallSuccessCount();
\r
1141 mgr.updateApiCallFailureCount();
\r
1142 mgr.updateTotalPolicyTypeGetCount();
\r
1143 mgr.updatePolicyTypeGetFailureCount();
\r
1146 mgr.updateApiCallFailureCount();
\r
1147 mgr.updateTotalPolicyTypePostCount();
\r
1148 mgr.updatePolicyTypePostFailureCount();
\r
1151 mgr.updateApiCallFailureCount();
\r
1152 mgr.updateTotalPolicyTypeDeleteCount();
\r
1153 mgr.updatePolicyTypeDeleteFailureCount();
\r
1156 mgr.updateApiCallFailureCount();
\r