edu.illinois.ncsa.datawolf.service

Class ExecutionsResource

java.lang.Object

edu.illinois.ncsa.datawolf.service.ExecutionsResource

@Path(value="/executions")
public class ExecutionsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
ExecutionsResource()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelExecution(String executionId, String stepIds) Cancel a execution
String	checkHpcFile(String executionId, String file)
boolean	createChartImage(File dataFilePath, File imageFilePath)
String	createExecution(Submission submission) Create execution via Submission JSON
void	deleteExecution(String executionId) Delete execution by id
Execution	getExecution(String executionId) Get a execution by Id
List<Execution>	getExecutions(int size, int page, String email, boolean showdeleted) Get all executions
javax.ws.rs.core.Response	getHpcFile(String executionId, String file)
List<LogFile>	getLogfiles(String executionId) Get all logfiles belonging to the execution
LogFile	getLogfiles(String executionId, String stepId) Get the logfile belonging to a single step of the execution
Map<String,Execution.State>	getState(String executionId) Get the state all steps in an execution
Submission	getSubmissionTemplate(String workflowId, String email)
protected SSHSession	maybeGetSession(URI contact, String user, String userHome)
void	pauseExecution(String executionId) Pause a execution
void	startExecution(String executionId) Start a execution

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionsResource

public ExecutionsResource()

Method Detail

createExecution

@POST
@Consumes(value="application/json")
@Produces(value="text/plain")
public String createExecution(Submission submission)

Create execution via Submission JSON

Parameters:

submission - a submission JSON object

Returns:

execution Id

getSubmissionTemplate

@GET
@Path(value="{workflow-id}/template")
@Produces(value="application/json")
public Submission getSubmissionTemplate(@PathParam(value="workflow-id")
                                                 String workflowId,
                                                 @QueryParam(value="email")@DefaultValue(value="")
                                                 String email)

getExecutions

@GET
@Produces(value="application/json")
public List<Execution> getExecutions(@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 executions

Parameters:

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

page - page number starting 0

email - email of creator

Returns:

list of executions

getExecution

@GET
@Path(value="{execution-id}")
@Produces(value="application/json")
public Execution getExecution(@PathParam(value="execution-id")
                                       String executionId)

Get a execution by Id

Parameters:

executionId - execution id

Returns:

a execution in JSON

deleteExecution

@DELETE
@Path(value="{execution-id}")
public void deleteExecution(@PathParam(value="execution-id")@DefaultValue(value="")
                               String executionId)
                     throws Exception

Delete execution by id

Parameters:

executionId - execution id

Throws:

Exception

checkHpcFile

@GET
@Path(value="{execution-id}/checkhpcfile")
@Produces(value="text/plain")
public String checkHpcFile(@PathParam(value="execution-id")
                                    String executionId,
                                    @QueryParam(value="file")@DefaultValue(value="error.rlt")
                                    String file)

getHpcFile

@GET
@Path(value="{execution-id}/hpcfile")
@Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getHpcFile(@PathParam(value="execution-id")
                                                     String executionId,
                                                     @QueryParam(value="file")@DefaultValue(value="error.rlt")
                                                     String file)

maybeGetSession

protected SSHSession maybeGetSession(URI contact,
                         String user,
                         String userHome)
                              throws Exception

Throws:

Exception

createChartImage

public boolean createChartImage(File dataFilePath,
                       File imageFilePath)

getLogfiles

@GET
@Path(value="{execution-id}/logfiles")
@Produces(value="application/json")
public List<LogFile> getLogfiles(@PathParam(value="execution-id")
                                          String executionId)

Get all logfiles belonging to the execution

Parameters:

executionId - a execution Id

Returns:

list of logfile ids

getLogfiles

@GET
@Path(value="{execution-id}/logfiles/{step-id}")
@Produces(value="application/json")
public LogFile getLogfiles(@PathParam(value="execution-id")
                                    String executionId,
                                    @PathParam(value="step-id")
                                    String stepId)

Get the logfile belonging to a single step of the execution

Parameters:

executionId - a execution Id

stepId - a step Id

Returns:

list of logfile ids

getState

@GET
@Path(value="{execution-id}/state")
@Produces(value="application/json")
public Map<String,Execution.State> getState(@PathParam(value="execution-id")
                                                     String executionId)

Get the state all steps in an execution

Parameters:

executionId - execution id

Returns:

step id and state

startExecution

@PUT
@Path(value="{execution-id}/start")
public void startExecution(@PathParam(value="execution-id")
                           String executionId)

Start a execution

Parameters:

executionId - a execution id

pauseExecution

@PUT
@Path(value="{execution-id}/pause")
public void pauseExecution(@PathParam(value="execution-id")
                           String executionId)

Pause a execution

Parameters:

executionId -

cancelExecution

@PUT
@Path(value="{execution-id}/cancel")
public void cancelExecution(@PathParam(value="execution-id")
                            String executionId,
                            @QueryParam(value="stepids")@DefaultValue(value="")
                            String stepIds)

Cancel a execution

Parameters:

executionId -