gerrit.onap Code Review - sdc.git/blob

   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.*;
  33 import javax.ws.rs.core.MediaType;
  34 import javax.ws.rs.core.Response;
  35
  36 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  37 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  38
  39 @Path(
  40     "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/")
  41 @Produces(MediaType.APPLICATION_JSON)
  42 @Consumes(MediaType.APPLICATION_JSON)
  43 @Api(value = "Vendor Software Product Component Uploads")
  44 @Validated
  45 public interface ComponentMonitoringUploads extends VspEntities {
  46   @POST
  47   @Path("types/{type}/")
  48   @Consumes(MediaType.MULTIPART_FORM_DATA)
  49   @ApiOperation(value = "Upload file for component by type")
  50   Response upload(@Multipart("upload") Attachment attachment,
  51                   @ApiParam(value = "Vendor software product Id") @PathParam("vspId")
  52                       String vspId,
  53                   @ApiParam(value = "Vendor software product version Id")
  54                   @PathParam("versionId") String versionId,
  55                   @ApiParam(value = "Component Id") @PathParam("componentId") String
  56                       componentId,
  57                   @ApiParam(value = "Upload Type") @PathParam("type") String type,
  58                   @NotNull(message = USER_MISSING_ERROR_MSG)
  59                   @HeaderParam(USER_ID_HEADER_PARAM) String user) throws Exception;
  60
  61   @DELETE
  62   @Path("types/{type}")
  63   @ApiOperation(value = "Delete file uploaded for component")
  64   Response delete(
  65       @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  66       @ApiParam(value = "Vendor software product version Id") @PathParam("versionId")
  67           String versionId,
  68       @ApiParam(value = "Component Id") @PathParam("componentId") String componentId,
  69       @ApiParam(value = "Upload Type") @PathParam("type") String type,
  70       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user)
  71       throws Exception;
  72
  73   @GET
  74   @Path("")
  75   @ApiOperation(value = "Get the filenames of uploaded files by type",
  76       response = MonitoringUploadStatusDto.class)
  77   Response list(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  78                 @ApiParam(value = "Vendor software product version Id") @PathParam("versionId")
  79                     String versionId,
  80                 @ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
  81                     String componentId,
  82                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  83                     String user);
  84 }