gerrit.onap Code Review - sdc/sdc-workflow-designer.git/blob

   1 /*
   2  * Copyright © 2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.onap.sdc.workflow.api;
  18
  19 import static org.onap.sdc.workflow.RestUtils.mapVersionStateFilter;
  20 import static org.onap.sdc.workflow.api.RestConstants.USER_ID_HEADER_PARAM;
  21
  22 import io.swagger.annotations.Api;
  23 import io.swagger.annotations.ApiOperation;
  24 import io.swagger.annotations.ApiParam;
  25 import org.onap.sdc.workflow.api.types.CollectionWrapper;
  26 import org.onap.sdc.workflow.api.types.VersionStateDto;
  27 import org.onap.sdc.workflow.persistence.types.ArtifactEntity;
  28 import org.onap.sdc.workflow.persistence.types.WorkflowVersion;
  29 import org.onap.sdc.workflow.services.WorkflowVersionManager;
  30 import org.springframework.beans.factory.annotation.Autowired;
  31 import org.springframework.beans.factory.annotation.Qualifier;
  32 import org.springframework.core.io.InputStreamResource;
  33 import org.springframework.core.io.Resource;
  34 import org.springframework.http.HttpHeaders;
  35 import org.springframework.http.HttpStatus;
  36 import org.springframework.http.MediaType;
  37 import org.springframework.http.ResponseEntity;
  38 import org.springframework.web.bind.annotation.DeleteMapping;
  39 import org.springframework.web.bind.annotation.GetMapping;
  40 import org.springframework.web.bind.annotation.PathVariable;
  41 import org.springframework.web.bind.annotation.PostMapping;
  42 import org.springframework.web.bind.annotation.PutMapping;
  43 import org.springframework.web.bind.annotation.RequestBody;
  44 import org.springframework.web.bind.annotation.RequestHeader;
  45 import org.springframework.web.bind.annotation.RequestMapping;
  46 import org.springframework.web.bind.annotation.RequestParam;
  47 import org.springframework.web.bind.annotation.RestController;
  48 import org.springframework.web.multipart.MultipartFile;
  49
  50 @RequestMapping("/workflows/{workflowId}/versions")
  51 @Api("Workflow versions")
  52 @RestController("workflowsVersionController")
  53 public class WorkflowVersionController {
  54
  55     private final WorkflowVersionManager workflowVersionManager;
  56
  57     @Autowired
  58     public WorkflowVersionController(
  59             @Qualifier("workflowVersionManager") WorkflowVersionManager workflowVersionManager) {
  60         this.workflowVersionManager = workflowVersionManager;
  61     }
  62
  63     @GetMapping
  64     @ApiOperation("List workflow versions")
  65     public CollectionWrapper<WorkflowVersion> list(@PathVariable("workflowId") String workflowId,
  66             @ApiParam(value = "Filter by state", allowableValues = "DRAFT,CERTIFIED")
  67             @RequestParam(value = "state", required = false) String stateFilter,
  68             @RequestHeader(USER_ID_HEADER_PARAM) String user) {
  69         return new CollectionWrapper<>(workflowVersionManager.list(workflowId, mapVersionStateFilter(stateFilter)));
  70     }
  71
  72     @PostMapping
  73     @ApiOperation("Create workflow version")
  74     public ResponseEntity<WorkflowVersion> create(@RequestBody WorkflowVersion version,
  75             @PathVariable("workflowId") String workflowId,
  76             @RequestParam(value = "baseVersionId", required = false) String baseVersionId,
  77             @RequestHeader(USER_ID_HEADER_PARAM) String user) {
  78         WorkflowVersion createdVersion = workflowVersionManager.create(workflowId, baseVersionId, version);
  79         return new ResponseEntity<>(createdVersion, HttpStatus.CREATED);
  80     }
  81
  82     @GetMapping("/{versionId}")
  83     @ApiOperation("Get workflow version")
  84     public WorkflowVersion get(@PathVariable("workflowId") String workflowId,
  85             @PathVariable("versionId") String versionId, @RequestHeader(USER_ID_HEADER_PARAM) String user) {
  86         return workflowVersionManager.get(workflowId, versionId);
  87     }
  88
  89     @PutMapping("/{versionId}")
  90     @ApiOperation("Update workflow version")
  91     public void update(@RequestBody WorkflowVersion version, @PathVariable("workflowId") String workflowId,
  92             @PathVariable("versionId") String versionId, @RequestHeader(USER_ID_HEADER_PARAM) String user) {
  93         version.setId(versionId);
  94         workflowVersionManager.update(workflowId, version);
  95     }
  96
  97     @GetMapping("/{versionId}/state")
  98     @ApiOperation("Get workflow version state")
  99     public VersionStateDto getState(@PathVariable("workflowId") String workflowId,
 100             @PathVariable("versionId") String versionId, @RequestHeader(USER_ID_HEADER_PARAM) String user) {
 101         return new VersionStateDto(workflowVersionManager.getState(workflowId, versionId));
 102     }
 103
 104     @PostMapping("/{versionId}/state")
 105     @ApiOperation("Update workflow version state")
 106     public VersionStateDto updateState(@RequestBody VersionStateDto state,
 107             @PathVariable("workflowId") String workflowId, @PathVariable("versionId") String versionId,
 108             @RequestHeader(USER_ID_HEADER_PARAM) String user) {
 109         workflowVersionManager.updateState(workflowId, versionId, state.getName());
 110         return new VersionStateDto(state.getName());
 111     }
 112
 113     @PutMapping("/{versionId}/artifact")
 114     @ApiOperation("Create/update artifact of a version")
 115     public void uploadArtifact(@RequestBody MultipartFile fileToUpload, @PathVariable("workflowId") String workflowId,
 116             @PathVariable("versionId") String versionId, @RequestHeader(USER_ID_HEADER_PARAM) String user) {
 117         workflowVersionManager.uploadArtifact(workflowId, versionId, fileToUpload);
 118     }
 119
 120     @GetMapping("/{versionId}/artifact")
 121     @ApiOperation("Download workflow version artifact")
 122     public ResponseEntity<Resource> getArtifact(@PathVariable("workflowId") String workflowId,
 123             @PathVariable("versionId") String versionId, @RequestHeader(USER_ID_HEADER_PARAM) String user) {
 124         ArtifactEntity artifact = workflowVersionManager.getArtifact(workflowId, versionId);
 125
 126         return ResponseEntity.ok()
 127                              .header(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=" + artifact.getFileName())
 128                              .contentType(MediaType.APPLICATION_OCTET_STREAM)
 129                              .body(new InputStreamResource(artifact.getArtifactData()));
 130     }
 131
 132     @DeleteMapping("/{versionId}/artifact")
 133     @ApiOperation("Delete workflow version artifact")
 134     public void deleteArtifact(@PathVariable("workflowId") String workflowId,
 135             @PathVariable("versionId") String versionId, @RequestHeader(USER_ID_HEADER_PARAM) String user) {
 136         workflowVersionManager.deleteArtifact(workflowId, versionId);
 137     }
 138 }