2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.openecomp.sdc.be.servlets;
23 import com.fasterxml.jackson.databind.ObjectMapper;
24 import com.jcabi.aspects.Loggable;
25 import fj.data.Either;
26 import io.swagger.v3.oas.annotations.Operation;
27 import io.swagger.v3.oas.annotations.Parameter;
28 import io.swagger.v3.oas.annotations.media.ArraySchema;
29 import io.swagger.v3.oas.annotations.media.Content;
30 import io.swagger.v3.oas.annotations.media.Schema;
31 import io.swagger.v3.oas.annotations.responses.ApiResponse;
32 import io.swagger.v3.oas.annotations.servers.Server;
33 import io.swagger.v3.oas.annotations.servers.Servers;
34 import io.swagger.v3.oas.annotations.tags.Tag;
35 import io.swagger.v3.oas.annotations.tags.Tags;
36 import org.openecomp.sdc.be.components.impl.aaf.AafPermission;
37 import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed;
38 import org.openecomp.sdc.be.components.lifecycle.LifecycleBusinessLogic;
39 import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoBase;
40 import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoWithAction;
41 import org.openecomp.sdc.be.config.BeEcompErrorManager;
42 import org.openecomp.sdc.be.dao.api.ActionStatus;
43 import org.openecomp.sdc.be.datamodel.utils.UiComponentDataConverter;
44 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
45 import org.openecomp.sdc.be.impl.ComponentsUtils;
46 import org.openecomp.sdc.be.model.Component;
47 import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;
48 import org.openecomp.sdc.be.model.User;
49 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
50 import org.openecomp.sdc.be.ui.model.UiComponentMetadata;
51 import org.openecomp.sdc.be.user.UserBusinessLogic;
52 import org.openecomp.sdc.common.api.Constants;
53 import org.openecomp.sdc.common.log.elements.LoggerSupportability;
54 import org.openecomp.sdc.common.log.enums.LoggerSupportabilityActions;
55 import org.openecomp.sdc.common.log.enums.StatusCode;
56 import org.openecomp.sdc.common.log.wrappers.Logger;
57 import org.openecomp.sdc.exception.ResponseFormat;
58 import org.springframework.stereotype.Controller;
60 import javax.inject.Inject;
61 import javax.servlet.http.HttpServletRequest;
62 import javax.ws.rs.Consumes;
63 import javax.ws.rs.HeaderParam;
64 import javax.ws.rs.POST;
65 import javax.ws.rs.Path;
66 import javax.ws.rs.PathParam;
67 import javax.ws.rs.Produces;
68 import javax.ws.rs.core.Context;
69 import javax.ws.rs.core.MediaType;
70 import javax.ws.rs.core.Response;
71 import java.io.IOException;
73 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
75 @Tags({@Tag(name = "SDC Internal APIs")})
76 @Servers({@Server(url = "/sdc2/rest")})
78 public class LifecycleServlet extends BeGenericServlet {
80 private static final Logger log = Logger.getLogger(LifecycleServlet.class);
81 private static final LoggerSupportability loggerSupportability = LoggerSupportability.getLogger(LifecycleServlet.class.getName());
82 private LifecycleBusinessLogic lifecycleBusinessLogic;
85 public LifecycleServlet(UserBusinessLogic userBusinessLogic,
86 ComponentsUtils componentsUtils,
87 LifecycleBusinessLogic lifecycleBusinessLogic) {
88 super(userBusinessLogic, componentsUtils);
89 this.lifecycleBusinessLogic = lifecycleBusinessLogic;
94 @Path("/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}")
95 @Consumes(MediaType.APPLICATION_JSON)
96 @Produces(MediaType.APPLICATION_JSON)
97 @Operation(description = "Change Resource lifecycle State", method = "POST", responses = {
98 @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
99 @ApiResponse(responseCode = "200", description = "Resource state changed"),
100 @ApiResponse(responseCode = "403", description = "Restricted operation"),
101 @ApiResponse(responseCode = "409", description = "Resource already exist")})
102 @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
103 public Response changeResourceState(
105 description = "LifecycleChangeInfo - relevant for checkin, failCertification, cancelCertification",
106 required = false) String jsonChangeInfo,
107 @Parameter(description = "validValues: resources / services / products",
108 schema = @Schema(allowableValues = {ComponentTypeEnum.RESOURCE_PARAM_NAME,
109 ComponentTypeEnum.SERVICE_PARAM_NAME, ComponentTypeEnum.PRODUCT_PARAM_NAME})) @PathParam(
110 value = "componentCollection") final String componentCollection,
111 @Parameter(schema = @Schema(allowableValues = {
112 "checkout, undoCheckout, checkin, certificationRequest, startCertification, failCertification, cancelCertification, certify"}),
113 required = true) @PathParam(value = "lifecycleOperation") final String lifecycleTransition,
114 @Parameter(description = "id of component to be changed") @PathParam(
115 value = "componentId") final String componentId,
116 @Context final HttpServletRequest request,
117 @Parameter(description = "id of user initiating the operation") @HeaderParam(
118 value = Constants.USER_ID_HEADER) String userId) throws IOException {
120 String url = request.getMethod() + " " + request.getRequestURI();
121 log.debug("Start handle request of {}", url);
122 loggerSupportability.log(LoggerSupportabilityActions.CHANGELIFECYCLESTATE, StatusCode.STARTED,"Starting to change lifecycle state to " + lifecycleTransition + " by user " + userId);
124 Response response = null;
126 // get modifier from graph
127 log.debug("get modifier properties");
128 Either<User, ResponseFormat> eitherGetUser = getUser(request, userId);
129 if (eitherGetUser.isRight()) {
130 return buildErrorResponse(eitherGetUser.right().value());
132 User user = eitherGetUser.left().value();
134 String resourceIdLower = componentId.toLowerCase();
135 log.debug("perform {} operation to resource with id {} ", lifecycleTransition, resourceIdLower);
136 Either<LifeCycleTransitionEnum, Response> validateEnum = validateTransitionEnum(lifecycleTransition, user);
137 if (validateEnum.isRight()) {
138 return validateEnum.right().value();
141 LifecycleChangeInfoWithAction changeInfo = new LifecycleChangeInfoWithAction();
144 if (jsonChangeInfo != null && !jsonChangeInfo.isEmpty()) {
145 ObjectMapper mapper = new ObjectMapper();
146 changeInfo = new LifecycleChangeInfoWithAction(mapper.readValue(jsonChangeInfo, LifecycleChangeInfoBase.class).getUserRemarks());
150 catch (Exception e) {
151 BeEcompErrorManager.getInstance().logBeInvalidJsonInput("convertJsonToObject");
152 log.debug("failed to convert from json {}", jsonChangeInfo, e);
153 getComponentsUtils().getInvalidContentErrorAndAudit(user, componentId, AuditingActionEnum.CHECKOUT_RESOURCE);
157 LifeCycleTransitionEnum transitionEnum = validateEnum.left().value();
158 ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(componentCollection);
159 if (componentType != null) {
160 Either<? extends Component, ResponseFormat> actionResponse = lifecycleBusinessLogic.changeComponentState(componentType, componentId, user, transitionEnum, changeInfo, false, true);
162 if (actionResponse.isRight()) {
163 log.info("failed to change resource state");
164 loggerSupportability.log(LoggerSupportabilityActions.CHANGELIFECYCLESTATE, StatusCode.ERROR,"failed to change resource state " + lifecycleTransition + " with error " + actionResponse.isRight() + " by user " + userId);
165 response = buildErrorResponse(actionResponse.right().value());
169 log.debug("change state successful !!!");
170 UiComponentMetadata componentMetatdata = UiComponentDataConverter.convertToUiComponentMetadata(actionResponse.left().value());
173 value = RepresentationUtils.toRepresentation(componentMetatdata);
174 } catch (IOException e) {
177 response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), value);
178 loggerSupportability.log(LoggerSupportabilityActions.CHANGELIFECYCLESTATE,actionResponse.left().value().getComponentMetadataForSupportLog(),StatusCode.COMPLETE," change state to " + lifecycleTransition + " was successful by user" + userId);
181 log.info("componentCollection \"{}\" is not valid. Supported componentCollection values are \"{}\", \"{}\" or \"{}\"", componentCollection, ComponentTypeEnum.RESOURCE_PARAM_NAME, ComponentTypeEnum.SERVICE_PARAM_NAME,
182 ComponentTypeEnum.PRODUCT_PARAM_NAME);
183 ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, componentId, AuditingActionEnum.CHECKOUT_RESOURCE);
184 return buildErrorResponse(error);
188 private Either<LifeCycleTransitionEnum, Response> validateTransitionEnum(final String lifecycleTransition, User user) {
189 LifeCycleTransitionEnum transitionEnum;
191 transitionEnum = LifeCycleTransitionEnum.getFromDisplayName(lifecycleTransition);
192 } catch (IllegalArgumentException e) {
193 log.info("state operation is not valid. operations allowed are: {}", LifeCycleTransitionEnum.valuesAsString(), e);
194 ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, "", AuditingActionEnum.CHECKOUT_RESOURCE);
195 return Either.right(buildErrorResponse(error));
197 return Either.left(transitionEnum);