catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourceUploadServlet.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
  21 package org.openecomp.sdc.be.servlets;
  22
  23 import com.jcabi.aspects.Loggable;
  24 import io.swagger.v3.oas.annotations.Operation;
  25 import io.swagger.v3.oas.annotations.Parameter;
  26 import io.swagger.v3.oas.annotations.media.ArraySchema;
  27 import io.swagger.v3.oas.annotations.media.Content;
  28 import io.swagger.v3.oas.annotations.media.Schema;
  29 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  30 import io.swagger.v3.oas.annotations.servers.Server;
  31 import io.swagger.v3.oas.annotations.servers.Servers;
  32 import io.swagger.v3.oas.annotations.tags.Tag;
  33 import io.swagger.v3.oas.annotations.tags.Tags;
  34 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
  35 import org.glassfish.jersey.media.multipart.FormDataParam;
  36 import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
  37 import org.openecomp.sdc.be.components.impl.ResourceImportManager;
  38 import org.openecomp.sdc.be.components.impl.aaf.AafPermission;
  39 import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed;
  40 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  41 import org.openecomp.sdc.be.impl.ComponentsUtils;
  42 import org.openecomp.sdc.be.impl.ServletUtils;
  43 import org.openecomp.sdc.be.model.UploadResourceInfo;
  44 import org.openecomp.sdc.be.model.User;
  45 import org.openecomp.sdc.be.user.UserBusinessLogic;
  46 import org.openecomp.sdc.common.api.Constants;
  47 import org.openecomp.sdc.common.datastructure.Wrapper;
  48 import org.openecomp.sdc.common.log.wrappers.Logger;
  49 import org.openecomp.sdc.common.zip.exception.ZipException;
  50 import org.springframework.stereotype.Controller;
  51
  52 import javax.inject.Inject;
  53 import javax.servlet.http.HttpServletRequest;
  54 import javax.ws.rs.Consumes;
  55 import javax.ws.rs.DefaultValue;
  56 import javax.ws.rs.HeaderParam;
  57 import javax.ws.rs.POST;
  58 import javax.ws.rs.Path;
  59 import javax.ws.rs.PathParam;
  60 import javax.ws.rs.Produces;
  61 import javax.ws.rs.QueryParam;
  62 import javax.ws.rs.core.Context;
  63 import javax.ws.rs.core.MediaType;
  64 import javax.ws.rs.core.Response;
  65 import java.io.File;
  66 import java.io.FileNotFoundException;
  67
  68 /**
  69  * Root resource (exposed at "/" path)
  70  */
  71 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
  72 @Path("/v1/catalog/upload")
  73 @Tags({@Tag(name = "SDCE-2 APIs")})
  74 @Servers({@Server(url = "/sdc2/rest")})
  75 @Controller
  76 public class ResourceUploadServlet extends AbstractValidationsServlet {
  77
  78     private static final Logger log = Logger.getLogger(ResourceUploadServlet.class);
  79     public static final String NORMATIVE_TYPE_RESOURCE = "multipart";
  80     public static final String CSAR_TYPE_RESOURCE = "csar";
  81     public static final String USER_TYPE_RESOURCE = "user-resource";
  82     public static final String USER_TYPE_RESOURCE_UI_IMPORT = "user-resource-ui-import";
  83
  84     @Inject
  85     public ResourceUploadServlet(UserBusinessLogic userBusinessLogic,
  86         ComponentInstanceBusinessLogic componentInstanceBL,
  87         ComponentsUtils componentsUtils, ServletUtils servletUtils,
  88         ResourceImportManager resourceImportManager) {
  89         super(userBusinessLogic, componentInstanceBL, componentsUtils, servletUtils, resourceImportManager);
  90     }
  91
  92     public enum ResourceAuthorityTypeEnum {
  93         NORMATIVE_TYPE_BE(NORMATIVE_TYPE_RESOURCE, true, false), USER_TYPE_BE(USER_TYPE_RESOURCE, true, true), USER_TYPE_UI(USER_TYPE_RESOURCE_UI_IMPORT, false, true), CSAR_TYPE_BE(CSAR_TYPE_RESOURCE, true, true);
  94
  95         private String urlPath;
  96         private boolean isBackEndImport, isUserTypeResource;
  97
  98         public static ResourceAuthorityTypeEnum findByUrlPath(String urlPath) {
  99             ResourceAuthorityTypeEnum found = null;
 100             for (ResourceAuthorityTypeEnum curr : ResourceAuthorityTypeEnum.values()) {
 101                 if (curr.getUrlPath().equals(urlPath)) {
 102                     found = curr;
 103                     break;
 104                 }
 105             }
 106             return found;
 107         }
 108
 109         private ResourceAuthorityTypeEnum(String urlPath, boolean isBackEndImport, boolean isUserTypeResource) {
 110             this.urlPath = urlPath;
 111             this.isBackEndImport = isBackEndImport;
 112             this.isUserTypeResource = isUserTypeResource;
 113         }
 114
 115         public String getUrlPath() {
 116             return urlPath;
 117         }
 118
 119         public boolean isBackEndImport() {
 120             return isBackEndImport;
 121         }
 122
 123         public boolean isUserTypeResource() {
 124             return isUserTypeResource;
 125         }
 126     }
 127
 128     @POST
 129     @Path("/{resourceAuthority}")
 130     @Consumes(MediaType.MULTIPART_FORM_DATA)
 131     @Produces(MediaType.APPLICATION_JSON)
 132     @Operation(description = "Create Resource from yaml", method = "POST", summary = "Returns created resource",
 133             responses = {@ApiResponse(
 134                     content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 135                     @ApiResponse(responseCode = "201", description = "Resource created"),
 136                     @ApiResponse(responseCode = "403", description = "Restricted operation"),
 137                     @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 138                     @ApiResponse(responseCode = "409", description = "Resource already exist")})
 139     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 140     public Response uploadMultipart(
 141             @Parameter(description = "validValues: normative-resource / user-resource",
 142                     schema = @Schema(allowableValues = {NORMATIVE_TYPE_RESOURCE ,
 143                             USER_TYPE_RESOURCE,USER_TYPE_RESOURCE_UI_IMPORT})) @PathParam(
 144                                     value = "resourceAuthority") final String resourceAuthority,
 145             @Parameter(description = "FileInputStream") @FormDataParam("resourceZip") File file,
 146             @Parameter(description = "ContentDisposition") @FormDataParam("resourceZip") FormDataContentDisposition contentDispositionHeader,
 147             @Parameter(description = "resourceMetadata") @FormDataParam("resourceMetadata") String resourceInfoJsonString,
 148             @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId,
 149             // updateResourse Query Parameter if false checks if already exist
 150             @DefaultValue("true") @QueryParam("createNewVersion") boolean createNewVersion) throws FileNotFoundException, ZipException {
 151
 152         try {
 153
 154             Wrapper<Response> responseWrapper = new Wrapper<>();
 155             Wrapper<User> userWrapper = new Wrapper<>();
 156             Wrapper<UploadResourceInfo> uploadResourceInfoWrapper = new Wrapper<>();
 157             Wrapper<String> yamlStringWrapper = new Wrapper<>();
 158
 159             String url = request.getMethod() + " " + request.getRequestURI();
 160             log.debug("Start handle request of {}", url);
 161
 162             // When we get an errorResponse it will be filled into the
 163             // responseWrapper
 164             validateAuthorityType(responseWrapper, resourceAuthority);
 165
 166             ResourceAuthorityTypeEnum resourceAuthorityEnum = ResourceAuthorityTypeEnum.findByUrlPath(resourceAuthority);
 167
 168             commonGeneralValidations(responseWrapper, userWrapper, uploadResourceInfoWrapper, resourceAuthorityEnum, userId, resourceInfoJsonString);
 169
 170             fillPayload(responseWrapper, uploadResourceInfoWrapper, yamlStringWrapper, userWrapper.getInnerElement(), resourceInfoJsonString, resourceAuthorityEnum, file);
 171
 172             // PayLoad Validations
 173             if(resourceAuthorityEnum != ResourceAuthorityTypeEnum.CSAR_TYPE_BE){
 174                 commonPayloadValidations(responseWrapper, yamlStringWrapper, userWrapper.getInnerElement(), uploadResourceInfoWrapper.getInnerElement());
 175
 176                 specificResourceAuthorityValidations(responseWrapper, uploadResourceInfoWrapper, yamlStringWrapper, userWrapper.getInnerElement(), request, resourceInfoJsonString, resourceAuthorityEnum);
 177             }
 178
 179             if (responseWrapper.isEmpty()) {
 180                 handleImport(responseWrapper, userWrapper.getInnerElement(), uploadResourceInfoWrapper.getInnerElement(), yamlStringWrapper.getInnerElement(), resourceAuthorityEnum, createNewVersion, null);
 181             }
 182
 183             return responseWrapper.getInnerElement();
 184
 185         } catch (Exception e) {
 186             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Upload Resource");
 187             log.debug("upload resource failed with exception", e);
 188             throw e;
 189         }
 190     }
 191 }