openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/ComponentMonitoringUploads.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.sdcrests.vsp.rest;
  22
  23 import io.swagger.annotations.Api;
  24 import io.swagger.annotations.ApiOperation;
  25 import io.swagger.annotations.ApiParam;
  26 import org.apache.cxf.jaxrs.ext.multipart.Attachment;
  27 import org.apache.cxf.jaxrs.ext.multipart.Multipart;
  28 import org.openecomp.sdcrests.vendorsoftwareproducts.types.MonitoringUploadStatusDto;
  29 import org.springframework.validation.annotation.Validated;
  30
  31 import javax.validation.constraints.NotNull;
  32 import javax.ws.rs.Consumes;
  33 import javax.ws.rs.DELETE;
  34 import javax.ws.rs.GET;
  35 import javax.ws.rs.HeaderParam;
  36 import javax.ws.rs.POST;
  37 import javax.ws.rs.Path;
  38 import javax.ws.rs.PathParam;
  39 import javax.ws.rs.Produces;
  40 import javax.ws.rs.core.MediaType;
  41 import javax.ws.rs.core.Response;
  42
  43 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  44 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  45
  46 @Path(
  47     "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/")
  48 @Produces(MediaType.APPLICATION_JSON)
  49 @Consumes(MediaType.APPLICATION_JSON)
  50 @Api(value = "Vendor Software Product Component Uploads")
  51 @Validated
  52 public interface ComponentMonitoringUploads extends VspEntities {
  53   @POST
  54   @Path("types/{type}/")
  55   @Consumes(MediaType.MULTIPART_FORM_DATA)
  56   @ApiOperation(value = "Upload file for component by type")
  57   Response upload(@Multipart("upload") Attachment attachment,
  58                   @ApiParam(value = "Vendor software product Id") @PathParam("vspId")
  59                       String vspId,
  60                   @ApiParam(value = "Vendor software product version Id")
  61                   @PathParam("versionId") String versionId,
  62                   @ApiParam(value = "Component Id") @PathParam("componentId") String
  63                       componentId,
  64                   @ApiParam(value = "Upload Type") @PathParam("type") String type,
  65                   @NotNull(message = USER_MISSING_ERROR_MSG)
  66                   @HeaderParam(USER_ID_HEADER_PARAM) String user) throws Exception;
  67
  68   @DELETE
  69   @Path("types/{type}")
  70   @ApiOperation(value = "Delete file uploaded for component")
  71   Response delete(
  72       @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  73       @ApiParam(value = "Vendor software product version Id") @PathParam("versionId")
  74           String versionId,
  75       @ApiParam(value = "Component Id") @PathParam("componentId") String componentId,
  76       @ApiParam(value = "Upload Type") @PathParam("type") String type,
  77       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user)
  78       throws Exception;
  79
  80   @GET
  81   @Path("")
  82   @ApiOperation(value = "Get the filenames of uploaded files by type",
  83       response = MonitoringUploadStatusDto.class)
  84   Response list(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  85                 @ApiParam(value = "Vendor software product version Id") @PathParam("versionId")
  86                     String versionId,
  87                 @ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
  88                     String componentId,
  89                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  90                     String user);
  91 }