2 * Copyright © 2018 European Support Limited
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package org.onap.sdc.workflow.api;
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.api.RestParams.USER_ID_HEADER;
23 import static org.onap.sdc.workflow.services.types.PagingConstants.DEFAULT_LIMIT;
24 import static org.onap.sdc.workflow.services.types.PagingConstants.DEFAULT_OFFSET;
26 import io.swagger.annotations.Api;
27 import io.swagger.annotations.ApiImplicitParam;
28 import io.swagger.annotations.ApiImplicitParams;
29 import io.swagger.annotations.ApiOperation;
30 import io.swagger.annotations.ApiParam;
31 import org.onap.sdc.workflow.api.types.Paging;
32 import org.onap.sdc.workflow.api.types.Sorting;
33 import org.onap.sdc.workflow.api.types.VersionStatesFormatter;
34 import org.onap.sdc.workflow.services.WorkflowManager;
35 import org.onap.sdc.workflow.services.WorkflowVersionManager;
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.RequestHeader;
53 import org.springframework.web.bind.annotation.RequestMapping;
54 import org.springframework.web.bind.annotation.RequestParam;
55 import org.springframework.web.bind.annotation.RestController;
56 import springfox.documentation.annotations.ApiIgnore;
58 @RequestMapping("/wf/workflows")
60 @RestController("workflowController")
61 public class WorkflowController {
63 private final WorkflowManager workflowManager;
64 private final WorkflowVersionManager workflowVersionManager;
67 public WorkflowController(@Qualifier("workflowManager") WorkflowManager workflowManager,
68 @Qualifier("workflowVersionManager") WorkflowVersionManager workflowVersionManager) {
69 this.workflowManager = workflowManager;
70 this.workflowVersionManager = workflowVersionManager;
73 @GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
74 @ApiOperation("List workflows")
75 @ApiImplicitParams({@ApiImplicitParam(name = "versionState", dataType = "string", paramType = "query",
76 allowableValues = "DRAFT,CERTIFIED", value = "Filter by version state"),
77 @ApiImplicitParam(name = OFFSET, dataType = "string", paramType = "query", defaultValue = "0",
78 value = "Index of the starting item"),
79 @ApiImplicitParam(name = LIMIT, dataType = "string", paramType = "query", defaultValue = "200",
80 value = "Number of returned items"),
81 @ApiImplicitParam(name = SORT, dataType = "string", paramType = "query", defaultValue = "name:asc",
82 value = "Sorting criteria in the format: property:(asc|desc). Default sort order is ascending.",
83 allowableValues = "name:asc,name:desc"),
84 @ApiImplicitParam(name = "searchNameFilter", dataType = "string", paramType = "query",
85 value = "Filter by workflow name")})
86 public Page<Workflow> list(@ApiIgnore String searchNameFilter,
87 @ApiIgnore VersionStatesFormatter versionStateFilter, @ApiIgnore Paging paging,
88 @ApiIgnore Sorting sorting, @RequestHeader(USER_ID_HEADER) String user) {
89 return workflowManager.list(searchNameFilter, versionStateFilter.getVersionStates(), initRequestSpec(paging, sorting));
92 @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
93 @ApiOperation("Create workflow")
94 public ResponseEntity<Workflow> create(@Validated @RequestBody Workflow workflow,
95 @RequestHeader(USER_ID_HEADER) String user) {
96 return new ResponseEntity<>(workflowManager.create(workflow), HttpStatus.CREATED);
99 @GetMapping(path = "/{workflowId}")
100 @ApiOperation("Get workflow")
101 public Workflow get(@PathVariable("workflowId") String workflowId,
102 @ApiParam(value = "Expand workflow data", allowableValues = "versions")
103 @RequestParam(value = "expand", required = false) String expand,
104 @RequestHeader(USER_ID_HEADER) String user) {
105 Workflow workflow = new Workflow();
106 workflow.setId(workflowId);
107 Workflow retrievedWorkflow = workflowManager.get(workflow);
108 if ("versions".equals(expand)) {
109 retrievedWorkflow.setVersions(workflowVersionManager.list(workflowId, null));
111 return retrievedWorkflow;
114 @PutMapping(path = "/{workflowId}", consumes = MediaType.APPLICATION_JSON_VALUE)
115 @ApiOperation("Update workflow")
116 public Workflow update(@RequestBody Workflow workflow, @PathVariable("workflowId") String workflowId,
117 @RequestHeader(USER_ID_HEADER) String user) {
118 workflow.setId(workflowId);
119 workflowManager.update(workflow);
123 private RequestSpec initRequestSpec(Paging paging, Sorting sorting) {
124 return new RequestSpec(new PagingRequest(paging.getOffset() == null ? DEFAULT_OFFSET : paging.getOffset(),
125 paging.getLimit() == null ? DEFAULT_LIMIT : paging.getLimit()),
126 SortingRequest.builder().sorts(sorting.getSorts()).build());