public interface RemoteSingleRun extends Remote
Modifier and Type | Method and Description |
---|---|
void |
addListener(RemoteListener listener)
Add a listener to the run.
|
void |
destroy()
Kill off this run, removing all resources which it consumes.
|
Date |
getFinishTimestamp() |
String |
getInputBaclavaFile() |
List<RemoteInput> |
getInputs() |
List<RemoteListener> |
getListeners() |
List<String> |
getListenerTypes()
Get the types of listener supported by this run.
|
String |
getOutputBaclavaFile() |
RemoteSecurityContext |
getSecurityContext() |
Date |
getStartTimestamp() |
RemoteStatus |
getStatus() |
RemoteDirectory |
getWorkingDirectory() |
RemoteInput |
makeInput(String name)
Create an input assignment.
|
RemoteListener |
makeListener(String type,
String configuration)
Create a listener that can be attached to this run.
|
void |
ping()
A do-nothing method, used to check the general reachability of the
workflow run.
|
void |
setGenerateProvenance(boolean generateProvenance)
Sets whether we should generate provenance information from a run.
|
void |
setInputBaclavaFile(String filename)
Sets the Baclava file to use for all inputs.
|
void |
setInteractionServiceDetails(URL interactionFeed,
URL webdavPath,
URL publishUrlBase)
Configures the details to use when setting up the workflow run's
connnection to the interaction feed.
|
void |
setOutputBaclavaFile(String filename)
Sets where the output of the run is to be written to.
|
void |
setStatus(RemoteStatus s)
Set the status of the run, which should cause it to move into the given
state.
|
@Nullable String getInputBaclavaFile() throws RemoteException
RemoteException
- If anything goes wrong with the communication.void setInputBaclavaFile(@Nonnull String filename) throws RemoteException
filename
- The filename to use. Must not start with a / or
contain any .. segments. Will be interpreted relative
to the run's working directory.RemoteException
- If anything goes wrong with the communication.@Nonnull List<RemoteInput> getInputs() throws RemoteException
RemoteException
- If anything goes wrong with the communication.@Nonnull RemoteInput makeInput(@Nonnull String name) throws RemoteException
name
- The name of the port that this will be an input for.RemoteException
- If anything goes wrong with the communication.@Nullable String getOutputBaclavaFile() throws RemoteException
RemoteException
- If anything goes wrong with the communication.void setOutputBaclavaFile(@Nullable String filename) throws RemoteException
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.RemoteException
- If anything goes wrong with the communication.@Nonnull RemoteStatus getStatus() throws RemoteException
RemoteException
- If anything goes wrong with the communication.void setStatus(@Nonnull RemoteStatus s) throws IllegalStateTransitionException, RemoteException, ImplementationException, StillWorkingOnItException
s
- The state to try to change to.IllegalStateTransitionException
- If the requested state change is impossible. (Note that it is
always legal to set the status to the current status.)RemoteException
- If anything goes wrong with the communication.ImplementationException
- If something goes horribly wrong on the back end.StillWorkingOnItException
- If the startup time of the workflow implementation exceeds a
built-in threshold.@Nullable Date getFinishTimestamp() throws RemoteException
RemoteException
- If anything goes wrong with the communication.@Nullable Date getStartTimestamp() throws RemoteException
RemoteException
- If anything goes wrong with the communication.@Nonnull RemoteDirectory getWorkingDirectory() throws RemoteException
RemoteException
- If anything goes wrong with the communication.@Nonnull List<RemoteListener> getListeners() throws RemoteException
RemoteException
- If anything goes wrong with the communication.void addListener(@Nonnull RemoteListener listener) throws RemoteException, ImplementationException
listener
- The listener to add.RemoteException
- If anything goes wrong with the communication.ImplementationException
- If something goes wrong when adding the listener.@Nonnull RemoteSecurityContext getSecurityContext() throws RemoteException, ImplementationException
RemoteException
- If anything goes wrong with the communication.ImplementationException
- If something goes wrong when getting the context.void destroy() throws RemoteException, ImplementationException
RemoteException
- If anything goes wrong with the communication.ImplementationException
- If something goes horribly wrong when destroying the run.@Nonnull List<String> getListenerTypes() throws RemoteException
RemoteException
- If anything goes wrong with the communication.@Nonnull RemoteListener makeListener(@Nonnull String type, @Nonnull String configuration) throws RemoteException
type
- The type name of the listener to create; it must be one of the
names returned by the getListenerTypes()
operation.configuration
- The configuration document for this listener. The nature of
the contents of this are determined by the type.RemoteException
- If anything goes wrong with the communication.void setInteractionServiceDetails(@Nonnull URL interactionFeed, @Nonnull URL webdavPath, @Nullable URL publishUrlBase) throws RemoteException
interactionFeed
- The location of the interaction feed. If null,
defaults from the factory will be used instead.webdavPath
- The location used for pushing web pages to support the feed.
If null, a default from the factory will be used
instead.publishUrlBase
- Where to actually publish to, if this needs to be
different from the location presented in the published HTML
and Feed entries. Necessary in complex network scenarios.RemoteException
- If anything goes wrong with the communication.void ping() throws RemoteException
RemoteException
- If anything goes wrong with the communication.void setGenerateProvenance(boolean generateProvenance) throws RemoteException
generateProvenance
- Boolean flag, true for do the generation. Must be set before
starting the run for this to have an effect.RemoteException
- If anything goes wrong with the communication.Copyright © 2015–2018 The Apache Software Foundation. All rights reserved.