edu.illinois.ncsa.datawolf.service

Class WorkflowsResource

java.lang.Object

edu.illinois.ncsa.datawolf.service.WorkflowsResource

@Path(value="/workflows")
public class WorkflowsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
WorkflowsResource()

Method Summary

Methods

Modifier and Type	Method and Description
String	createExecution(String workflowId, boolean run) Create a execution by execution JSON
String	createWorkflow(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input) Create workflow via workflow JSON.
Workflow	createWorkflow(Workflow workflow) Create a new workflow
boolean	deleteWorkflow(String workflowId) Delete a workflow by Id
List<Execution>	getExecutions(String workflowId, int size, int page, boolean showdeleted) Get all executions by workflow id
WorkflowStep	getStep(String workflowId, String stepId) Get a workflow step associated with a workflow
List<WorkflowStep>	getSteps(String workflowId) Get steps associated with a workflow
Workflow	getWorkflow(String workflowId) Get a workflow by Id
List<Workflow>	getWorkflows(int size, int page, String email, boolean showdeleted) Get all workflows
javax.ws.rs.core.Response	getWorkflowZip(String workflowId) Get a workflow by Id
Workflow	updateWorkflow(Workflow workflow) Update workflow by id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowsResource

public WorkflowsResource()

Method Detail

createWorkflow

@POST
@Consumes(value="application/json")
@Produces(value="application/json")
public Workflow createWorkflow(Workflow workflow)

Create a new workflow

Parameters:

workflow - Workflow to create

Returns:

created workflow

updateWorkflow

@PUT
@Path(value="{workflow-id}")
@Consumes(value="application/json")
@Produces(value="application/json")
public Workflow updateWorkflow(Workflow workflow)

Update workflow by id

Parameters:

workflow - Updated workflow

Returns:

Updated workflow

createWorkflow

@POST
@Consumes(value="multipart/form-data")
@Produces(value="text/plain")
public String createWorkflow(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input)

Create workflow via workflow JSON. Expects the following form:

Parameters:

workflow - a workflow created from JSON

Returns:

workflow URI

getWorkflows

@GET
@Produces(value="application/json")
public List<Workflow> getWorkflows(@QueryParam(value="size")@DefaultValue(value="-1")
                                       int size,
                                       @QueryParam(value="page")@DefaultValue(value="0")
                                       int page,
                                       @QueryParam(value="email")@DefaultValue(value="")
                                       String email,
                                       @QueryParam(value="showdeleted")@DefaultValue(value="false")
                                       boolean showdeleted)

Get all workflows

Parameters:

size - number of workflows per page (default -1)

page - page number starting 0

Returns:

getWorkflow

@GET
@Path(value="{workflow-id}")
@Produces(value="application/json")
public Workflow getWorkflow(@PathParam(value="workflow-id")
                                     String workflowId)

Get a workflow by Id

Parameters:

workflowId - workflow Id

Returns:

a workflow in JSON

deleteWorkflow

@DELETE
@Path(value="{workflow-id}")
@Produces(value="application/json")
public boolean deleteWorkflow(@PathParam(value="workflow-id")@DefaultValue(value="")
                                          String workflowId)
                       throws Exception

Delete a workflow by Id

Parameters:

workflowId - id of workflow to delete

Returns:

true if delete successful, false otherwise

Throws:

Exception

getWorkflowZip

@GET
@Path(value="{workflow-id}/zip")
@Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getWorkflowZip(@PathParam(value="workflow-id")
                                                         String workflowId)

Get a workflow by Id

Parameters:

workflowId - workflow Id

Returns:

a workflow in JSON

createExecution

@POST
@Path(value="{workflow-id}/executions")
@Consumes(value="application/json")
public String createExecution(@PathParam(value="workflow-id")
                                        String workflowId,
                                        @QueryParam(value="run")@DefaultValue(value="true")
                                        boolean run)

Create a execution by execution JSON

Parameters:

workflowId - workflow id

run - after create an execution, whether run it or not

Returns:

execution id

getExecutions

@GET
@Path(value="{workflow-id}/executions")
@Produces(value="application/json")
public List<Execution> getExecutions(@PathParam(value="workflow-id")
                                              String workflowId,
                                              @QueryParam(value="size")@DefaultValue(value="100")
                                              int size,
                                              @QueryParam(value="page")@DefaultValue(value="0")
                                              int page,
                                              @QueryParam(value="showdeleted")@DefaultValue(value="false")
                                              boolean showdeleted)

Get all executions by workflow id

Parameters:

workflowId - workflow id

size - number of workflows per page

page - page number starting 0

Returns:

a execution in JSON

getSteps

@GET
@Path(value="{workflow-id}/steps")
@Produces(value="application/json")
public List<WorkflowStep> getSteps(@PathParam(value="workflow-id")@DefaultValue(value="")
                                            String workflowId)
                            throws Exception

Get steps associated with a workflow

Parameters:

workflowId - id of workflow to get steps for

Returns:

workflow steps for the workflow requested

Throws:

Exception

getStep

@GET
@Path(value="{workflow-id}/steps/{step-id}")
@Produces(value="application/json")
public WorkflowStep getStep(@PathParam(value="workflow-id")@DefaultValue(value="")
                                     String workflowId,
                                     @PathParam(value="step-id")@DefaultValue(value="")
                                     String stepId)
                     throws Exception

Get a workflow step associated with a workflow

Parameters:

workflowId - id of workflow to get step for

stepId - id of the step to get

Returns:

requested workflow step

Throws:

Exception