@RolesAllowed(value="ROLE_tavernauser") public interface TavernaServerRunREST
Modifier and Type | Interface and Description |
---|---|
static interface |
TavernaServerRunREST.PathNames
Factored out path names used in the
TavernaServerRunREST
interface and related places. |
static class |
TavernaServerRunREST.RunDescription
The description of where everything is in a RESTful view of a workflow
run.
|
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
createTimeOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
destroy()
Deletes a workflow run.
|
javax.ws.rs.core.Response |
expiryOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
finishTimeOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
generateProvenanceOptions()
Get an outline of the operations supported.
|
String |
getCreateTime()
Returns the time when the workflow run was created.
|
TavernaServerRunREST.RunDescription |
getDescription(javax.ws.rs.core.UriInfo ui)
Describes a workflow run.
|
String |
getExpiryTime()
Returns the time when the workflow run becomes eligible for automatic
deletion.
|
String |
getFinishTime()
Returns the time when the workflow run was detected to have finished.
|
boolean |
getGenerateProvenance() |
TavernaServerInputREST |
getInputs(javax.ws.rs.core.UriInfo ui)
Get a delegate for working with the inputs to this workflow run.
|
InteractionFeedREST |
getInteractionFeed()
Get a handle to the interaction feed.
|
TavernaServerListenersREST |
getListeners()
Get the event listeners attached to this workflow run.
|
javax.ws.rs.core.Response |
getLogContents() |
String |
getMainProfileName()
Produces the name of the workflow's main profile.
|
String |
getName()
Get the workflow name.
|
OutputDescription |
getOutputDescription(javax.ws.rs.core.UriInfo ui)
Get a description of the outputs.
|
String |
getOutputFile()
Get the output Baclava file for this workflow run.
|
ProfileList |
getProfiles()
Get a description of the profiles supported by the workflow document used
to create this run.
|
javax.ws.rs.core.Response |
getRunBundle() |
TavernaServerSecurityREST |
getSecurity()
Returns a resource that represents the workflow run's security
properties.
|
String |
getStartTime()
Returns the time when the workflow run was started (through a user-driven
state change).
|
String |
getStatus()
Gets the current status of the workflow run.
|
String |
getStderr() |
String |
getStdout() |
javax.ws.rs.core.Response |
getUsage() |
Workflow |
getWorkflow()
Returns the workflow document used to create the workflow run.
|
TavernaServerDirectoryREST |
getWorkingDirectory()
Get the working directory of this workflow run.
|
javax.ws.rs.core.Response |
logOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
nameOptions()
Produce the workflow name HTTP operations.
|
javax.ws.rs.core.Response |
outputOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
profileOptions()
Produce the workflow profile HTTP operations.
|
javax.ws.rs.core.Response |
runBundleOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
runOptions()
Get an outline of the operations supported.
|
String |
setExpiryTime(String expiry)
Sets the time when the workflow run becomes eligible for automatic
deletion.
|
boolean |
setGenerateProvenance(boolean provenanceFlag) |
String |
setName(String name)
Set the workflow name.
|
String |
setOutputFile(String filename)
Set the output Baclava file for this workflow run.
|
javax.ws.rs.core.Response |
setStatus(String status)
Sets the status of the workflow run.
|
javax.ws.rs.core.Response |
startTimeOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
statusOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
stderrOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
stdoutOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
usageOptions()
Get an outline of the operations supported.
|
javax.ws.rs.core.Response |
workflowOptions()
Get an outline of the operations supported.
|
@GET @Path(value="/") @Produces(value={"application/xml","application/json"}) @Nonnull TavernaServerRunREST.RunDescription getDescription(@Nonnull @Context javax.ws.rs.core.UriInfo ui)
ui
- About the URI used to access this resource.@DELETE @Path(value="/") @Nonnull javax.ws.rs.core.Response destroy() throws NoUpdateException
NoUpdateException
- If the user may see the handle but may not delete it.@OPTIONS @Path(value="/") javax.ws.rs.core.Response runOptions()
@GET @Path(value="workflow") @Produces(value={"application/vnd.taverna.t2flow+xml","application/vnd.taverna.scufl2.workflow-bundle","application/xml","application/json"}) @Nonnull Workflow getWorkflow()
@OPTIONS @Path(value="workflow") javax.ws.rs.core.Response workflowOptions()
@GET @Path(value="name") @Produces(value="text/plain") @Nonnull String getName()
@PUT @Path(value="name") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setName(String name) throws NoUpdateException
NoUpdateException
- If the user is not permitted to change the workflow.@OPTIONS @Path(value="name") @Nonnull javax.ws.rs.core.Response nameOptions()
@GET @Path(value="profile") @Produces(value="text/plain") @Nonnull String getMainProfileName()
@GET @Path(value="profile") @Produces(value={"application/xml","application/json"}) @Nonnull ProfileList getProfiles()
@OPTIONS @Path(value="profile") @Nonnull javax.ws.rs.core.Response profileOptions()
@Path(value="security") @Nonnull TavernaServerSecurityREST getSecurity() throws NotOwnerException
NotOwnerException
- If the accessing principal isn't the owning principal.@GET @Path(value="expiry") @Produces(value="text/plain") @Nonnull String getExpiryTime()
@PUT @Path(value="expiry") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setExpiryTime(@Nonnull String expiry) throws NoUpdateException
expiry
- When the run will expire.NoUpdateException
- If the current user is not permitted to manage the lifetime
of the run.@OPTIONS @Path(value="expiry") javax.ws.rs.core.Response expiryOptions()
@GET @Path(value="createTime") @Produces(value="text/plain") @Nonnull String getCreateTime()
@OPTIONS @Path(value="createTime") javax.ws.rs.core.Response createTimeOptions()
@GET @Path(value="startTime") @Produces(value="text/plain") @Nonnull String getStartTime()
@OPTIONS @Path(value="startTime") javax.ws.rs.core.Response startTimeOptions()
@GET @Path(value="finishTime") @Produces(value="text/plain") @Nonnull String getFinishTime()
@OPTIONS @Path(value="finishTime") javax.ws.rs.core.Response finishTimeOptions()
@GET @Path(value="status") @Produces(value="text/plain") @Nonnull String getStatus()
@PUT @Path(value="status") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull javax.ws.rs.core.Response setStatus(@Nonnull String status) throws NoUpdateException, BadStateChangeException
status
- The new status code.NoUpdateException
- If the current user is not permitted to update the run.BadStateChangeException
- If the state cannot be modified in the manner requested.@OPTIONS @Path(value="status") javax.ws.rs.core.Response statusOptions()
@Path(value="wd") @Nonnull TavernaServerDirectoryREST getWorkingDirectory()
@Path(value="listeners") @Nonnull TavernaServerListenersREST getListeners()
@Path(value="input") @Nonnull TavernaServerInputREST getInputs(@Nonnull @Context javax.ws.rs.core.UriInfo ui)
ui
- About the URI used to access this resource.@GET @Path(value="output") @Produces(value="text/plain") @Nonnull String getOutputFile()
@GET @Path(value="output") @Produces(value={"application/xml","application/json"}) @Nonnull OutputDescription getOutputDescription(@Nonnull @Context javax.ws.rs.core.UriInfo ui) throws BadStateChangeException, FilesystemAccessException, NoDirectoryEntryException
ui
- About the URI used to access this operation.BadStateChangeException
- If the run is in the Initialized
state.FilesystemAccessException
- If problems occur when accessing the filesystem.NoDirectoryEntryException
- If things are odd in the filesystem.@PUT @Path(value="output") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setOutputFile(@Nonnull String filename) throws NoUpdateException, FilesystemAccessException, BadStateChangeException
filename
- The Baclava file to use, or empty to make the outputs be
written to individual files in the out subdirectory
of the working directory.NoUpdateException
- If the current user is not permitted to update the run.FilesystemAccessException
- If the filename is invalid (starts with / or
contains a .. segment).BadStateChangeException
- If the workflow is not in the Initialized state.@OPTIONS @Path(value="output") javax.ws.rs.core.Response outputOptions()
@Path(value="interaction") @Nonnull InteractionFeedREST getInteractionFeed()
@GET @Path(value="stdout") @Produces(value="text/plain") @Nonnull String getStdout() throws NoListenerException
NoListenerException
@OPTIONS @Path(value="stdout") javax.ws.rs.core.Response stdoutOptions()
@GET @Path(value="stderr") @Produces(value="text/plain") @Nonnull String getStderr() throws NoListenerException
NoListenerException
@OPTIONS @Path(value="stderr") javax.ws.rs.core.Response stderrOptions()
@GET @Path(value="usage") @Produces(value="application/xml") @Nonnull javax.ws.rs.core.Response getUsage() throws NoListenerException, JAXBException
NoListenerException
JAXBException
@OPTIONS @Path(value="usage") javax.ws.rs.core.Response usageOptions()
@GET @Path(value="log") @Produces(value="text/plain") @Nonnull javax.ws.rs.core.Response getLogContents()
@OPTIONS @Path(value="log") javax.ws.rs.core.Response logOptions()
@GET @Path(value="run-bundle") @Produces(value="application/vnd.wf4ever.robundle+zip") @Nonnull javax.ws.rs.core.Response getRunBundle()
@OPTIONS @Path(value="run-bundle") javax.ws.rs.core.Response runBundleOptions()
@GET @Path(value="generate-provenance") @Produces(value="text/plain") @Nonnull boolean getGenerateProvenance()
@PUT @Path(value="generate-provenance") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull boolean setGenerateProvenance(boolean provenanceFlag) throws NoUpdateException
provenanceFlag
- Whether to create the run bundle for the workflow run. Only
usefully set-able before the start of the run.NoUpdateException
@OPTIONS @Path(value="generate-provenance") javax.ws.rs.core.Response generateProvenanceOptions()
Copyright © 2015–2018 The Apache Software Foundation. All rights reserved.