* ================================================================================\r
* Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.\r
* Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.\r
- * Modifications Copyright (C) 2020,2022 Nordix Foundation.\r
+ * Modifications Copyright (C) 2020-2022 Nordix Foundation.\r
* Modifications Copyright (C) 2020-2022 Bell Canada. All rights reserved.\r
* ================================================================================\r
* Licensed under the Apache License, Version 2.0 (the "License");\r
\r
package org.onap.policy.api.main.rest;\r
\r
-import io.swagger.annotations.Api;\r
-import io.swagger.annotations.ApiOperation;\r
-import io.swagger.annotations.ApiParam;\r
-import io.swagger.annotations.ApiResponse;\r
-import io.swagger.annotations.ApiResponses;\r
-import io.swagger.annotations.Authorization;\r
-import io.swagger.annotations.BasicAuthDefinition;\r
-import io.swagger.annotations.Extension;\r
-import io.swagger.annotations.ExtensionProperty;\r
-import io.swagger.annotations.Info;\r
-import io.swagger.annotations.ResponseHeader;\r
-import io.swagger.annotations.SecurityDefinition;\r
-import io.swagger.annotations.SwaggerDefinition;\r
-import java.net.HttpURLConnection;\r
import java.util.List;\r
import java.util.UUID;\r
import javax.ws.rs.core.Response.Status;\r
import lombok.RequiredArgsConstructor;\r
import org.onap.policy.api.main.exception.PolicyApiRuntimeException;\r
-import org.onap.policy.api.main.rest.provider.HealthCheckProvider;\r
-import org.onap.policy.api.main.rest.provider.StatisticsProvider;\r
+import org.onap.policy.api.main.rest.genapi.PolicyDesignApi;\r
+import org.onap.policy.api.main.rest.provider.healthcheck.HealthCheckProvider;\r
+import org.onap.policy.api.main.rest.provider.statistics.ApiStatisticsManager;\r
+import org.onap.policy.api.main.rest.provider.statistics.StatisticsProvider;\r
+import org.onap.policy.api.main.rest.provider.statistics.StatisticsReport;\r
import org.onap.policy.api.main.service.ToscaServiceTemplateService;\r
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;\r
import org.onap.policy.common.endpoints.report.HealthCheckReport;\r
import org.onap.policy.models.base.PfModelException;\r
import org.onap.policy.models.base.PfModelRuntimeException;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
+import org.springframework.context.annotation.Profile;\r
import org.springframework.http.HttpMethod;\r
import org.springframework.http.HttpStatus;\r
import org.springframework.http.ResponseEntity;\r
-import org.springframework.web.bind.annotation.DeleteMapping;\r
-import org.springframework.web.bind.annotation.GetMapping;\r
-import org.springframework.web.bind.annotation.PathVariable;\r
-import org.springframework.web.bind.annotation.PostMapping;\r
-import org.springframework.web.bind.annotation.RequestBody;\r
-import org.springframework.web.bind.annotation.RequestHeader;\r
-import org.springframework.web.bind.annotation.RequestMapping;\r
-import org.springframework.web.bind.annotation.RequestParam;\r
import org.springframework.web.bind.annotation.RestController;\r
\r
/**\r
* @author Chenfei Gao (cgao@research.att.com)\r
*/\r
@RestController\r
-@RequestMapping(path = "/policy/api/v1", produces = { "application/json", "application/yaml" })\r
-@Api(value = "Policy Design API")\r
-@SwaggerDefinition(\r
- info = @Info(\r
- description = "Policy Design API is publicly exposed for clients to Create/Read/Update/Delete"\r
- + " policy types, policy type implementation and policies which can be recognized"\r
- + " and executable by incorporated policy engines. It is an"\r
- + " independent component running rest service that takes all policy design API calls"\r
- + " from clients and then assign them to different API working functions. Besides"\r
- + " that, API is also exposed for clients to retrieve healthcheck status of this API"\r
- + " rest service and the statistics report including the counters of API invocation.",\r
- version = "1.0.0", title = "Policy Design",\r
- extensions = {@Extension(properties = {@ExtensionProperty(name = "planned-retirement-date", value = "tbd"),\r
- @ExtensionProperty(name = "component", value = "Policy Framework")})}),\r
- schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},\r
- securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))\r
@RequiredArgsConstructor\r
-public class ApiRestController extends CommonRestController {\r
+@Profile("default")\r
+public class ApiRestController extends CommonRestController implements PolicyDesignApi {\r
\r
private enum Target {\r
POLICY,\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/healthcheck")\r
- @ApiOperation(value = "Perform a system healthcheck", notes = "Returns healthy status of the Policy API component",\r
- response = HealthCheckReport.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"HealthCheck", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
- public ResponseEntity<HealthCheckReport> getHealthCheck(\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
- updateApiStatisticsCounter(Target.OTHER, HttpStatus.OK, HttpMethod.GET);\r
- return makeOkResponse(requestId, healthCheckProvider.performHealthCheck());\r
+ @Override\r
+ public ResponseEntity<HealthCheckReport> getHealthCheck(UUID requestId) {\r
+ final var report = healthCheckProvider.performHealthCheck();\r
+ updateApiStatisticsCounter(Target.OTHER, HttpStatus.resolve(report.getCode()), HttpMethod.GET);\r
+ return makeResponse(requestId, report, report.getCode());\r
}\r
\r
/**\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/statistics")\r
- @ApiOperation(value = "Retrieve current statistics",\r
- notes = "Returns current statistics including the counters of API invocation",\r
- response = StatisticsReport.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Statistics", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
- public ResponseEntity<StatisticsReport> getStatistics(\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ @Override\r
+ public ResponseEntity<StatisticsReport> getStatistics(UUID requestId) {\r
updateApiStatisticsCounter(Target.OTHER, HttpStatus.OK, HttpMethod.GET);\r
return makeOkResponse(requestId, statisticsProvider.fetchCurrentStatistics());\r
}\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes")\r
- @ApiOperation(value = "Retrieve existing policy types",\r
- notes = "Returns a list of existing policy types stored in Policy Framework",\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
- public ResponseEntity<ToscaServiceTemplate> getAllPolicyTypes(\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ @Override\r
+ public ResponseEntity<ToscaServiceTemplate> getAllPolicyTypes(UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(null, null);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}")\r
- @ApiOperation(value = "Retrieve all available versions of a policy type",\r
- notes = "Returns a list of all available versions for the specified policy type",\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicyType(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ String policyTypeId,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, null);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}/versions/{versionId}")\r
- @ApiOperation(value = "Retrieve one particular version of a policy type",\r
- notes = "Returns a particular version for the specified policy type", response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicyType(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("versionId") @ApiParam(value = "Version of policy type", required = true) String versionId,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ String policyTypeId,\r
+ String versionId,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.fetchPolicyTypes(policyTypeId, versionId);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}/versions/latest")\r
- @ApiOperation(value = "Retrieve latest version of a policy type",\r
- notes = "Returns latest version for the specified policy type", response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicyType(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ String policyTypeId,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService.fetchLatestPolicyTypes(policyTypeId);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, HttpStatus.OK, HttpMethod.GET);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @PostMapping("/policytypes")\r
- @ApiOperation(value = "Create a new policy type", notes = "Client should provide TOSCA body of the new policy type",\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_BAD_REQUEST, message = INVALID_BODY_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_ACCEPTABLE, message = INVALID_PAYLOAD_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> createPolicyType(\r
- @RequestBody @ApiParam(value = "Entity body of policy type", required = true) ToscaServiceTemplate body,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ ToscaServiceTemplate body,\r
+ UUID requestId) {\r
if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policytypes", toJson(body));\r
}\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @DeleteMapping("/policytypes/{policyTypeId}/versions/{versionId}")\r
- @ApiOperation(value = "Delete one version of a policy type",\r
- notes = "Rule 1: pre-defined policy types cannot be deleted;"\r
- + "Rule 2: policy types that are in use (parameterized by a TOSCA policy) cannot be deleted."\r
- + "The parameterizing TOSCA policies must be deleted first;",\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"PolicyType", },\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_CONFLICT, message = HTTP_CONFLICT_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicyType(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("versionId") @ApiParam(value = "Version of policy type", required = true) String versionId,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ String policyTypeId,\r
+ String versionId,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.deletePolicyType(policyTypeId, versionId);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")\r
- @ApiOperation(\r
- value = "Retrieve all versions of a policy created for a particular policy type version",\r
- notes = "Returns a list of all versions of specified policy created for the specified policy type version",\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy,"},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")\r
- })\r
- }\r
- )\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)\r
- })\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getAllPolicies(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",\r
- required = true) String policyTypeVersion,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare"\r
- + " policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, null, null, mode);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}")\r
- @ApiOperation(value = "Retrieve all version details of a policy created for a particular policy type version",\r
- notes = "Returns a list of all version details of the specified policy", response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")\r
- })\r
- }\r
- )\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)\r
- })\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getAllVersionsOfPolicy(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",\r
- required = true) String policyTypeVersion,\r
- @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestParam(name = "mode", defaultValue = "bare")\r
- @ApiParam("Fetch mode for policies, BARE for bare policies (default),"\r
- + " REFERENCED for fully referenced policies") PolicyFetchMode mode) {\r
+ String policyId,\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.fetchPolicies(policyTypeId, policyTypeVersion, policyId, null, mode);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}")\r
- @ApiOperation(value = "Retrieve one version of a policy created for a particular policy type version",\r
- notes = "Returns a particular version of specified policy created for the specified policy type version",\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")\r
- })\r
- }\r
- )\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)\r
- })\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getSpecificVersionOfPolicy(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",\r
- required = true) String policyTypeVersion,\r
- @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
- @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare policies"\r
- + " (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {\r
+ String policyId,\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ String policyVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate = toscaServiceTemplateService\r
.fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion, mode);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/latest")\r
- @ApiOperation(value = "Retrieve the latest version of a particular policy",\r
- notes = "Returns the latest version of specified policy", response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getLatestVersionOfPolicy(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",\r
- required = true) String policyTypeVersion,\r
- @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, TERSE for bare "\r
- + "policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {\r
+ String policyId,\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId, mode);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @PostMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies")\r
- @ApiOperation(value = "Create a new policy for a policy type version",\r
- notes = "Client should provide TOSCA body of the new policy",\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_BAD_REQUEST, message = INVALID_BODY_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_ACCEPTABLE, message = INVALID_PAYLOAD_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> createPolicy(\r
- @PathVariable("policyTypeId") @ApiParam(value = "ID of policy type", required = true) String policyTypeId,\r
- @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",\r
- required = true) String policyTypeVersion,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestBody @ApiParam(value = "Entity body of policy", required = true) ToscaServiceTemplate body) {\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ ToscaServiceTemplate body,\r
+ UUID requestId) {\r
if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST,\r
"/policytypes/" + policyTypeId + "/versions/" + policyTypeVersion + "/policies", toJson(body));\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @DeleteMapping("/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/"\r
- + "versions/{policyVersion}")\r
- @ApiOperation(value = "Delete a particular version of a policy",\r
- notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Dublin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_CONFLICT, message = HTTP_CONFLICT_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> deleteSpecificVersionOfPolicy(\r
- @PathVariable("policyTypeId") @ApiParam(value = "PolicyType ID", required = true) String policyTypeId,\r
- @PathVariable("policyTypeVersion") @ApiParam(value = "Version of policy type",\r
- required = true) String policyTypeVersion,\r
- @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
- @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ String policyTypeId,\r
+ String policyTypeVersion,\r
+ String policyId,\r
+ String policyVersion,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policies")\r
- @ApiOperation(value = "Retrieve all versions of available policies",\r
- notes = "Returns all version of available policies",\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Guilin")\r
- })\r
- }\r
- )\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)\r
- })\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getPolicies(\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare"\r
- + " policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.fetchPolicies(null, null, null, null, mode);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @GetMapping("/policies/{policyId}/versions/{policyVersion}")\r
- @ApiOperation(value = "Retrieve specific version of a specified policy",\r
- notes = "Returns a particular version of specified policy",\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Guilin")\r
- })\r
- }\r
- )\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)\r
- })\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> getSpecificPolicy(\r
- @PathVariable("policyId") @ApiParam(value = "Name of policy", required = true) String policyId,\r
- @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestParam(name = "mode", defaultValue = "bare") @ApiParam("Fetch mode for policies, BARE for bare"\r
- + " policies (default), REFERENCED for fully referenced policies") PolicyFetchMode mode) {\r
+ String policyId,\r
+ String policyVersion,\r
+ PolicyFetchMode mode,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.fetchPolicies(null, null, policyId, policyVersion, mode);\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @PostMapping("/policies")\r
- @ApiOperation(value = "Create one or more new policies",\r
- notes = "Client should provide TOSCA body of the new polic(ies)",\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "El Alto")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_BAD_REQUEST, message = INVALID_BODY_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_ACCEPTABLE, message = INVALID_PAYLOAD_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> createPolicies(\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,\r
- @RequestBody @ApiParam(value = "Entity body of policy", required = true) ToscaServiceTemplate body) {\r
+ ToscaServiceTemplate body,\r
+ UUID requestId) {\r
if (NetLoggerUtil.getNetworkLogger().isInfoEnabled()) {\r
NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, "/policies", toJson(body));\r
}\r
*\r
* @return the Response object containing the results of the API operation\r
*/\r
- @DeleteMapping("/policies/{policyId}/versions/{policyVersion}")\r
- @ApiOperation(value = "Delete a particular version of a policy",\r
- notes = "Rule: the version that has been deployed in PDP group(s) cannot be deleted",\r
- authorizations = @Authorization(value = AUTHORIZATION_TYPE), tags = {"Policy", },\r
- response = ToscaServiceTemplate.class,\r
- responseHeaders = {\r
- @ResponseHeader(name = VERSION_MINOR_NAME,\r
- description = VERSION_MINOR_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_PATCH_NAME,\r
- description = VERSION_PATCH_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,\r
- response = String.class),\r
- @ResponseHeader(name = REQUEST_ID_NAME,\r
- description = REQUEST_ID_HDR_DESCRIPTION, response = UUID.class)},\r
- extensions = {\r
- @Extension(name = EXTENSION_NAME, properties = {\r
- @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),\r
- @ExtensionProperty(name = LAST_MOD_NAME, value = "Guilin")})})\r
- @ApiResponses(value = {\r
- @ApiResponse(code = HttpURLConnection.HTTP_UNAUTHORIZED, message = AUTHENTICATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = AUTHORIZATION_ERROR_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_NOT_FOUND, message = NOT_FOUND_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_CONFLICT, message = HTTP_CONFLICT_MESSAGE),\r
- @ApiResponse(code = HttpURLConnection.HTTP_INTERNAL_ERROR, message = SERVER_ERROR_MESSAGE)})\r
+ @Override\r
public ResponseEntity<ToscaServiceTemplate> deleteSpecificPolicy(\r
- @PathVariable("policyId") @ApiParam(value = "ID of policy", required = true) String policyId,\r
- @PathVariable("policyVersion") @ApiParam(value = "Version of policy", required = true) String policyVersion,\r
- @RequestHeader(name = REQUEST_ID_NAME, required = false)\r
- @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId) {\r
+ String policyId,\r
+ String policyVersion,\r
+ UUID requestId) {\r
try {\r
ToscaServiceTemplate serviceTemplate =\r
toscaServiceTemplateService.deletePolicy(null, null, policyId, policyVersion);\r
}\r
}\r
}\r
-}
\ No newline at end of file
+}\r
Code Review / policy / api.git / blobdiff