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