edu.illinois.ncsa.datawolf.service

Class WorkflowToolsResource

java.lang.Object

edu.illinois.ncsa.datawolf.service.WorkflowToolsResource

@Path(value="/workflowtools")
public class WorkflowToolsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
WorkflowToolsResource()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	createTool(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input) Create workflow via workflow JSON.
void	deleteTool(String toolId) Delete the tool given the specific id.
WorkflowTool	getWorkflowTool(String toolId) Get a workflow tool by Id
List<WorkflowTool>	getWorkflowTools(int size, int page, boolean showdeleted, String email) Get all workflow tools
javax.ws.rs.core.Response	getWorkflowToolZip(String toolId) Export a workflow tool by id

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowToolsResource

public WorkflowToolsResource()

Method Detail

getWorkflowTools

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

Get all workflow tools

Parameters:

size - number of workflow tools per page

page - page number starting at 0

Returns:

list of workflow tools

createTool

@POST
@Consumes(value="multipart/form-data")
@Produces(value="application/json")
public String[] createTool(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input)

Create workflow via workflow JSON. Expects the following form:

Parameters:

input - a form posted

Returns:

tool URI

getWorkflowTool

@GET
@Path(value="{tool-id}")
@Produces(value="application/json")
public WorkflowTool getWorkflowTool(@PathParam(value="tool-id")
                                             String toolId)

Get a workflow tool by Id

Parameters:

toolId - workflow tool Id

Returns:

a workflow tool in JSON

deleteTool

@DELETE
@Path(value="{tool-id}")
public void deleteTool(@PathParam(value="tool-id")
                          String toolId)
                throws Exception

Delete the tool given the specific id.

Parameters:

toolId - the tool to be deleted

Throws:

Exception

getWorkflowToolZip

@GET
@Path(value="{tool-id}/zip")
@Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getWorkflowToolZip(@PathParam(value="tool-id")
                                                             String toolId)
                                             throws javax.ws.rs.BadRequestException,
                                                    javax.ws.rs.InternalServerErrorException

Export a workflow tool by id

Parameters:

toolId - id of tool to export

Returns:

zip file of the workflow tool

Throws:

javax.ws.rs.BadRequestException

javax.ws.rs.InternalServerErrorException