workflow-designer-be/src/main/java/org/onap/sdc/workflow/api/WorkflowController.java

   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.api.RestParams.LIMIT;
  20 import static org.onap.sdc.workflow.api.RestParams.OFFSET;
  21 import static org.onap.sdc.workflow.api.RestParams.SORT;
  22 import static org.onap.sdc.workflow.services.types.PagingConstants.DEFAULT_LIMIT;
  23 import static org.onap.sdc.workflow.services.types.PagingConstants.DEFAULT_OFFSET;
  24
  25 import io.swagger.annotations.Api;
  26 import io.swagger.annotations.ApiImplicitParam;
  27 import io.swagger.annotations.ApiImplicitParams;
  28 import io.swagger.annotations.ApiOperation;
  29 import io.swagger.annotations.ApiParam;
  30 import org.onap.sdc.workflow.api.types.Paging;
  31 import org.onap.sdc.workflow.api.types.Sorting;
  32 import org.onap.sdc.workflow.api.types.VersionStatesFormatter;
  33 import org.onap.sdc.workflow.services.WorkflowManager;
  34 import org.onap.sdc.workflow.services.WorkflowVersionManager;
  35 import org.onap.sdc.workflow.services.annotations.UserId;
  36 import org.onap.sdc.workflow.services.types.Page;
  37 import org.onap.sdc.workflow.services.types.PagingRequest;
  38 import org.onap.sdc.workflow.services.types.RequestSpec;
  39 import org.onap.sdc.workflow.services.types.SortingRequest;
  40 import org.onap.sdc.workflow.services.types.Workflow;
  41 import org.springframework.beans.factory.annotation.Autowired;
  42 import org.springframework.beans.factory.annotation.Qualifier;
  43 import org.springframework.http.HttpStatus;
  44 import org.springframework.http.MediaType;
  45 import org.springframework.http.ResponseEntity;
  46 import org.springframework.validation.annotation.Validated;
  47 import org.springframework.web.bind.annotation.GetMapping;
  48 import org.springframework.web.bind.annotation.PathVariable;
  49 import org.springframework.web.bind.annotation.PostMapping;
  50 import org.springframework.web.bind.annotation.PutMapping;
  51 import org.springframework.web.bind.annotation.RequestBody;
  52 import org.springframework.web.bind.annotation.RequestMapping;
  53 import org.springframework.web.bind.annotation.RequestParam;
  54 import org.springframework.web.bind.annotation.RestController;
  55 import springfox.documentation.annotations.ApiIgnore;
  56
  57 @RequestMapping("/wf/workflows")
  58 @Api("Workflows")
  59 @RestController("workflowController")
  60 public class WorkflowController {
  61
  62     private final WorkflowManager workflowManager;
  63     private final WorkflowVersionManager workflowVersionManager;
  64
  65     @Autowired
  66     public WorkflowController(@Qualifier("workflowManager") WorkflowManager workflowManager,
  67             @Qualifier("workflowVersionManager") WorkflowVersionManager workflowVersionManager) {
  68         this.workflowManager = workflowManager;
  69         this.workflowVersionManager = workflowVersionManager;
  70     }
  71
  72     @GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
  73     @ApiOperation("List workflows")
  74     @ApiImplicitParams({@ApiImplicitParam(name = "versionState", dataType = "string", paramType = "query",
  75             allowableValues = "DRAFT,CERTIFIED", value = "Filter by version state"),
  76             @ApiImplicitParam(name = OFFSET, dataType = "string", paramType = "query", defaultValue = "0",
  77                     value = "Index of the starting item"),
  78             @ApiImplicitParam(name = LIMIT, dataType = "string", paramType = "query", defaultValue = "200",
  79                     value = "Number of returned items"),
  80             @ApiImplicitParam(name = SORT, dataType = "string", paramType = "query", defaultValue = "name:asc",
  81                     value = "Sorting criteria in the format: property:(asc|desc). Default sort order is ascending.",
  82                     allowableValues = "name:asc,name:desc"),
  83             @ApiImplicitParam(name = "searchNameFilter", dataType = "string", paramType = "query",
  84             value = "Filter by workflow name")})
  85     public Page<Workflow> list(@ApiIgnore String searchNameFilter,
  86             @ApiIgnore VersionStatesFormatter versionStateFilter, @ApiIgnore Paging paging,
  87             @ApiIgnore Sorting sorting, @UserId String user) {
  88         return workflowManager.list(searchNameFilter, versionStateFilter.getVersionStates(), initRequestSpec(paging, sorting));
  89     }
  90
  91     @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
  92     @ApiOperation("Create workflow")
  93     public ResponseEntity<Workflow> create(@Validated @RequestBody Workflow workflow, @UserId String user) {
  94         return new ResponseEntity<>(workflowManager.create(workflow), HttpStatus.CREATED);
  95     }
  96
  97     @GetMapping(path = "/{workflowId}")
  98     @ApiOperation("Get workflow")
  99     public Workflow get(@PathVariable("workflowId") String workflowId,
 100             @ApiParam(value = "Expand workflow data", allowableValues = "versions")
 101             @RequestParam(value = "expand", required = false) String expand, @UserId String user) {
 102         Workflow workflow = new Workflow();
 103         workflow.setId(workflowId);
 104         Workflow retrievedWorkflow = workflowManager.get(workflow);
 105         if ("versions".equals(expand)) {
 106             retrievedWorkflow.setVersions(workflowVersionManager.list(workflowId, null));
 107         }
 108         return retrievedWorkflow;
 109     }
 110
 111     @PutMapping(path = "/{workflowId}", consumes = MediaType.APPLICATION_JSON_VALUE)
 112     @ApiOperation("Update workflow")
 113     public Workflow update(@RequestBody Workflow workflow, @PathVariable("workflowId") String workflowId,
 114             @UserId String user) {
 115         workflow.setId(workflowId);
 116         workflowManager.update(workflow);
 117         return workflow;
 118     }
 119
 120     private RequestSpec initRequestSpec(Paging paging, Sorting sorting) {
 121         return new RequestSpec(new PagingRequest(paging.getOffset() == null ? DEFAULT_OFFSET : paging.getOffset(),
 122                 paging.getLimit() == null ? DEFAULT_LIMIT : paging.getLimit()),
 123                 SortingRequest.builder().sorts(sorting.getSorts()).build());
 124     }
 125 }