public interface TavernaRun extends Serializable
Modifier and Type | Method and Description |
---|---|
void |
addListener(Listener listener)
Add a listener to the run.
|
void |
destroy()
Kill off this run, removing all resources which it consumes.
|
Date |
getCreationTimestamp() |
Date |
getExpiry() |
Date |
getFinishTimestamp() |
boolean |
getGenerateProvenance() |
String |
getId() |
String |
getInputBaclavaFile() |
List<Input> |
getInputs() |
List<Listener> |
getListeners() |
String |
getName() |
String |
getOutputBaclavaFile() |
TavernaSecurityContext |
getSecurityContext() |
Date |
getStartTimestamp() |
Status |
getStatus() |
Workflow |
getWorkflow() |
Directory |
getWorkingDirectory() |
Input |
makeInput(String name)
Create an input assignment.
|
void |
ping()
Test if this run is really there.
|
void |
setExpiry(Date d)
Set when this run will expire.
|
void |
setGenerateProvenance(boolean generateProvenance) |
void |
setInputBaclavaFile(String filename)
Sets the Baclava file to use for all inputs.
|
void |
setName(String name) |
void |
setOutputBaclavaFile(String filename)
Sets where the output of the run is to be written to.
|
String |
setStatus(Status s)
Set the status of the run, which should cause it to move into the given
state.
|
String getId()
Workflow getWorkflow()
String getName()
void setName(String name)
name
- The new name of the run. May be truncated.String getInputBaclavaFile()
void setInputBaclavaFile(String filename) throws FilesystemAccessException, BadStateChangeException
filename
- The filename to use. Must not start with a / or
contain any .. segments. Will be interpreted relative
to the run's working directory.FilesystemAccessException
- If the filename is invalid.BadStateChangeException
- If the workflow is not in the Initialized
state.Input makeInput(String name) throws BadStateChangeException
name
- The name of the port that this will be an input for.BadStateChangeException
- If the workflow is not in the Initialized
state.String getOutputBaclavaFile()
void setOutputBaclavaFile(String filename) throws FilesystemAccessException, BadStateChangeException
filename
- Where to write the Baclava file (or null to cause the
output to be written to individual files); overwrites any
previous setting of this value.FilesystemAccessException
- If the filename starts with a / or contains a
.. segment.BadStateChangeException
- If the workflow is not in the Initialized
state.Date getExpiry()
void setExpiry(Date d)
d
- Expiry time. Deletion will happen some time after that.Status getStatus()
String setStatus(Status s) throws BadStateChangeException
s
- The state to try to change to.BadStateChangeException
- If the change to the given state is impossible.Directory getWorkingDirectory() throws FilesystemAccessException
FilesystemAccessException
List<Listener> getListeners()
void addListener(Listener listener)
listener
- The listener to add.TavernaSecurityContext getSecurityContext()
void destroy() throws NoDestroyException
NoDestroyException
- If the destruction failed.Date getCreationTimestamp()
Date getStartTimestamp()
Date getFinishTimestamp()
void ping() throws UnknownRunException
Implementation note: Used to test communication fabrics, etc. so implementations of this interface that do not delegate to another object should do nothing.
UnknownRunException
- If things fail.boolean getGenerateProvenance()
void setGenerateProvenance(boolean generateProvenance)
generateProvenance
- whether the run generates provenance dataCopyright © 2015–2018 The Apache Software Foundation. All rights reserved.