openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/Processes.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.sdc.versioning.dao.types.Version;
  29 import org.openecomp.sdcrests.vendorsoftwareproducts.types.ProcessEntityDto;
  30 import org.openecomp.sdcrests.vendorsoftwareproducts.types.ProcessRequestDto;
  31 import org.springframework.validation.annotation.Validated;
  32
  33 import javax.validation.Valid;
  34 import javax.validation.constraints.NotNull;
  35 import javax.validation.constraints.Pattern;
  36 import javax.ws.rs.*;
  37 import javax.ws.rs.core.MediaType;
  38 import javax.ws.rs.core.Response;
  39
  40 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  41 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  42
  43 @Path("/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes")
  44 @Produces(MediaType.APPLICATION_JSON)
  45 @Consumes(MediaType.APPLICATION_JSON)
  46 @Api(value = "Vendor Software Product Processes")
  47 @Validated
  48 public interface Processes {
  49   @GET
  50   @Path("/")
  51   @ApiOperation(value = "List vendor software product processes",
  52       response = ProcessEntityDto.class,
  53       responseContainer = "List")
  54   Response list(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  55                 @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
  56                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  57                     String user);
  58
  59   @DELETE
  60   @Path("/")
  61   @ApiOperation(value = "Delete vendor software product processes",
  62       responseContainer = "List")
  63   Response deleteList(
  64       @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  65       @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
  66       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
  67
  68   @POST
  69   @Path("/")
  70   @ApiOperation(value = "Create a vendor software product process")
  71   Response create(@Valid ProcessRequestDto request,
  72                   @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  73                   @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
  74                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  75                       String user);
  76
  77   @GET
  78   @Path("/{processId}")
  79   @ApiOperation(value = "Get vendor software product process",
  80       response = ProcessEntityDto.class)
  81   Response get(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  82                @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
  83                @ApiParam(value = "Vendor software product process Id") @PathParam("processId")
  84                    String processId,
  85                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  86                    String user);
  87
  88   @DELETE
  89   @Path("/{processId}")
  90   @ApiOperation(value = "Delete vendor software product process")
  91   Response delete(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  92                   @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
  93                   @ApiParam(value = "Vendor software product process Id") @PathParam("processId")
  94                       String processId,
  95                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  96                       String user);
  97
  98   @PUT
  99   @Path("/{processId}")
 100   @ApiOperation(value = "Update vendor software product process")
 101   Response update(@Valid ProcessRequestDto request,
 102                   @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
 103                   @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
 104                   @ApiParam(value = "Vendor software product process Id") @PathParam("processId")
 105                       String processId,
 106                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
 107                       String user);
 108
 109   @GET
 110   @Path("/{processId}/upload")
 111   @Produces(MediaType.APPLICATION_OCTET_STREAM)
 112   @ApiOperation(value = "Get vendor software product process uploaded file")
 113   Response getUploadedFile(
 114       @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
 115       @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
 116       @ApiParam(value = "Vendor software product process Id") @PathParam("processId")
 117           String processId,
 118       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 119
 120   @DELETE
 121   @Path("/{processId}/upload")
 122   @ApiOperation(value = "Delete vendor software product process uploaded file")
 123   Response deleteUploadedFile(
 124       @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
 125       @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
 126       @ApiParam(value = "Vendor software product process Id") @PathParam("processId")
 127           String processId,
 128       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 129
 130   @POST
 131   @Path("/{processId}/upload")
 132   @Consumes(MediaType.MULTIPART_FORM_DATA)
 133   @ApiOperation(value = "Update vendor software product process upload")
 134   Response uploadFile(@Multipart("upload") Attachment attachment,
 135                       @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
 136                       @ApiParam(value = "Vendor software product version Id") @PathParam("versionId") String versionId,
 137                       @ApiParam(value = "Vendor software product process Id")
 138                       @PathParam("processId") String processId,
 139                       @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
 140                           String user);
 141 }