X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=catalog-be%2Fsrc%2Fmain%2Fjava%2Forg%2Fopenecomp%2Fsdc%2Fbe%2Fservlets%2FPolicyServlet.java;h=f9449e2fc85f1a566a5172d161aa47c193f26ded;hb=5f3e9912406897ee18c424b940881ce08d59bb44;hp=cb228a1e9b34e4371af7bd41c65f05283675e860;hpb=c8fcbbc2a9cc964ba1d4b872562b8f4185047308;p=sdc.git diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java index cb228a1e9b..f9449e2fc8 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java @@ -7,9 +7,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -17,20 +17,23 @@ * limitations under the License. * ============LICENSE_END========================================================= */ - package org.openecomp.sdc.be.servlets; import com.jcabi.aspects.Loggable; import fj.data.Either; -import io.swagger.annotations.Api; -import io.swagger.annotations.ApiOperation; -import io.swagger.annotations.ApiParam; -import io.swagger.annotations.ApiResponse; -import io.swagger.annotations.ApiResponses; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.ArraySchema; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.servers.Server; +import io.swagger.v3.oas.annotations.tags.Tag; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.stream.Collectors; +import javax.inject.Inject; import javax.servlet.http.HttpServletRequest; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; @@ -45,8 +48,10 @@ import javax.ws.rs.core.Context; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import org.apache.commons.lang3.StringUtils; +import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic; import org.openecomp.sdc.be.components.impl.PolicyBusinessLogic; import org.openecomp.sdc.be.components.impl.ResourceImportManager; +import org.openecomp.sdc.be.components.impl.exceptions.ByActionStatusComponentException; import org.openecomp.sdc.be.config.BeEcompErrorManager; import org.openecomp.sdc.be.dao.api.ActionStatus; import org.openecomp.sdc.be.datatypes.elements.PolicyTargetType; @@ -59,7 +64,9 @@ import org.openecomp.sdc.be.model.PolicyDefinition; import org.openecomp.sdc.be.model.PolicyTargetDTO; import org.openecomp.sdc.be.model.Resource; import org.openecomp.sdc.common.api.Constants; -import org.openecomp.sdc.common.datastructure.Wrapper; +import org.openecomp.sdc.common.log.elements.LoggerSupportability; +import org.openecomp.sdc.common.log.enums.LoggerSupportabilityActions; +import org.openecomp.sdc.common.log.enums.StatusCode; import org.openecomp.sdc.common.log.wrappers.Logger; import org.openecomp.sdc.exception.ResponseFormat; import org.springframework.stereotype.Controller; @@ -69,16 +76,21 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Api(value = "Policy Servlet") +@Tag(name = "SDCE-2 APIs") +@Server(url = "/sdc2/rest") @Controller @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) public class PolicyServlet extends AbstractValidationsServlet { private static final Logger log = Logger.getLogger(PolicyServlet.class); + private static final LoggerSupportability loggerSupportability = LoggerSupportability.getLogger(ServiceServlet.class.getName()); private final PolicyBusinessLogic policyBusinessLogic; - public PolicyServlet(PolicyBusinessLogic policyBusinessLogic, ServletUtils servletUtils, ResourceImportManager resourceImportManager, ComponentsUtils componentsUtils) { + @Inject + public PolicyServlet(ComponentInstanceBusinessLogic componentInstanceBL, ComponentsUtils componentsUtils, + ServletUtils servletUtils, ResourceImportManager resourceImportManager, PolicyBusinessLogic policyBusinessLogic) { + super(componentInstanceBL, componentsUtils, servletUtils, resourceImportManager); this.policyBusinessLogic = policyBusinessLogic; this.servletUtils = servletUtils; this.resourceImportManager = resourceImportManager; @@ -87,283 +99,251 @@ public class PolicyServlet extends AbstractValidationsServlet { @POST @Path("/{containerComponentType}/{componentId}/policies/{policyTypeName}") - @ApiOperation(value = "Create Policy", httpMethod = "POST", notes = "Returns created Policy", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 201, message = "Policy created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"), - @ApiResponse(code = 409, message = "Policy already exist"), @ApiResponse(code = 404, message = "Component not found")}) + @Operation(description = "Create Policy", method = "POST", summary = "Returns created Policy", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "201", description = "Policy created"), @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"), + @ApiResponse(responseCode = "409", description = "Policy already exist"), + @ApiResponse(responseCode = "404", description = "Component not found")}) public Response createPolicy(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, @PathParam("policyTypeName") final String policyTypeName, - @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, @Context final HttpServletRequest request) { init(); - - Wrapper responseWrapper = new Wrapper<>(); - try { - Wrapper componentTypeWrapper = validateComponentTypeAndUserId(containerComponentType, userId, responseWrapper); - if (responseWrapper.isEmpty()) { - responseWrapper.setInnerElement(policyBusinessLogic.createPolicy(componentTypeWrapper.getInnerElement(), containerComponentId, policyTypeName, userId, true) - .either(l -> buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.CREATED), l), - this::buildErrorResponse)); - } - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Create Policy"); - log.error("Failed to create policy. The exception {} occurred. ", e); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR))); - } - return responseWrapper.getInnerElement(); + loggerSupportability + .log(LoggerSupportabilityActions.CREATE_POLICIES, StatusCode.STARTED, "Starting to create Policy by user {} containerComponentId={}", + userId, containerComponentId); + ComponentTypeEnum componentType = validateComponentTypeAndUserId(containerComponentType, userId); + PolicyDefinition policy = policyBusinessLogic.createPolicy(componentType, containerComponentId, policyTypeName, userId, true); + loggerSupportability + .log(LoggerSupportabilityActions.CREATE_POLICIES, StatusCode.COMPLETE, "Ended create Policy by user {} containerComponentId={}", userId, + containerComponentId); + return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.CREATED), policy); } @PUT @Path("/{containerComponentType}/{componentId}/policies/{policyId}") - @ApiOperation(value = "Update Policy metadata", httpMethod = "PUT", notes = "Returns updated Policy", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy updated"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"), - @ApiResponse(code = 404, message = "component / policy Not found")}) + @Operation(description = "Update Policy metadata", method = "PUT", summary = "Returns updated Policy", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "200", description = "Policy updated"), @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"), + @ApiResponse(responseCode = "404", description = "component / policy Not found")}) public Response updatePolicy(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @PathParam("policyId") final String policyId, @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, - @ApiParam(value = "PolicyDefinition", required = true) String policyData, @Context final HttpServletRequest request) { + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @PathParam("policyId") final String policyId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, + @Parameter(description = "PolicyDefinition", required = true) String policyData, + @Context final HttpServletRequest request) { init(); - - Wrapper responseWrapper = new Wrapper<>(); - try { - Wrapper componentTypeWrapper = validateComponentTypeAndUserId(containerComponentType, userId, responseWrapper); - Wrapper policyWrapper = new Wrapper<>(); - if (responseWrapper.isEmpty()) { - convertJsonToObjectOfClass(policyData, policyWrapper, PolicyDefinition.class, responseWrapper); - if (policyWrapper.isEmpty()) { - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT))); - } - } - if (!policyWrapper.isEmpty()) { - policyWrapper.getInnerElement().setUniqueId(policyId); - responseWrapper.setInnerElement(policyBusinessLogic.updatePolicy(componentTypeWrapper.getInnerElement(), containerComponentId, policyWrapper.getInnerElement(), userId, true) - .either(this::buildOkResponse, - this::buildErrorResponse)); - } - - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Update Policy"); - log.error("Failed to update policy. The exception {} occurred. ", e); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR))); - } - return responseWrapper.getInnerElement(); + loggerSupportability + .log(LoggerSupportabilityActions.UPDATE_POLICY_TARGET, StatusCode.STARTED, "Starting to update Policy by user {} containerComponentId={}", + userId, containerComponentId); + PolicyDefinition policyDefinition = convertJsonToObjectOfClass(policyData, PolicyDefinition.class); + policyDefinition.setUniqueId(policyId); + policyDefinition = policyBusinessLogic + .updatePolicy(validateComponentTypeAndUserId(containerComponentType, userId), containerComponentId, policyDefinition, userId, true); + loggerSupportability + .log(LoggerSupportabilityActions.UPDATE_POLICY_TARGET, StatusCode.COMPLETE, "Ended update Policy by user {} containerComponentId={}", + userId, containerComponentId); + return buildOkResponse(policyDefinition); } @GET @Path("/{containerComponentType}/{componentId}/policies/{policyId}") - @ApiOperation(value = "Get Policy", httpMethod = "GET", notes = "Returns Policy", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy was found"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"), - @ApiResponse(code = 404, message = "component / policy Not found")}) + @Operation(description = "Get Policy", method = "GET", summary = "Returns Policy", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "200", description = "Policy was found"), + @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"), + @ApiResponse(responseCode = "404", description = "component / policy Not found")}) public Response getPolicy(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @PathParam("policyId") final String policyId, @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @PathParam("policyId") final String policyId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, @Context final HttpServletRequest request) { init(); - - Wrapper responseWrapper = new Wrapper<>(); - try { - Wrapper componentTypeWrapper = validateComponentTypeAndUserId(containerComponentType, userId, responseWrapper); - if (responseWrapper.isEmpty()) { - responseWrapper.setInnerElement(policyBusinessLogic.getPolicy(componentTypeWrapper.getInnerElement(), containerComponentId, policyId, userId) - .either(this::buildOkResponse, - this::buildErrorResponse)); - } - - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Policy"); - log.error("Failed to retrieve policy. The exception {} occurred. ", e); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR))); - } - return responseWrapper.getInnerElement(); + PolicyDefinition policy = policyBusinessLogic + .getPolicy(validateComponentTypeAndUserId(containerComponentType, userId), containerComponentId, policyId, userId); + return buildOkResponse(policy); } @DELETE @Path("/{containerComponentType}/{componentId}/policies/{policyId}") - @ApiOperation(value = "Delete Policy", httpMethod = "DELETE", notes = "No body", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy was deleted"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"), - @ApiResponse(code = 404, message = "component / policy Not found")}) + @Operation(description = "Delete Policy", method = "DELETE", summary = "No body", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "204", description = "Policy was deleted"), + @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"), + @ApiResponse(responseCode = "404", description = "component / policy Not found")}) public Response deletePolicy(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @PathParam("policyId") final String policyId, @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @PathParam("policyId") final String policyId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, @Context final HttpServletRequest request) { init(); - - Wrapper responseWrapper = new Wrapper<>(); - try { - Wrapper componentTypeWrapper = validateComponentTypeAndUserId(containerComponentType, userId, responseWrapper); - if (responseWrapper.isEmpty()) { - responseWrapper.setInnerElement(policyBusinessLogic.deletePolicy(componentTypeWrapper.getInnerElement(), containerComponentId, policyId, userId, true) - .either(this::buildOkResponse, - this::buildErrorResponse)); - } - - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Delete Policy"); - log.error("Failed to delete policy. The exception {} occurred. ", e); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR))); - } - return responseWrapper.getInnerElement(); + ComponentTypeEnum componentTypeEnum = validateComponentTypeAndUserId(containerComponentType, userId); + PolicyDefinition policyDefinition = policyBusinessLogic.deletePolicy(componentTypeEnum, containerComponentId, policyId, userId, true); + return buildOkResponse(policyDefinition); } @PUT @Path("/{containerComponentType}/{componentId}/policies/{policyId}/undeclare") - @ApiOperation(value = "undeclare Policy", httpMethod = "PUT", notes = "No body", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 204, message = "Policy was undeclared"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"), - @ApiResponse(code = 404, message = "component / policy Not found")}) + @Operation(description = "undeclare Policy", method = "PUT", summary = "No body", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "204", description = "Policy was undeclared"), + @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"), + @ApiResponse(responseCode = "404", description = "component / policy Not found")}) public Response undeclarePolicy(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @PathParam("policyId") final String policyId, @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, - @Context final HttpServletRequest request) { + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @PathParam("policyId") final String policyId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, + @Context final HttpServletRequest request) { init(); - - Wrapper responseWrapper = new Wrapper<>(); + Response response = null; try { - Wrapper componentTypeWrapper = validateComponentTypeAndUserId(containerComponentType, userId, responseWrapper); - if (responseWrapper.isEmpty()) { - responseWrapper.setInnerElement(policyBusinessLogic.undeclarePolicy(componentTypeWrapper.getInnerElement(), containerComponentId, policyId, userId, true) - .either(this::buildOkResponse, - this::buildErrorResponse)); + ComponentTypeEnum componentTypeEnum = validateComponentTypeAndUserId(containerComponentType, userId); + Either undeclarePolicy = policyBusinessLogic + .undeclarePolicy(componentTypeEnum, containerComponentId, policyId, userId, true); + if (undeclarePolicy.isLeft()) { + response = buildOkResponse(undeclarePolicy.left().value()); + } else { + response = buildErrorResponse(undeclarePolicy.right().value()); } - } catch (Exception e) { BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Undeclare Policy"); log.error("Failed to undeclare policy. The exception {} occurred. ", e); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR))); } - return responseWrapper.getInnerElement(); + return response; } @GET @Path("/{containerComponentType}/{componentId}/policies/{policyId}/properties") - @ApiOperation(value = "Get component policy properties", httpMethod = "GET", notes = "Returns component policy properties", response = PropertyDataDefinition.class, responseContainer="List") - @ApiResponses(value = {@ApiResponse(code = 200, message = "Properties found"),@ApiResponse(code = 400, message = "invalid content - Error: containerComponentType is invalid"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 404, message = "Componentorpolicy not found"), - @ApiResponse(code = 500, message = "The GET request failed due to internal SDC problem.") })public Response getPolicyProperties(@ApiParam(value = "the id of the component which is the container of the policy") @PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @ApiParam(value = "the id of the policy which its properties are to return") @PathParam("policyId") final String policyId, - @ApiParam(value = "the userid", required = true)@HeaderParam(value = Constants.USER_ID_HEADER) String userId, - @Context final HttpServletRequest request) { + @Operation(description = "Get component policy properties", method = "GET", summary = "Returns component policy properties", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = PropertyDataDefinition.class)))), + @ApiResponse(responseCode = "200", description = "Properties found"), + @ApiResponse(responseCode = "400", description = "invalid content - Error: containerComponentType is invalid"), + @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "404", description = "Componentorpolicy not found"), + @ApiResponse(responseCode = "500", description = "The GET request failed due to internal SDC problem.")}) + public Response getPolicyProperties( + @Parameter(description = "the id of the component which is the container of the policy") @PathParam("componentId") final String containerComponentId, + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = {ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @Parameter(description = "the id of the policy which its properties are to return") @PathParam("policyId") final String policyId, + @Parameter(description = "the userid", required = true) @HeaderParam(value = Constants.USER_ID_HEADER) String userId, + @Context final HttpServletRequest request) { init(); - try { - return convertToComponentType(containerComponentType) - .left() - .bind(cmptType -> policyBusinessLogic.getPolicyProperties(cmptType, containerComponentId, policyId, userId)) - .either(this::buildOkResponse, - this::buildErrorResponse); - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("get Policy properties"); - log.debug("#getPolicyProperties - get Policy properties has failed.", e); - return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR)); - } - - + List propertyDataDefinitionList = policyBusinessLogic + .getPolicyProperties(convertToComponentType(containerComponentType), containerComponentId, policyId, userId); + return buildOkResponse(propertyDataDefinitionList); } @PUT @Path("/{containerComponentType}/{componentId}/policies/{policyId}/properties") - @ApiOperation(value = "Update Policy properties", httpMethod = "PUT", notes = "Returns updated Policy", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 200, message = "Policy properties updated"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"), - @ApiResponse(code = 404, message = "component / policy Not found")}) + @Operation(description = "Update Policy properties", method = "PUT", summary = "Returns updated Policy", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "200", description = "Policy properties updated"), + @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"), + @ApiResponse(responseCode = "404", description = "component / policy Not found")}) public Response updatePolicyProperties(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @PathParam("policyId") final String policyId, @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, - @ApiParam(value = "PolicyDefinition", required = true) String policyData, @Context final HttpServletRequest request) { + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @PathParam("policyId") final String policyId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, + @Parameter(description = "PolicyDefinition", required = true) String policyData, + @Context final HttpServletRequest request) { init(); - Wrapper responseWrapper = new Wrapper<>(); - try { - Wrapper componentTypeWrapper = validateComponentTypeAndUserId(containerComponentType, userId, responseWrapper); - Wrapper propertiesWrapper = new Wrapper<>(); - if (responseWrapper.isEmpty()) { - convertJsonToObjectOfClass(policyData, propertiesWrapper, PropertyDataDefinition[].class, responseWrapper); - if (propertiesWrapper.isEmpty()) { - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT))); - } - } - if (!propertiesWrapper.isEmpty()) { - responseWrapper.setInnerElement( - policyBusinessLogic.updatePolicyProperties(componentTypeWrapper.getInnerElement(), containerComponentId, policyId, propertiesWrapper.getInnerElement(), userId, true) - .either(this::buildOkResponse, this::buildErrorResponse)); - } - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Update Policy"); - log.error("Failed to update policy. The exception {} occurred. ", e); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR))); - } - return responseWrapper.getInnerElement(); + loggerSupportability.log(LoggerSupportabilityActions.UPDATE_POLICIES_PROPERTIES, StatusCode.STARTED, + "Starting to update Policy Properties by user {} containerComponentId={}", userId, containerComponentId); + ComponentTypeEnum componentTypeEnum = validateComponentTypeAndUserId(containerComponentType, userId); + PropertyDataDefinition[] propertyDataDefinitions = convertJsonToObjectOfClass(policyData, PropertyDataDefinition[].class); + List propertyDataDefinitionList = policyBusinessLogic + .updatePolicyProperties(componentTypeEnum, containerComponentId, policyId, propertyDataDefinitions, userId, true); + loggerSupportability.log(LoggerSupportabilityActions.UPDATE_POLICIES_PROPERTIES, StatusCode.STARTED, + "Starting to update Policy Properties by user {} containerComponentId={}", userId, containerComponentId); + return buildOkResponse(propertyDataDefinitionList); } - private Wrapper validateComponentTypeAndUserId(final String containerComponentType, String userId, Wrapper responseWrapper) { - Wrapper componentTypeWrapper = new Wrapper<>(); + private ComponentTypeEnum validateComponentTypeAndUserId(final String containerComponentType, String userId) { if (StringUtils.isEmpty(userId)) { log.error("Missing userId HTTP header. "); - responseWrapper.setInnerElement(buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.MISSING_USER_ID))); - } - if (responseWrapper.isEmpty()) { - validateComponentType(responseWrapper, componentTypeWrapper, containerComponentType); + throw new ByActionStatusComponentException(ActionStatus.MISSING_USER_ID); } - return componentTypeWrapper; + return validateComponentType(containerComponentType); } - @POST - @Path("/{containerComponentType}/{componentId}/policies/{policyId}/targets") - @Consumes(MediaType.APPLICATION_JSON) - @Produces(MediaType.APPLICATION_JSON) - @ApiOperation(value = "update policy targets", httpMethod = "POST", notes = "Returns updated Policy", response = Response.class) - @ApiResponses(value = {@ApiResponse(code = 201, message = "Policy target updated"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content")}) - public Response updatePolicyTargets(@PathParam("componentId") final String containerComponentId, - @ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("containerComponentType") final String containerComponentType, - @PathParam("policyId") final String policyId, - @HeaderParam(value = Constants.USER_ID_HEADER) @ApiParam(value = "USER_ID of modifier user", required = true) String userId, - @Context final HttpServletRequest request, - List requestJson) { - try { - - return updatePolicyTargetsFromDTO(requestJson) - .left() - .bind(policyTarget -> updatePolicyTargetsFromMap(policyTarget, containerComponentType, containerComponentId, policyId, userId)) - .either(this::buildOkResponse, this::buildErrorResponse); - - } catch (Exception e) { - BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Create Policy"); - log.debug("Policy target update has been failed with the exception{}. ", e); - return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR)); - } + @POST + @Path("/{containerComponentType}/{componentId}/policies/{policyId}/targets") + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + @Operation(description = "update policy targets", method = "POST", summary = "Returns updated Policy", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))), + @ApiResponse(responseCode = "201", description = "Policy target updated"), + @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")}) + public Response updatePolicyTargets(@PathParam("componentId") final String containerComponentId, + @Parameter(description = "valid values: resources / services", schema = @Schema(allowableValues = { + ComponentTypeEnum.RESOURCE_PARAM_NAME, + ComponentTypeEnum.SERVICE_PARAM_NAME})) @PathParam("containerComponentType") final String containerComponentType, + @PathParam("policyId") final String policyId, + @HeaderParam(value = Constants.USER_ID_HEADER) @Parameter(description = "USER_ID of modifier user", required = true) String userId, + @Context final HttpServletRequest request, List requestJson) { + Map> policyTargetTypeListMap = updatePolicyTargetsFromDTO(requestJson); + PolicyDefinition policyDefinition = updatePolicyTargetsFromMap(policyTargetTypeListMap, containerComponentType, containerComponentId, + policyId, userId); + return buildOkResponse(policyDefinition); } @POST @Path("/{componentType}/{componentId}/create/policies") - @ApiOperation(value = "Create policies on service", httpMethod = "POST", notes = "Return policies list", response = Resource.class) - @ApiResponses(value = { @ApiResponse(code = 200, message = "Component found"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 404, message = "Component not found") }) - public Response declareProperties(@PathParam("componentType") final String componentType, @PathParam("componentId") final String componentId, @Context final HttpServletRequest request, - @HeaderParam(value = Constants.USER_ID_HEADER) String userId, @ApiParam(value = "ComponentIns policies Object to be created", required = true) String componentInstPoliciesMapObj) { - - return super.declareProperties(userId, componentId, componentType, componentInstPoliciesMapObj, - DeclarationTypeEnum.POLICY, request); + @Operation(description = "Create policies on service", method = "POST", summary = "Return policies list", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Resource.class)))), + @ApiResponse(responseCode = "200", description = "Component found"), @ApiResponse(responseCode = "403", description = "Restricted operation"), + @ApiResponse(responseCode = "404", description = "Component not found")}) + public Response declareProperties(@PathParam("componentType") final String componentType, @PathParam("componentId") final String componentId, + @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId, + @Parameter(description = "ComponentIns policies Object to be created", required = true) String componentInstPoliciesMapObj) { + return super.declareProperties(userId, componentId, componentType, componentInstPoliciesMapObj, DeclarationTypeEnum.POLICY, request); } - private Either updatePolicyTargetsFromMap(Map> policyTarget, String containerComponentType, String containerComponentId, String policyId, String userId) { - return convertToComponentType(containerComponentType) - .left() - .bind(cmptType -> policyBusinessLogic.updatePolicyTargets(cmptType, containerComponentId, policyId, policyTarget, userId)); + private PolicyDefinition updatePolicyTargetsFromMap(Map> policyTarget, String containerComponentType, + String containerComponentId, String policyId, String userId) { + ComponentTypeEnum componentTypeEnum = convertToComponentType(containerComponentType); + return policyBusinessLogic.updatePolicyTargets(componentTypeEnum, containerComponentId, policyId, policyTarget, userId); } - private Either>, ResponseFormat> updatePolicyTargetsFromDTO(List targetDTOList) { + private Map> updatePolicyTargetsFromDTO(List targetDTOList) { + loggerSupportability.log(LoggerSupportabilityActions.UPDATE_POLICY_TARGET, StatusCode.STARTED, "Starting to update Policy target"); Map> policyTarget = new HashMap<>(); for (PolicyTargetDTO currentTarget : targetDTOList) { - if(!addTargetsByType(policyTarget, currentTarget.getType(), currentTarget.getUniqueIds())){ - return Either.right(componentsUtils.getResponseFormat(ActionStatus.POLICY_TARGET_TYPE_DOES_NOT_EXIST, currentTarget.getType())); + if (!addTargetsByType(policyTarget, currentTarget.getType(), currentTarget.getUniqueIds())) { + throw new ByActionStatusComponentException(ActionStatus.POLICY_TARGET_TYPE_DOES_NOT_EXIST, currentTarget.getType()); } } - return Either.left(policyTarget); + loggerSupportability.log(LoggerSupportabilityActions.UPDATE_POLICY_TARGET, StatusCode.COMPLETE, "Ended update Policy target"); + return policyTarget; } - public boolean addTargetsByType(Map> policyTarget, String type, List uniqueIds) { PolicyTargetType targetTypeEnum = PolicyTargetType.getByNameIgnoreCase(type); - if(targetTypeEnum != null){ + if (targetTypeEnum != null) { policyTarget.put(targetTypeEnum, validateUniquenessOfIds(uniqueIds)); return true; - } - else{ + } else { return false; } }