java.lang.Object
- ca.corefacility.bioinformatics.irida.ria.web.launchPipeline.LaunchAjaxController

@RestController
@RequestMapping("/ajax/pipeline")
public class LaunchAjaxController
extends java.lang.Object

Controller to handle AJAX requests from the UI for Workflow Pipelines

Constructor Summary

Constructors
Constructor	Description
`LaunchAjaxController(UIPipelineService pipelineService, UIPipelineStartService pipelineStartService, UIPipelineSampleService sampleService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<Pipeline>`	`getAllPipelines(java.util.Locale locale)`	Get a list of all pipelines in the IRIDA instance
`java.util.List<Pipeline>`	`getAutomatedPipelines(java.util.Locale locale)`	Get a list of available automated pipelines within the IRIDA instance
`org.springframework.http.ResponseEntity<AjaxResponse>`	`getPipelineDetails(java.util.UUID id, java.util.Locale locale)`	Get the launch page for a specific IRIDA Workflow Pipeline.
`org.springframework.http.ResponseEntity<java.util.List<LaunchSample>>`	`getPipelineSamples(boolean paired, boolean singles)`	Get a list of the samples that are in the cart and get their associated sequence files that can be used on the current pipeline
`org.springframework.http.ResponseEntity<AjaxResponse>`	`launchPipeline(java.util.UUID id, LaunchRequest request, java.util.Locale locale)`	Launch a new IRIDA Workflow Pipeline
`org.springframework.http.ResponseEntity<AjaxResponse>`	`saveNewPipelineParameters(java.util.UUID id, SavePipelineParametersRequest parameters, java.util.Locale locale)`	Save a new set of named pipeline parameters

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LaunchAjaxController

@Autowired
public LaunchAjaxController(UIPipelineService pipelineService,
                            UIPipelineStartService pipelineStartService,
                            UIPipelineSampleService sampleService)

Method Detail

getPipelineDetails

@GetMapping("/{id}")
public org.springframework.http.ResponseEntity<AjaxResponse> getPipelineDetails(@PathVariable
                                                                                java.util.UUID id,
                                                                                java.util.Locale locale)

Get the launch page for a specific IRIDA Workflow Pipeline.

Parameters:: id - identifier for a pipeline.; locale - current users locale information
Returns:: The details about a specific pipeline else returns a status that the pipeline cannot be found.

getPipelineSamples

@GetMapping("/samples")
public org.springframework.http.ResponseEntity<java.util.List<LaunchSample>> getPipelineSamples(@RequestParam(required=false,defaultValue="false")
                                                                                                boolean paired,
                                                                                                @RequestParam(required=false,defaultValue="false")
                                                                                                boolean singles)

Get a list of the samples that are in the cart and get their associated sequence files that can be used on the current pipeline

Parameters:: paired - Whether paired end files can be run on the current pipeline; singles - Whether single end files can be run on the current pipeline
Returns:: list of samples containing their associated sequencing data

launchPipeline

@PostMapping("/{id}")
public org.springframework.http.ResponseEntity<AjaxResponse> launchPipeline(@PathVariable
                                                                            java.util.UUID id,
                                                                            @RequestBody
                                                                            LaunchRequest request,
                                                                            java.util.Locale locale)
                                                                     throws IridaWorkflowNotFoundException,
                                                                            ReferenceFileRequiredException,
                                                                            MissingRequiredParametersException

Launch a new IRIDA Workflow Pipeline

Parameters:: id - The UUID for a workflow; request - required parameters to launch the pipeline; locale - the Locale of the currently logged in user.
Returns:: A response to let the UI know the pipeline was launched successfully
Throws:: IridaWorkflowNotFoundException; ReferenceFileRequiredException; MissingRequiredParametersException

saveNewPipelineParameters

@PostMapping("/{id}/parameters")
public org.springframework.http.ResponseEntity<AjaxResponse> saveNewPipelineParameters(@PathVariable
                                                                                       java.util.UUID id,
                                                                                       @RequestBody
                                                                                       SavePipelineParametersRequest parameters,
                                                                                       java.util.Locale locale)

Save a new set of named pipeline parameters

Parameters:: id - identifier for a irida workflow; parameters - details about the new set of parameters; locale - Current users locale
Returns:: The identifier for the newly created named parameter set, wrapped in a ajax response

getAllPipelines
```
@GetMapping("")
public java.util.List<Pipeline> getAllPipelines(java.util.Locale locale)
```
Get a list of all pipelines in the IRIDA instance

Parameters:

locale - currently logged in users locale

Returns:

list of pipelines

getAutomatedPipelines
```
@GetMapping("/automated")
public java.util.List<Pipeline> getAutomatedPipelines(java.util.Locale locale)
```
Get a list of available automated pipelines within the IRIDA instance

Parameters:

locale - currently logged in users locale

Returns:

List of automated pipelines available

Class LaunchAjaxController