-/*-\r
- * ============LICENSE_START=======================================================\r
- * SDC\r
- * ================================================================================\r
- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\r
- * ================================================================================\r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- * \r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- * \r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- * ============LICENSE_END=========================================================\r
- */\r
-\r
-package org.openecomp.sdc.be.servlets;\r
-\r
-import javax.inject.Inject;\r
-import javax.inject.Singleton;\r
-import javax.servlet.http.HttpServletRequest;\r
-import javax.ws.rs.Consumes;\r
-import javax.ws.rs.HeaderParam;\r
-import javax.ws.rs.POST;\r
-import javax.ws.rs.Path;\r
-import javax.ws.rs.PathParam;\r
-import javax.ws.rs.Produces;\r
-import javax.ws.rs.core.Context;\r
-import javax.ws.rs.core.MediaType;\r
-import javax.ws.rs.core.Response;\r
-import org.openecomp.sdc.be.components.lifecycle.LifecycleBusinessLogic;\r
-import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoBase;\r
-import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoWithAction;\r
-import org.openecomp.sdc.be.config.BeEcompErrorManager;\r
-import org.openecomp.sdc.be.dao.api.ActionStatus;\r
-import org.openecomp.sdc.be.datamodel.utils.UiComponentDataConverter;\r
-import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;\r
-import org.openecomp.sdc.be.impl.ComponentsUtils;\r
-import org.openecomp.sdc.be.model.Component;\r
-import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;\r
-import org.openecomp.sdc.be.model.User;\r
-import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;\r
-import org.openecomp.sdc.be.ui.model.UiComponentMetadata;\r
-import org.openecomp.sdc.be.user.UserBusinessLogic;\r
-import org.openecomp.sdc.common.api.Constants;\r
-import org.openecomp.sdc.common.log.wrappers.Logger;\r
-import org.openecomp.sdc.exception.ResponseFormat;\r
-import com.fasterxml.jackson.databind.ObjectMapper;\r
-import com.jcabi.aspects.Loggable;\r
-import fj.data.Either;\r
-import io.swagger.v3.oas.annotations.OpenAPIDefinition;\r
-import io.swagger.v3.oas.annotations.Operation;\r
-import io.swagger.v3.oas.annotations.Parameter;\r
-import io.swagger.v3.oas.annotations.info.Info;\r
-import io.swagger.v3.oas.annotations.media.ArraySchema;\r
-import io.swagger.v3.oas.annotations.media.Content;\r
-import io.swagger.v3.oas.annotations.media.Schema;\r
-import io.swagger.v3.oas.annotations.responses.ApiResponse;\r
-import io.swagger.v3.oas.annotations.responses.ApiResponses;\r
-\r
-@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)\r
-@Path("/v1/catalog")\r
-@OpenAPIDefinition(info = @Info(title = "Lifecycle Actions Servlet", description = "Lifecycle Actions Servlet"))\r
-@Singleton\r
-public class LifecycleServlet extends BeGenericServlet {\r
-\r
- private static final Logger log = Logger.getLogger(LifecycleServlet.class);\r
- private final LifecycleBusinessLogic lifecycleBusinessLogic;\r
-\r
- @Inject\r
- public LifecycleServlet(UserBusinessLogic userBusinessLogic,\r
- ComponentsUtils componentsUtils,\r
- LifecycleBusinessLogic lifecycleBusinessLogic) {\r
- super(userBusinessLogic, componentsUtils);\r
- this.lifecycleBusinessLogic = lifecycleBusinessLogic;\r
- }\r
-\r
-\r
- @POST\r
- @Path("/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}")\r
- @Consumes(MediaType.APPLICATION_JSON)\r
- @Produces(MediaType.APPLICATION_JSON)\r
- @Operation(description = "Change Resource lifecycle State", method = "POST", responses = @ApiResponse(\r
- content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))\r
- @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Resource state changed"),\r
- @ApiResponse(responseCode = "403", description = "Restricted operation"),\r
- @ApiResponse(responseCode = "409", description = "Resource already exist")})\r
- public Response changeResourceState(\r
- @Parameter(\r
- description = "LifecycleChangeInfo - relevant for checkin, failCertification, cancelCertification",\r
- required = false) String jsonChangeInfo,\r
- @Parameter(description = "validValues: resources / services / products",\r
- schema = @Schema(allowableValues = {ComponentTypeEnum.RESOURCE_PARAM_NAME,\r
- ComponentTypeEnum.SERVICE_PARAM_NAME, ComponentTypeEnum.PRODUCT_PARAM_NAME})) @PathParam(\r
- value = "componentCollection") final String componentCollection,\r
- @Parameter(schema = @Schema(allowableValues = {\r
- "checkout, undoCheckout, checkin, certificationRequest, startCertification, failCertification, cancelCertification, certify"}),\r
- required = true) @PathParam(value = "lifecycleOperation") final String lifecycleTransition,\r
- @Parameter(description = "id of component to be changed") @PathParam(\r
- value = "componentId") final String componentId,\r
- @Context final HttpServletRequest request,\r
- @Parameter(description = "id of user initiating the operation") @HeaderParam(\r
- value = Constants.USER_ID_HEADER) String userId) {\r
-\r
- String url = request.getMethod() + " " + request.getRequestURI();\r
- log.debug("Start handle request of {}", url);\r
-\r
- Response response = null;\r
-\r
- // get modifier from graph\r
- log.debug("get modifier properties");\r
- Either<User, ResponseFormat> eitherGetUser = getUser(request, userId);\r
- if (eitherGetUser.isRight()) {\r
- return buildErrorResponse(eitherGetUser.right().value());\r
- }\r
- User user = eitherGetUser.left().value();\r
-\r
- String resourceIdLower = componentId.toLowerCase();\r
- log.debug("perform {} operation to resource with id {} ", lifecycleTransition, resourceIdLower);\r
- Either<LifeCycleTransitionEnum, Response> validateEnum = validateTransitionEnum(lifecycleTransition, user);\r
- if (validateEnum.isRight()) {\r
- return validateEnum.right().value();\r
- }\r
-\r
- LifecycleChangeInfoWithAction changeInfo = new LifecycleChangeInfoWithAction();\r
-\r
- try {\r
- if (jsonChangeInfo != null && !jsonChangeInfo.isEmpty()) {\r
- ObjectMapper mapper = new ObjectMapper();\r
- changeInfo = new LifecycleChangeInfoWithAction(\r
- mapper.readValue(jsonChangeInfo, LifecycleChangeInfoBase.class).getUserRemarks());\r
- }\r
- }\r
-\r
- catch (Exception e) {\r
- BeEcompErrorManager.getInstance().logBeInvalidJsonInput("convertJsonToObject");\r
- log.debug("failed to convert from json {}", jsonChangeInfo, e);\r
- ResponseFormat responseFormat = getComponentsUtils().getInvalidContentErrorAndAudit(user, componentId,\r
- AuditingActionEnum.CHECKOUT_RESOURCE);\r
- return buildErrorResponse(responseFormat);\r
- }\r
-\r
- try {\r
- LifeCycleTransitionEnum transitionEnum = validateEnum.left().value();\r
- ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(componentCollection);\r
- if (componentType != null) {\r
- Either<? extends Component, ResponseFormat> actionResponse =\r
- lifecycleBusinessLogic.changeComponentState(componentType, componentId, user, transitionEnum,\r
- changeInfo, false, true);\r
-\r
- if (actionResponse.isRight()) {\r
- log.info("failed to change resource state");\r
- response = buildErrorResponse(actionResponse.right().value());\r
- return response;\r
- }\r
-\r
- log.debug("change state successful !!!");\r
- UiComponentMetadata componentMetatdata =\r
- UiComponentDataConverter.convertToUiComponentMetadata(actionResponse.left().value());\r
- Object value = RepresentationUtils.toRepresentation(componentMetatdata);\r
- response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), value);\r
- return response;\r
- } else {\r
- log.info(\r
- "componentCollection \"{}\" is not valid. Supported componentCollection values are \"{}\", \"{}\" or \"{}\"",\r
- componentCollection, ComponentTypeEnum.RESOURCE_PARAM_NAME,\r
- ComponentTypeEnum.SERVICE_PARAM_NAME, ComponentTypeEnum.PRODUCT_PARAM_NAME);\r
- ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, componentId,\r
- AuditingActionEnum.CHECKOUT_RESOURCE);\r
- return buildErrorResponse(error);\r
- }\r
- } catch (Exception e) {\r
- BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Change Lifecycle State");\r
- log.debug("change lifecycle state failed with exception", e);\r
- response = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));\r
- return response;\r
-\r
- }\r
- }\r
-\r
- private Either<LifeCycleTransitionEnum, Response> validateTransitionEnum(final String lifecycleTransition, User user) {\r
- LifeCycleTransitionEnum transitionEnum = LifeCycleTransitionEnum.CHECKOUT;\r
- try {\r
- transitionEnum = LifeCycleTransitionEnum.getFromDisplayName(lifecycleTransition);\r
- } catch (IllegalArgumentException e) {\r
- log.info("state operation is not valid. operations allowed are: {}", LifeCycleTransitionEnum.valuesAsString(), e);\r
- ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, "", AuditingActionEnum.CHECKOUT_RESOURCE);\r
- return Either.right(buildErrorResponse(error));\r
- }\r
- return Either.left(transitionEnum);\r
- }\r
-\r
-}\r
+/*-
+ * ============LICENSE_START=======================================================
+ * SDC
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.sdc.be.servlets;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.jcabi.aspects.Loggable;
+import fj.data.Either;
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.info.Info;
+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.responses.ApiResponses;
+import org.openecomp.sdc.be.components.impl.aaf.AafPermission;
+import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed;
+import org.openecomp.sdc.be.components.lifecycle.LifecycleBusinessLogic;
+import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoBase;
+import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoWithAction;
+import org.openecomp.sdc.be.config.BeEcompErrorManager;
+import org.openecomp.sdc.be.dao.api.ActionStatus;
+import org.openecomp.sdc.be.datamodel.utils.UiComponentDataConverter;
+import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
+import org.openecomp.sdc.be.impl.ComponentsUtils;
+import org.openecomp.sdc.be.model.Component;
+import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;
+import org.openecomp.sdc.be.model.User;
+import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
+import org.openecomp.sdc.be.ui.model.UiComponentMetadata;
+import org.openecomp.sdc.be.user.UserBusinessLogic;
+import org.openecomp.sdc.common.api.Constants;
+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;
+
+import javax.inject.Inject;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.HeaderParam;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import java.io.IOException;
+
+@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
+@Path("/v1/catalog")
+@OpenAPIDefinition(info = @Info(title = "Lifecycle Actions Servlet", description = "Lifecycle Actions Servlet"))
+@Controller
+public class LifecycleServlet extends BeGenericServlet {
+
+ private static final Logger log = Logger.getLogger(LifecycleServlet.class);
+ private static final LoggerSupportability loggerSupportability = LoggerSupportability.getLogger(LifecycleServlet.class.getName());
+ private LifecycleBusinessLogic lifecycleBusinessLogic;
+
+ @Inject
+ public LifecycleServlet(UserBusinessLogic userBusinessLogic,
+ ComponentsUtils componentsUtils,
+ LifecycleBusinessLogic lifecycleBusinessLogic) {
+ super(userBusinessLogic, componentsUtils);
+ this.lifecycleBusinessLogic = lifecycleBusinessLogic;
+ }
+
+
+ @POST
+ @Path("/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}")
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ @Operation(description = "Change Resource lifecycle State", method = "POST", responses = @ApiResponse(
+ content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
+ @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Resource state changed"),
+ @ApiResponse(responseCode = "403", description = "Restricted operation"),
+ @ApiResponse(responseCode = "409", description = "Resource already exist")})
+ @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
+ public Response changeResourceState(
+ @Parameter(
+ description = "LifecycleChangeInfo - relevant for checkin, failCertification, cancelCertification",
+ required = false) String jsonChangeInfo,
+ @Parameter(description = "validValues: resources / services / products",
+ schema = @Schema(allowableValues = {ComponentTypeEnum.RESOURCE_PARAM_NAME,
+ ComponentTypeEnum.SERVICE_PARAM_NAME, ComponentTypeEnum.PRODUCT_PARAM_NAME})) @PathParam(
+ value = "componentCollection") final String componentCollection,
+ @Parameter(schema = @Schema(allowableValues = {
+ "checkout, undoCheckout, checkin, certificationRequest, startCertification, failCertification, cancelCertification, certify"}),
+ required = true) @PathParam(value = "lifecycleOperation") final String lifecycleTransition,
+ @Parameter(description = "id of component to be changed") @PathParam(
+ value = "componentId") final String componentId,
+ @Context final HttpServletRequest request,
+ @Parameter(description = "id of user initiating the operation") @HeaderParam(
+ value = Constants.USER_ID_HEADER) String userId) throws IOException {
+
+ String url = request.getMethod() + " " + request.getRequestURI();
+ log.debug("Start handle request of {}", url);
+ loggerSupportability.log(LoggerSupportabilityActions.CHANGELIFECYCLESTATE, StatusCode.STARTED,"Starting to change lifecycle state to " + lifecycleTransition + " by user " + userId);
+
+ Response response = null;
+
+ // get modifier from graph
+ log.debug("get modifier properties");
+ Either<User, ResponseFormat> eitherGetUser = getUser(request, userId);
+ if (eitherGetUser.isRight()) {
+ return buildErrorResponse(eitherGetUser.right().value());
+ }
+ User user = eitherGetUser.left().value();
+
+ String resourceIdLower = componentId.toLowerCase();
+ log.debug("perform {} operation to resource with id {} ", lifecycleTransition, resourceIdLower);
+ Either<LifeCycleTransitionEnum, Response> validateEnum = validateTransitionEnum(lifecycleTransition, user);
+ if (validateEnum.isRight()) {
+ return validateEnum.right().value();
+ }
+
+ LifecycleChangeInfoWithAction changeInfo = new LifecycleChangeInfoWithAction();
+
+ try {
+ if (jsonChangeInfo != null && !jsonChangeInfo.isEmpty()) {
+ ObjectMapper mapper = new ObjectMapper();
+ changeInfo = new LifecycleChangeInfoWithAction(mapper.readValue(jsonChangeInfo, LifecycleChangeInfoBase.class).getUserRemarks());
+ }
+ }
+
+ catch (Exception e) {
+ BeEcompErrorManager.getInstance().logBeInvalidJsonInput("convertJsonToObject");
+ log.debug("failed to convert from json {}", jsonChangeInfo, e);
+ getComponentsUtils().getInvalidContentErrorAndAudit(user, componentId, AuditingActionEnum.CHECKOUT_RESOURCE);
+ throw e;
+ }
+
+ LifeCycleTransitionEnum transitionEnum = validateEnum.left().value();
+ ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(componentCollection);
+ if (componentType != null) {
+ Either<? extends Component, ResponseFormat> actionResponse = lifecycleBusinessLogic.changeComponentState(componentType, componentId, user, transitionEnum, changeInfo, false, true);
+
+ if (actionResponse.isRight()) {
+ log.info("failed to change resource state");
+ loggerSupportability.log(LoggerSupportabilityActions.CHANGELIFECYCLESTATE, StatusCode.ERROR,"failed to change resource state " + lifecycleTransition + " with error " + actionResponse.isRight() + " by user " + userId);
+ response = buildErrorResponse(actionResponse.right().value());
+ return response;
+ }
+
+ log.debug("change state successful !!!");
+ UiComponentMetadata componentMetatdata = UiComponentDataConverter.convertToUiComponentMetadata(actionResponse.left().value());
+ Object value = null;
+ try {
+ value = RepresentationUtils.toRepresentation(componentMetatdata);
+ } catch (IOException e) {
+ e.printStackTrace();
+ }
+ response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), value);
+ loggerSupportability.log(LoggerSupportabilityActions.CHANGELIFECYCLESTATE,actionResponse.left().value().getComponentMetadataForSupportLog(),StatusCode.COMPLETE," change state to " + lifecycleTransition + " was successful by user" + userId);
+ return response;
+ } else {
+ log.info("componentCollection \"{}\" is not valid. Supported componentCollection values are \"{}\", \"{}\" or \"{}\"", componentCollection, ComponentTypeEnum.RESOURCE_PARAM_NAME, ComponentTypeEnum.SERVICE_PARAM_NAME,
+ ComponentTypeEnum.PRODUCT_PARAM_NAME);
+ ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, componentId, AuditingActionEnum.CHECKOUT_RESOURCE);
+ return buildErrorResponse(error);
+ }
+ }
+
+ private Either<LifeCycleTransitionEnum, Response> validateTransitionEnum(final String lifecycleTransition, User user) {
+ LifeCycleTransitionEnum transitionEnum;
+ try {
+ transitionEnum = LifeCycleTransitionEnum.getFromDisplayName(lifecycleTransition);
+ } catch (IllegalArgumentException e) {
+ log.info("state operation is not valid. operations allowed are: {}", LifeCycleTransitionEnum.valuesAsString(), e);
+ ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, "", AuditingActionEnum.CHECKOUT_RESOURCE);
+ return Either.right(buildErrorResponse(error));
+ }
+ return Either.left(transitionEnum);
+ }
+
+}
Code Review / sdc.git / blobdiff