catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceServlet.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20 package org.openecomp.sdc.be.servlets;
  21
  22 import static org.openecomp.sdc.common.log.enums.EcompLoggerErrorCode.BUSINESS_PROCESS_ERROR;
  23
  24 import com.fasterxml.jackson.core.JsonProcessingException;
  25 import com.fasterxml.jackson.databind.ObjectMapper;
  26 import com.google.gson.reflect.TypeToken;
  27 import com.jcabi.aspects.Loggable;
  28 import fj.data.Either;
  29 import io.swagger.v3.oas.annotations.Operation;
  30 import io.swagger.v3.oas.annotations.Parameter;
  31 import io.swagger.v3.oas.annotations.media.ArraySchema;
  32 import io.swagger.v3.oas.annotations.media.Content;
  33 import io.swagger.v3.oas.annotations.media.Schema;
  34 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  35 import io.swagger.v3.oas.annotations.servers.Server;
  36 import io.swagger.v3.oas.annotations.tags.Tag;
  37 import java.io.File;
  38 import java.io.FileNotFoundException;
  39 import java.io.IOException;
  40 import java.lang.reflect.Type;
  41 import java.util.ArrayList;
  42 import java.util.List;
  43 import java.util.Map;
  44 import javax.inject.Inject;
  45 import javax.servlet.ServletContext;
  46 import javax.servlet.http.HttpServletRequest;
  47 import javax.ws.rs.Consumes;
  48 import javax.ws.rs.DELETE;
  49 import javax.ws.rs.GET;
  50 import javax.ws.rs.HeaderParam;
  51 import javax.ws.rs.POST;
  52 import javax.ws.rs.PUT;
  53 import javax.ws.rs.Path;
  54 import javax.ws.rs.PathParam;
  55 import javax.ws.rs.Produces;
  56 import javax.ws.rs.QueryParam;
  57 import javax.ws.rs.core.Context;
  58 import javax.ws.rs.core.MediaType;
  59 import javax.ws.rs.core.Response;
  60 import org.apache.http.HttpStatus;
  61 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
  62 import org.glassfish.jersey.media.multipart.FormDataParam;
  63 import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
  64 import org.openecomp.sdc.be.components.impl.ElementBusinessLogic;
  65 import org.openecomp.sdc.be.components.impl.ResourceBusinessLogic;
  66 import org.openecomp.sdc.be.components.impl.ResourceImportManager;
  67 import org.openecomp.sdc.be.components.impl.ServiceBusinessLogic;
  68 import org.openecomp.sdc.be.components.impl.aaf.AafPermission;
  69 import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed;
  70 import org.openecomp.sdc.be.components.impl.exceptions.ByResponseFormatComponentException;
  71 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  72 import org.openecomp.sdc.be.dao.api.ActionStatus;
  73 import org.openecomp.sdc.be.datamodel.ServiceRelations;
  74 import org.openecomp.sdc.be.datatypes.components.ServiceMetadataDataDefinition;
  75 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
  76 import org.openecomp.sdc.be.impl.ComponentsUtils;
  77 import org.openecomp.sdc.be.impl.ServletUtils;
  78 import org.openecomp.sdc.be.model.Component;
  79 import org.openecomp.sdc.be.model.DistributionStatusEnum;
  80 import org.openecomp.sdc.be.model.GroupInstanceProperty;
  81 import org.openecomp.sdc.be.model.Resource;
  82 import org.openecomp.sdc.be.model.Service;
  83 import org.openecomp.sdc.be.model.UploadServiceInfo;
  84 import org.openecomp.sdc.be.model.User;
  85 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  86 import org.openecomp.sdc.be.resources.data.auditing.model.DistributionData;
  87 import org.openecomp.sdc.be.resources.data.auditing.model.ResourceCommonInfo;
  88 import org.openecomp.sdc.be.servlets.ServiceUploadServlet.ServiceAuthorityTypeEnum;
  89 import org.openecomp.sdc.be.user.UserBusinessLogic;
  90 import org.openecomp.sdc.common.api.Constants;
  91 import org.openecomp.sdc.common.datastructure.Wrapper;
  92 import org.openecomp.sdc.common.log.elements.LoggerSupportability;
  93 import org.openecomp.sdc.common.log.enums.LoggerSupportabilityActions;
  94 import org.openecomp.sdc.common.log.enums.StatusCode;
  95 import org.openecomp.sdc.common.log.wrappers.Logger;
  96 import org.openecomp.sdc.common.zip.exception.ZipException;
  97 import org.openecomp.sdc.exception.ResponseFormat;
  98 import org.springframework.stereotype.Controller;
  99
 100 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
 101 @Path("/v1/catalog")
 102 @Server(url = "/sdc2/rest")
 103 @Controller
 104 public class ServiceServlet extends AbstractValidationsServlet {
 105
 106     private static final Logger log = Logger.getLogger(ServiceServlet.class);
 107     private static final LoggerSupportability loggerSupportability = LoggerSupportability.getLogger(ServiceServlet.class.getName());
 108     private static final String START_HANDLE_REQUEST_OF = "Start handle request of {}";
 109     private static final String MODIFIER_ID_IS = "modifier id is {}";
 110     private final ElementBusinessLogic elementBusinessLogic;
 111     private final ServiceBusinessLogic serviceBusinessLogic;
 112
 113     @Inject
 114     public ServiceServlet(UserBusinessLogic userBusinessLogic, ComponentInstanceBusinessLogic componentInstanceBL, ComponentsUtils componentsUtils,
 115                           ServletUtils servletUtils, ResourceImportManager resourceImportManager, ServiceBusinessLogic serviceBusinessLogic,
 116                           ResourceBusinessLogic resourceBusinessLogic, ElementBusinessLogic elementBusinessLogic) {
 117         super(userBusinessLogic, componentInstanceBL, componentsUtils, servletUtils, resourceImportManager);
 118         this.serviceBusinessLogic = serviceBusinessLogic;
 119         this.elementBusinessLogic = elementBusinessLogic;
 120     }
 121
 122     @POST
 123     @Path("/services")
 124     @Tag(name = "SDCE-2 APIs")
 125     @Consumes(MediaType.APPLICATION_JSON)
 126     @Produces(MediaType.APPLICATION_JSON)
 127     @Operation(description = "Create Service", method = "POST", summary = "Returns created service", responses = {
 128         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))),
 129         @ApiResponse(responseCode = "201", description = "Service created"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 130         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 131         @ApiResponse(responseCode = "409", description = "Service already exist")})
 132     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 133     public Response createService(@Parameter(description = "Service object to be created", required = true) String data,
 134                                   @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 135         String url = request.getMethod() + " " + request.getRequestURI();
 136         log.debug(START_HANDLE_REQUEST_OF, url);
 137         User modifier = new User(userId);
 138         log.debug(MODIFIER_ID_IS, userId);
 139         loggerSupportability.log(LoggerSupportabilityActions.CREATE_SERVICE, StatusCode.STARTED, "Starting to create a service by user {} ", userId);
 140         validateNotEmptyBody(data);
 141         Either<Service, ResponseFormat> convertResponse = parseToService(data, modifier);
 142         if (convertResponse.isRight()) {
 143             throw new ByResponseFormatComponentException(convertResponse.right().value());
 144         }
 145         Service service = convertResponse.left().value();
 146         Either<Service, ResponseFormat> actionResponse = serviceBusinessLogic.createService(service, modifier);
 147         if (actionResponse.isRight()) {
 148             log.debug("Failed to create service");
 149             throw new ByResponseFormatComponentException(actionResponse.right().value());
 150         }
 151         loggerSupportability.log(LoggerSupportabilityActions.CREATE_SERVICE, service.getComponentMetadataForSupportLog(), StatusCode.COMPLETE,
 152             "Service {} has been created by user {} ", service.getName(), userId);
 153         return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.CREATED), actionResponse.left().value());
 154     }
 155
 156     public Either<Service, ResponseFormat> parseToService(String serviceJson, User user) {
 157         return getComponentsUtils()
 158             .convertJsonToObjectUsingObjectMapper(serviceJson, user, Service.class, AuditingActionEnum.CREATE_RESOURCE, ComponentTypeEnum.SERVICE);
 159     }
 160
 161     @GET
 162     @Path("/services/validate-name/{serviceName}")
 163     @Tag(name = "SDCE-2 APIs")
 164     @Consumes(MediaType.APPLICATION_JSON)
 165     @Produces(MediaType.APPLICATION_JSON)
 166     @Operation(description = "validate service name", method = "GET", summary = "checks if the chosen service name is available ", responses = {
 167         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 168         @ApiResponse(responseCode = "200", description = "Service found"), @ApiResponse(responseCode = "403", description = "Restricted operation")})
 169     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 170     public Response validateServiceName(@PathParam("serviceName") final String serviceName, @Context final HttpServletRequest request,
 171                                         @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 172         String url = request.getMethod() + " " + request.getRequestURI();
 173         log.debug(START_HANDLE_REQUEST_OF, url);
 174         log.debug(MODIFIER_ID_IS, userId);
 175         try {
 176             Either<Map<String, Boolean>, ResponseFormat> actionResponse = serviceBusinessLogic.validateServiceNameExists(serviceName, userId);
 177             if (actionResponse.isRight()) {
 178                 log.debug("failed to get validate service name");
 179                 return buildErrorResponse(actionResponse.right().value());
 180             }
 181             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), actionResponse.left().value());
 182         } catch (Exception e) {
 183             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Validate Service Name");
 184             log.debug("validate service name failed with exception", e);
 185             throw e;
 186         }
 187     }
 188
 189     @GET
 190     @Path("/audit-records/{componentType}/{componentUniqueId}")
 191     @Tag(name = "SDCE-2 APIs")
 192     @Consumes(MediaType.APPLICATION_JSON)
 193     @Produces(MediaType.APPLICATION_JSON)
 194     @Operation(description = "get component audit records", method = "GET", summary = "get audit records for a service or a resource", responses = {
 195         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 196         @ApiResponse(responseCode = "200", description = "Service found"), @ApiResponse(responseCode = "403", description = "Restricted operation")})
 197     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 198     public Response getComponentAuditRecords(@PathParam("componentType") final String componentType,
 199                                              @PathParam("componentUniqueId") final String componentUniqueId,
 200                                              @Context final HttpServletRequest request,
 201                                              @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 202         init();
 203         ServletContext context = request.getSession().getServletContext();
 204         String url = request.getMethod() + " " + request.getRequestURI();
 205         log.debug(START_HANDLE_REQUEST_OF, url);
 206         log.debug(MODIFIER_ID_IS, userId);
 207         Wrapper<Response> responseWrapper = new Wrapper<>();
 208         Wrapper<String> uuidWrapper = new Wrapper<>();
 209         Wrapper<String> versionWrapper = new Wrapper<>();
 210         Wrapper<User> userWrapper = new Wrapper<>();
 211         try {
 212             validateUserExist(responseWrapper, userWrapper, userId);
 213             if (responseWrapper.isEmpty()) {
 214                 fillUUIDAndVersion(responseWrapper, uuidWrapper, versionWrapper, userWrapper.getInnerElement(), validateComponentType(componentType),
 215                     componentUniqueId, context);
 216             }
 217             if (responseWrapper.isEmpty()) {
 218                 Either<List<Map<String, Object>>, ResponseFormat> eitherServiceAudit = serviceBusinessLogic
 219                     .getComponentAuditRecords(versionWrapper.getInnerElement(), uuidWrapper.getInnerElement(), userId);
 220                 if (eitherServiceAudit.isRight()) {
 221                     Response errorResponse = buildErrorResponse(eitherServiceAudit.right().value());
 222                     responseWrapper.setInnerElement(errorResponse);
 223                 } else {
 224                     List<Map<String, Object>> auditRecords = eitherServiceAudit.left().value();
 225                     Response okResponse = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), auditRecords);
 226                     responseWrapper.setInnerElement(okResponse);
 227                 }
 228             }
 229         } catch (Exception e) {
 230             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Validate Service Name");
 231             log.debug("get Service Audit Records failed with exception", e);
 232             throw e;
 233         }
 234         return responseWrapper.getInnerElement();
 235     }
 236
 237     private void fillUUIDAndVersion(Wrapper<Response> responseWrapper, Wrapper<String> uuidWrapper, Wrapper<String> versionWrapper, User user,
 238                                     final ComponentTypeEnum componentTypeEnum, final String componentUniqueId, ServletContext context) {
 239         if (componentTypeEnum == ComponentTypeEnum.RESOURCE) {
 240             Either<Resource, ResponseFormat> eitherResource = getResourceBL(context).getResource(componentUniqueId, user);
 241             if (eitherResource.isLeft()) {
 242                 uuidWrapper.setInnerElement(eitherResource.left().value().getUUID());
 243                 versionWrapper.setInnerElement(eitherResource.left().value().getVersion());
 244             } else {
 245                 responseWrapper.setInnerElement(buildErrorResponse(eitherResource.right().value()));
 246             }
 247         } else {
 248             Either<Service, ResponseFormat> eitherService = getServiceBL(context).getService(componentUniqueId, user);
 249             if (eitherService.isLeft()) {
 250                 uuidWrapper.setInnerElement(eitherService.left().value().getUUID());
 251                 versionWrapper.setInnerElement(eitherService.left().value().getVersion());
 252             } else {
 253                 responseWrapper.setInnerElement(buildErrorResponse(eitherService.right().value()));
 254             }
 255         }
 256     }
 257
 258     @DELETE
 259     @Path("/services/{serviceId}")
 260     @Tag(name = "SDCE-2 APIs")
 261     @Operation(description = "Delete Service", method = "DELETE", summary = "Return no content", responses = {
 262         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))),
 263         @ApiResponse(responseCode = "204", description = "Service deleted"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 264         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 265         @ApiResponse(responseCode = "404", description = "Service not found")})
 266     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 267     public Response deleteService(@PathParam("serviceId") final String serviceId,
 268                                   @Parameter(description = "Optional parameter to determine the delete action: " +
 269                                       "DELETE, which will permanently delete theService from the system or " +
 270                                       "MARK_AS_DELETE, which will logically mark the service as deleted. Default action is to MARK_AS_DELETE")
 271                                   @QueryParam("deleteAction") final Action deleteAction,
 272                                   @Context final HttpServletRequest request) {
 273         ServletContext context = request.getSession().getServletContext();
 274         String url = request.getMethod() + " " + request.getRequestURI();
 275         log.debug(START_HANDLE_REQUEST_OF, url);
 276         // get modifier id
 277         String userId = request.getHeader(Constants.USER_ID_HEADER);
 278         User modifier = new User(userId);
 279         log.debug(MODIFIER_ID_IS, userId);
 280         try {
 281             String serviceIdLower = serviceId.toLowerCase();
 282             loggerSupportability
 283                 .log(LoggerSupportabilityActions.DELETE_SERVICE, StatusCode.STARTED, "Starting to delete service {} by user {} ", serviceIdLower,
 284                     userId);
 285             ServiceBusinessLogic businessLogic = getServiceBL(context);
 286             ResponseFormat actionResponse;
 287             if (Action.DELETE.equals(deleteAction)) {
 288                 businessLogic.deleteServiceAllVersions(serviceIdLower, modifier);
 289                 actionResponse = componentsUtils.getResponseFormat(ActionStatus.NO_CONTENT);
 290             } else {
 291                 actionResponse = businessLogic.markServiceForDeletion(serviceIdLower, modifier);
 292             }
 293             if (actionResponse.getStatus() != HttpStatus.SC_NO_CONTENT) {
 294                 log.debug("failed to delete service");
 295                 return buildErrorResponse(actionResponse);
 296             }
 297             loggerSupportability
 298                 .log(LoggerSupportabilityActions.DELETE_SERVICE, StatusCode.COMPLETE, "Ended deleting service {} by user {}", serviceIdLower, userId);
 299             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.NO_CONTENT), null);
 300         } catch (Exception e) {
 301             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Delete Service");
 302             log.debug("delete service failed with exception", e);
 303             throw e;
 304         }
 305     }
 306
 307     @DELETE
 308     @Path("/services/{serviceName}/{version}")
 309     @Tag(name = "SDCE-2 APIs")
 310     @Operation(description = "Delete Service By Name And Version", method = "DELETE", summary = "Returns no content", responses = {
 311         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Resource.class)))),
 312         @ApiResponse(responseCode = "204", description = "Service deleted"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 313         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 314         @ApiResponse(responseCode = "404", description = "Service not found")})
 315     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 316     public Response deleteServiceByNameAndVersion(@PathParam("serviceName") final String serviceName, @PathParam("version") final String version,
 317                                                   @Context final HttpServletRequest request) {
 318         User modifier = getUser(request);
 319         try {
 320             ResponseFormat actionResponse = serviceBusinessLogic.deleteServiceByNameAndVersion(serviceName, version, modifier);
 321             if (actionResponse.getStatus() != HttpStatus.SC_NO_CONTENT) {
 322                 log.debug("failed to delete service");
 323                 return buildErrorResponse(actionResponse);
 324             }
 325             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.NO_CONTENT), null);
 326         } catch (Exception e) {
 327             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Delete Service");
 328             log.debug("delete service failed with exception", e);
 329             throw e;
 330         }
 331     }
 332
 333     private User getUser(HttpServletRequest request) {
 334         String url = request.getMethod() + " " + request.getRequestURI();
 335         log.debug(START_HANDLE_REQUEST_OF, url);
 336         // get modifier id
 337         String userId = request.getHeader(Constants.USER_ID_HEADER);
 338         User modifier = new User(userId);
 339         log.debug(MODIFIER_ID_IS, userId);
 340         return modifier;
 341     }
 342
 343     @PUT
 344     @Path("/services/{serviceId}/metadata")
 345     @Tag(name = "SDCE-2 APIs")
 346     @Consumes(MediaType.APPLICATION_JSON)
 347     @Produces(MediaType.APPLICATION_JSON)
 348     @Operation(description = "Update Service Metadata", method = "PUT", summary = "Returns updated service", responses = {
 349         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))),
 350         @ApiResponse(responseCode = "200", description = "Service Updated"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 351         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")})
 352     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 353     public Response updateServiceMetadata(@PathParam("serviceId") final String serviceId,
 354                                           @Parameter(description = "Service object to be Updated", required = true) String data,
 355                                           @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId)
 356         throws IOException {
 357         String url = request.getMethod() + " " + request.getRequestURI();
 358         log.debug(START_HANDLE_REQUEST_OF, url);
 359         User modifier = new User(userId);
 360         log.debug(MODIFIER_ID_IS, userId);
 361         try {
 362             String serviceIdLower = serviceId.toLowerCase();
 363             Either<Service, ResponseFormat> convertResponse = parseToService(data, modifier);
 364             if (convertResponse.isRight()) {
 365                 log.debug("failed to parse service");
 366                 return buildErrorResponse(convertResponse.right().value());
 367             }
 368             Service updatedService = convertResponse.left().value();
 369             Either<Service, ResponseFormat> actionResponse = serviceBusinessLogic.updateServiceMetadata(serviceIdLower, updatedService, modifier);
 370             if (actionResponse.isRight()) {
 371                 log.debug("failed to update service");
 372                 return buildErrorResponse(actionResponse.right().value());
 373             }
 374             Service service = actionResponse.left().value();
 375             Object result = RepresentationUtils.toRepresentation(service);
 376             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 377         } catch (Exception e) {
 378             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Update Service Metadata");
 379             log.debug("update service metadata failed with exception", e);
 380             throw e;
 381         }
 382     }
 383
 384     /**
 385      * updates group instance property values Note, than in case of group instance updated successfully, related resourceInstance and containing
 386      * component modification time will be updated
 387      *
 388      * @param serviceId
 389      * @param componentInstanceId
 390      * @param groupInstanceId
 391      * @param data
 392      * @param request
 393      * @param userId
 394      * @return
 395      */
 396     @PUT
 397     @Path("/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}")
 398     @Tag(name = "SDCE-2 APIs")
 399     @Consumes(MediaType.APPLICATION_JSON)
 400     @Produces(MediaType.APPLICATION_JSON)
 401     @Operation(description = "Update Group Instance Property Values", method = "PUT", summary = "Returns updated group instance", responses = {
 402         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))),
 403         @ApiResponse(responseCode = "200", description = "Group Instance Property Values Updated"),
 404         @ApiResponse(responseCode = "403", description = "Restricted operation"),
 405         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")})
 406     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 407     public Response updateGroupInstancePropertyValues(@PathParam("serviceId") final String serviceId,
 408                                                       @PathParam("componentInstanceId") final String componentInstanceId,
 409                                                       @PathParam("groupInstanceId") final String groupInstanceId,
 410                                                       @Parameter(description = "Group instance object to be Updated", required = true) String data,
 411                                                       @Context final HttpServletRequest request,
 412                                                       @HeaderParam(value = Constants.USER_ID_HEADER) String userId) throws JsonProcessingException {
 413         String url = request.getMethod() + " " + request.getRequestURI();
 414         log.debug(START_HANDLE_REQUEST_OF, url);
 415         User modifier = new User(userId);
 416         log.debug(MODIFIER_ID_IS, userId);
 417         Either<List<GroupInstanceProperty>, ResponseFormat> actionResponse = null;
 418         try {
 419             List<GroupInstanceProperty> updatedProperties;
 420             Type listType = new TypeToken<ArrayList<GroupInstanceProperty>>() {
 421             }.getType();
 422             ArrayList<GroupInstanceProperty> newProperties = gson.fromJson(data, listType);
 423             if (newProperties == null) {
 424                 actionResponse = Either.right(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 425             }
 426             if (actionResponse == null) {
 427                 log.debug("Start handle update group instance property values request. Received group instance is {}", groupInstanceId);
 428                 actionResponse = serviceBusinessLogic
 429                     .updateGroupInstancePropertyValues(modifier, serviceId, componentInstanceId, groupInstanceId, newProperties);
 430                 if (actionResponse.isRight()) {
 431                     actionResponse = Either.right(actionResponse.right().value());
 432                 }
 433             }
 434             if (actionResponse.isLeft()) {
 435                 updatedProperties = actionResponse.left().value();
 436                 ObjectMapper mapper = new ObjectMapper();
 437                 String result = mapper.writeValueAsString(updatedProperties);
 438                 return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 439             } else {
 440                 return buildErrorResponse(actionResponse.right().value());
 441             }
 442         } catch (Exception e) {
 443             log.error(BUSINESS_PROCESS_ERROR, this.getClass().getName(), "Exception occured during update Group Instance property values.", e);
 444             throw e;
 445         }
 446     }
 447
 448     @GET
 449     @Path("/services/{serviceId}")
 450     @Tag(name = "SDCE-2 APIs")
 451     @Consumes(MediaType.APPLICATION_JSON)
 452     @Produces(MediaType.APPLICATION_JSON)
 453     @Operation(description = "Retrieve Service", method = "GET", summary = "Returns service according to serviceId", responses = {
 454         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))),
 455         @ApiResponse(responseCode = "200", description = "Service found"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 456         @ApiResponse(responseCode = "404", description = "Service not found")})
 457     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 458     public Response getServiceById(@PathParam("serviceId") final String serviceId, @Context final HttpServletRequest request,
 459                                    @HeaderParam(value = Constants.USER_ID_HEADER) String userId) throws IOException {
 460         String url = request.getMethod() + " " + request.getRequestURI();
 461         log.debug(START_HANDLE_REQUEST_OF, url);
 462         // get modifier id
 463         User modifier = new User(userId);
 464         log.debug(MODIFIER_ID_IS, userId);
 465         try {
 466             String serviceIdLower = serviceId.toLowerCase();
 467             log.debug("get service with id {}", serviceId);
 468             Either<Service, ResponseFormat> actionResponse = serviceBusinessLogic.getService(serviceIdLower, modifier);
 469             if (actionResponse.isRight()) {
 470                 log.debug("failed to get service");
 471                 return buildErrorResponse(actionResponse.right().value());
 472             }
 473             Service service = actionResponse.left().value();
 474             Object result = RepresentationUtils.toRepresentation(service);
 475             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 476         } catch (Exception e) {
 477             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Service");
 478             log.debug("get service failed with exception", e);
 479             throw e;
 480         }
 481     }
 482
 483     @GET
 484     @Path("/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}")
 485     @Tag(name = "SDCE-2 APIs")
 486     @Consumes(MediaType.APPLICATION_JSON)
 487     @Produces(MediaType.APPLICATION_JSON)
 488     @Operation(description = "Retrieve Service", method = "GET", summary = "Returns service according to name and version", responses = {
 489         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))),
 490         @ApiResponse(responseCode = "200", description = "Service found"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 491         @ApiResponse(responseCode = "404", description = "Service not found")})
 492     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 493     public Response getServiceByNameAndVersion(@PathParam("serviceName") final String serviceName,
 494                                                @PathParam("serviceVersion") final String serviceVersion, @Context final HttpServletRequest request,
 495                                                @HeaderParam(value = Constants.USER_ID_HEADER) String userId) throws IOException {
 496         // get modifier id
 497         log.debug(MODIFIER_ID_IS, userId);
 498         try {
 499             Either<Service, ResponseFormat> actionResponse = serviceBusinessLogic.getServiceByNameAndVersion(serviceName, serviceVersion, userId);
 500             if (actionResponse.isRight()) {
 501                 return buildErrorResponse(actionResponse.right().value());
 502             }
 503             Service service = actionResponse.left().value();
 504             Object result = RepresentationUtils.toRepresentation(service);
 505             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 506         } catch (Exception e) {
 507             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Service by name and version");
 508             log.debug("get service failed with exception", e);
 509             throw e;
 510         }
 511     }
 512
 513     @POST
 514     @Path("/services/{serviceId}/distribution/{env}/activate")
 515     @Tag(name = "SDCE-5 APIs")
 516     @Consumes(MediaType.APPLICATION_JSON)
 517     @Produces(MediaType.APPLICATION_JSON)
 518     @Operation(description = "Activate distribution", method = "POST", summary = "activate distribution", responses = {
 519         @ApiResponse(responseCode = "200", description = "OK"),
 520         @ApiResponse(responseCode = "409", description = "Service cannot be distributed due to missing deployment artifacts"),
 521         @ApiResponse(responseCode = "404", description = "Requested service was not found"),
 522         @ApiResponse(responseCode = "500", description = "Internal Server Error. Please try again later.")})
 523     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 524     public Response activateDistribution(@PathParam("serviceId") final String serviceId, @PathParam("env") final String env,
 525                                          @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId)
 526         throws IOException {
 527         String url = request.getMethod() + " " + request.getRequestURI();
 528         log.debug(START_HANDLE_REQUEST_OF, url);
 529         User modifier = new User(userId);
 530         log.debug(MODIFIER_ID_IS, userId);
 531         Either<Service, ResponseFormat> distResponse = serviceBusinessLogic.activateDistribution(serviceId, env, modifier, request);
 532         if (distResponse.isRight()) {
 533             log.debug("failed to activate service distribution");
 534             return buildErrorResponse(distResponse.right().value());
 535         }
 536         Service service = distResponse.left().value();
 537         Object result = null;
 538         try {
 539             result = RepresentationUtils.toRepresentation(service);
 540         } catch (IOException e) {
 541             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Activate Distribution");
 542             log.debug("activate distribution failed with exception", e);
 543             throw e;
 544         }
 545         return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 546     }
 547
 548     @POST
 549     @Path("/services/{serviceId}/distribution/{did}/markDeployed")
 550     @Tag(name = "SDCE-5 APIs")
 551     @Consumes(MediaType.APPLICATION_JSON)
 552     @Produces(MediaType.APPLICATION_JSON)
 553     @Operation(description = "Mark distribution as deployed", method = "POST", summary = "relevant audit record will be created", responses = {
 554         @ApiResponse(responseCode = "200", description = "Service was marked as deployed"),
 555         @ApiResponse(responseCode = "409", description = "Restricted operation"),
 556         @ApiResponse(responseCode = "403", description = "Service is not available"),
 557         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 558         @ApiResponse(responseCode = "404", description = "Requested service was not found"),
 559         @ApiResponse(responseCode = "500", description = "Internal Server Error. Please try again later.")})
 560     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 561     public Response markDistributionAsDeployed(@PathParam("serviceId") final String serviceId, @PathParam("did") final String did,
 562                                                @Context final HttpServletRequest request,
 563                                                @HeaderParam(value = Constants.USER_ID_HEADER) String userId) throws IOException {
 564         String url = request.getMethod() + " " + request.getRequestURI();
 565         log.debug(START_HANDLE_REQUEST_OF, url);
 566         User modifier = new User(userId);
 567         log.debug(MODIFIER_ID_IS, userId);
 568         try {
 569             Either<Service, ResponseFormat> distResponse = serviceBusinessLogic.markDistributionAsDeployed(serviceId, did, modifier);
 570             if (distResponse.isRight()) {
 571                 log.debug("failed to mark distribution as deployed");
 572                 return buildErrorResponse(distResponse.right().value());
 573             }
 574             Service service = distResponse.left().value();
 575             Object result = RepresentationUtils.toRepresentation(service);
 576             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 577         } catch (Exception e) {
 578             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Mark Distribution As Deployed");
 579             log.debug("mark distribution as deployed failed with exception", e);
 580             throw e;
 581         }
 582     }
 583
 584     @POST
 585     @Path("/services/{serviceId}/tempUrlToBeDeleted")
 586     @Tag(name = "SDCE-2 APIs")
 587     @Consumes(MediaType.APPLICATION_JSON)
 588     @Produces(MediaType.APPLICATION_JSON)
 589     @Operation(responses = {@ApiResponse(responseCode = "200", description = "OK"),
 590         @ApiResponse(responseCode = "500", description = "Internal Server Error. Please try again later.")})
 591     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 592     public Response tempUrlToBeDeleted(@PathParam("serviceId") final String serviceId, @Context final HttpServletRequest request,
 593                                        @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 594         String url = request.getMethod() + " " + request.getRequestURI();
 595         log.debug(START_HANDLE_REQUEST_OF, url);
 596         User modifier = new User(userId);
 597         log.debug(MODIFIER_ID_IS, userId);
 598         try {
 599             Service service = (serviceBusinessLogic.getService(serviceId, modifier)).left().value();
 600             Either<Service, ResponseFormat> res = serviceBusinessLogic
 601                 .updateDistributionStatusForActivation(service, modifier, DistributionStatusEnum.DISTRIBUTED);
 602             if (res.isRight()) {
 603                 buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 604             }
 605             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), null);
 606         } catch (Exception e) {
 607             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("tempUrlToBeDeleted");
 608             log.debug("failed with exception", e);
 609             throw e;
 610         }
 611     }
 612
 613     @GET
 614     @Path("/services/{serviceId}/linksMap")
 615     @Tag(name = "SDCE-2 APIs")
 616     @Consumes(MediaType.APPLICATION_JSON)
 617     @Produces(MediaType.APPLICATION_JSON)
 618     @Operation(description = "Retrieve Service component relations map", method = "GET", summary = "Returns service components relations", responses = {
 619         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = ServiceRelations.class)))),
 620         @ApiResponse(responseCode = "200", description = "Service found"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 621         @ApiResponse(responseCode = "404", description = "Service not found")})
 622     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 623     public Response getServiceComponentRelationMap(@PathParam("serviceId") final String serviceId, @Context final HttpServletRequest request,
 624                                                    @HeaderParam(value = Constants.USER_ID_HEADER) String userId) throws IOException {
 625         String url = request.getMethod() + " " + request.getRequestURI();
 626         log.debug(START_HANDLE_REQUEST_OF, url);
 627         // get modifier id
 628         User modifier = new User(userId);
 629         log.debug(MODIFIER_ID_IS, userId);
 630         try {
 631             String serviceIdLower = serviceId.toLowerCase();
 632             log.debug("get service components relations with id {}", serviceId);
 633             Either<ServiceRelations, ResponseFormat> actionResponse = serviceBusinessLogic.getServiceComponentsRelations(serviceIdLower, modifier);
 634             if (actionResponse.isRight()) {
 635                 log.debug("failed to get service relations data");
 636                 return buildErrorResponse(actionResponse.right().value());
 637             }
 638             ServiceRelations serviceRelations = actionResponse.left().value();
 639             Object result = RepresentationUtils.toRepresentation(serviceRelations);
 640             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 641         } catch (Exception e) {
 642             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Service");
 643             log.debug("get service relations data failed with exception", e);
 644             throw e;
 645         }
 646     }
 647
 648     @POST
 649     @Path("/services/importService")
 650     @Tag(name = "SDCE-2 APIs")
 651     @Consumes(MediaType.APPLICATION_JSON)
 652     @Produces(MediaType.APPLICATION_JSON)
 653     @Operation(description = "Import Service", method = "POST", summary = "Returns imported service", responses = {
 654         @ApiResponse(responseCode = "201", description = "Service created"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 655         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 656         @ApiResponse(responseCode = "409", description = "Service already exist")})
 657     public Response importNsService(@Parameter(description = "Service object to be imported", required = true) String data,
 658                                     @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 659         userId = (userId != null) ? userId : request.getHeader(Constants.USER_ID_HEADER);
 660         initSpringFromContext();
 661         String url = request.getMethod() + " " + request.getRequestURI();
 662         log.debug(START_HANDLE_REQUEST_OF, url);
 663         log.debug(MODIFIER_ID_IS, userId);
 664         try {
 665             final Wrapper<Response> responseWrapper = performUIImport(data, request, userId, null);
 666             return responseWrapper.getInnerElement();
 667         } catch (IOException | ZipException e) {
 668             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Import Service");
 669             log.debug("import service failed with exception", e);
 670             return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 671         }
 672     }
 673
 674     private Wrapper<Response> performUIImport(String data, final HttpServletRequest request, String userId,
 675                                               String ServiceUniqueId) throws FileNotFoundException, ZipException {
 676         Wrapper<Response> responseWrapper = new Wrapper<>();
 677         Wrapper<User> userWrapper = new Wrapper<>();
 678         Wrapper<UploadServiceInfo> uploadServiceInfoWrapper = new Wrapper<>();
 679         Wrapper<String> yamlStringWrapper = new Wrapper<>();
 680         ServiceAuthorityTypeEnum ServiceAuthorityEnum = ServiceAuthorityTypeEnum.USER_TYPE_UI;
 681         commonServiceGeneralValidations(responseWrapper, userWrapper, uploadServiceInfoWrapper, ServiceAuthorityEnum, userId, data);
 682         specificServiceAuthorityValidations(responseWrapper, uploadServiceInfoWrapper, yamlStringWrapper, userWrapper.getInnerElement(), request,
 683             data, ServiceAuthorityEnum);
 684         if (responseWrapper.isEmpty()) {
 685             handleImportService(responseWrapper, userWrapper.getInnerElement(), uploadServiceInfoWrapper.getInnerElement(),
 686                 yamlStringWrapper.getInnerElement(), ServiceAuthorityEnum, true, ServiceUniqueId);
 687         }
 688         return responseWrapper;
 689     }
 690
 691     /**
 692      * import ReplaceService
 693      *
 694      * @param userId
 695      * @param requestId
 696      * @param instanceIdHeader
 697      * @param accept
 698      * @param authorization
 699      * @param request
 700      * @param file
 701      * @param contentDispositionHeader
 702      * @param serviceInfoJsonString
 703      * @param uuid
 704      * @return
 705      */
 706     @POST
 707     @Path("/services/serviceUUID/{uuid}/importReplaceService")
 708     @Tag(name = "SDCE-2 APIs")
 709     @Produces(MediaType.APPLICATION_JSON)
 710     @Operation(description = "Import Service", method = "POST", summary = "Returns imported service", responses = {
 711         @ApiResponse(responseCode = "201", description = "Service created"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 712         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 713         @ApiResponse(responseCode = "409", description = "Service already exist")})
 714     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 715     public Response importReplaceService(
 716         @Parameter(description = "The user id", required = true) @HeaderParam(value = Constants.USER_ID_HEADER) String userId,
 717         @Parameter(description = "X-ECOMP-RequestID header", required = false) @HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,
 718         @Parameter(description = "X-ECOMP-InstanceID header", required = true) @HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader,
 719         @Parameter(description = "Determines the format of the body of the response", required = false) @HeaderParam(value = Constants.ACCEPT_HEADER) String accept,
 720         @Parameter(description = "The username and password", required = true) @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization,
 721         @Context final HttpServletRequest request, @Parameter(description = "FileInputStream") @FormDataParam("serviceZip") File file,
 722         @Parameter(description = "ContentDisposition") @FormDataParam("serviceZip") FormDataContentDisposition contentDispositionHeader,
 723         @Parameter(description = "serviceMetadata") @FormDataParam("serviceZipMetadata") String serviceInfoJsonString,
 724         @Parameter(description = "The requested asset uuid", required = true) @PathParam("uuid") final String uuid) {
 725         initSpringFromContext();
 726         String requestURI = request.getRequestURI();
 727         String url = request.getMethod() + " " + requestURI;
 728         log.debug("importReplaceService,Start handle request of {}", url);
 729         // get modifier id
 730         User modifier = new User(userId);
 731         log.debug("importReplaceService,modifier id is {}", userId);
 732         log.debug("importReplaceService,get file:{},fileName:{}", file, file.getName());
 733         ResponseFormat responseFormat = null;
 734         AuditingActionEnum auditingActionEnum = AuditingActionEnum.Import_Replace_Service;
 735         String assetType = "services";
 736         Either<List<? extends Component>, ResponseFormat> assetTypeData = elementBusinessLogic
 737             .getCatalogComponentsByUuidAndAssetType(assetType, uuid);
 738         if (assetTypeData.isRight() || assetTypeData.left().value().size() != 1) {
 739             log.debug("getServiceAbstractStatus: Service Fetching Failed");
 740             throw new ByResponseFormatComponentException(assetTypeData.right().value());
 741         }
 742         log.debug("getServiceAbstractStatus: Service Fetching Success");
 743         Service oldService = (Service) assetTypeData.left().value().get(0);
 744         ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(assetType);
 745         ResourceCommonInfo resourceCommonInfo = new ResourceCommonInfo(componentType.getValue());
 746         DistributionData distributionData = new DistributionData(instanceIdHeader, requestURI);
 747         // Mandatory
 748         if (instanceIdHeader == null || instanceIdHeader.isEmpty()) {
 749             log.debug("importReplaceService: Missing X-ECOMP-InstanceID header");
 750             responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
 751             getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, distributionData, resourceCommonInfo, requestId, null);
 752             return buildErrorResponse(responseFormat);
 753         }
 754         try {
 755             Wrapper<Response> responseWrapper = new Wrapper<>();
 756             // file import
 757             Wrapper<User> userWrapper = new Wrapper<>();
 758             Wrapper<UploadServiceInfo> uploadServiceInfoWrapper = new Wrapper<>();
 759             Wrapper<String> yamlStringWrapper = new Wrapper<>();
 760             ServiceUploadServlet.ServiceAuthorityTypeEnum serviceAuthorityEnum = ServiceUploadServlet.ServiceAuthorityTypeEnum.CSAR_TYPE_BE;
 761             // PayLoad Validations
 762             commonServiceGeneralValidations(responseWrapper, userWrapper, uploadServiceInfoWrapper, serviceAuthorityEnum, userId,
 763                 serviceInfoJsonString);
 764             fillServicePayload(responseWrapper, uploadServiceInfoWrapper, yamlStringWrapper, modifier, serviceInfoJsonString, serviceAuthorityEnum,
 765                 file);
 766             specificServiceAuthorityValidations(responseWrapper, uploadServiceInfoWrapper, yamlStringWrapper, userWrapper.getInnerElement(), request,
 767                 serviceInfoJsonString, serviceAuthorityEnum);
 768             log.debug("importReplaceService:get payload:{}", uploadServiceInfoWrapper.getInnerElement().getPayloadData());
 769             ServiceMetadataDataDefinition serviceMetadataDataDefinition = (ServiceMetadataDataDefinition) oldService.getComponentMetadataDefinition()
 770                 .getMetadataDataDefinition();
 771             uploadServiceInfoWrapper.getInnerElement().setServiceVendorModelNumber(serviceMetadataDataDefinition.getServiceVendorModelNumber());
 772             uploadServiceInfoWrapper.getInnerElement().setDescription(oldService.getDescription());
 773             uploadServiceInfoWrapper.getInnerElement().setCategories(oldService.getCategories());
 774             uploadServiceInfoWrapper.getInnerElement().setIcon(oldService.getIcon());
 775             uploadServiceInfoWrapper.getInnerElement().setProjectCode(oldService.getProjectCode());
 776             if (responseWrapper.isEmpty()) {
 777                 log.debug("importReplaceService:start handleImportService");
 778                 handleImportService(responseWrapper, userWrapper.getInnerElement(), uploadServiceInfoWrapper.getInnerElement(),
 779                     yamlStringWrapper.getInnerElement(), serviceAuthorityEnum, true, null);
 780             }
 781             return responseWrapper.getInnerElement();
 782         } catch (IOException | ZipException e) {
 783             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Import Service");
 784             log.debug("import service failed with exception", e);
 785             return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 786         }
 787     }
 788
 789     public enum Action {DELETE, MARK_AS_DELETE}
 790 }