@RolesAllowed(value="ROLE_tavernauser") @WSDLDocumentation(value="The SOAP service interface to Taverna 3.1.0 Server.") public interface TavernaServerSOAP
TavernaServerREST
Modifier and Type | Method and Description |
---|---|
String |
addRunListener(String runName,
String listenerType,
String configuration)
Adds an event listener to the run.
|
void |
deleteRunCertificates(String runName,
String certificateID)
Delete a certificate collection associated with the run.
|
void |
deleteRunCredential(String runName,
String credentialID)
Delete a credential associated with the run.
|
void |
destroyRun(String runName)
Destroy a run immediately.
|
void |
destroyRunDirectoryEntry(String runName,
DirEntry dirEntry)
Destroy an entry (file or directory) in or beneath a run's working
directory.
|
FileContents |
getRunBundle(String runName)
Returns the run bundle of a run.
|
Trust[] |
getRunCertificates(String runName)
Get the certificate collections associated with the run.
|
Date |
getRunCreationTime(String runName)
Get the time when the run was created.
|
Credential[] |
getRunCredentials(String runName)
Get the credentials associated with the run.
|
String |
getRunDescriptiveName(String runName)
Get the descriptive name of the workflow run.
|
byte[] |
getRunDirectoryAsZip(String runName,
DirEntry directory)
Get the contents of any directory (and its subdirectories) at/under the
run's working directory, returning it as a compressed ZIP file.
|
ZippedDirectory |
getRunDirectoryAsZipMTOM(String runName,
DirEntry directory)
Get the contents of any directory (and its subdirectories) at/under the
run's working directory, returning it as a compressed ZIP file that is
streamed via MTOM.
|
DirEntry[] |
getRunDirectoryContents(String runName,
DirEntry directory)
Get the contents of any directory at/under the run's working directory.
|
Date |
getRunExpiry(String runName)
Get the time when the run will be eligible to be automatically deleted.
|
byte[] |
getRunFileContents(String runName,
DirEntry file)
Get the contents of a file under the run's working directory.
|
FileContents |
getRunFileContentsMTOM(String runName,
DirEntry file)
Get the contents of a file under the run's working directory via MTOM.
|
long |
getRunFileLength(String runName,
DirEntry file)
Get the length of any file (in bytes) at/under the run's working
directory.
|
Date |
getRunFileModified(String runName,
DirEntry file)
Get the time that the file or directory (at/under the run's working
directory) was last modified.
|
String |
getRunFileType(String runName,
DirEntry file)
Get the content type of any file at/under the run's working directory.
|
Date |
getRunFinishTime(String runName)
Get the time when the run was detected as having finished.
|
boolean |
getRunGenerateProvenance(String runName)
Gets whether to generate provenance (in a run bundle) for a run.
|
InputDescription |
getRunInputDescriptor(String runName)
Get a description of what inputs the workflow run expects to
receive.
|
InputDescription |
getRunInputs(String runName)
Get the description of the inputs to the workflow run.
|
String |
getRunListenerConfiguration(String runName,
String listenerName)
Get the configuration document for an event listener attached to a run.
|
String[] |
getRunListenerProperties(String runName,
String listenerName)
Get the list of properties supported by an event listener attached to a
run.
|
String |
getRunListenerProperty(String runName,
String listenerName,
String propertyName)
Get the value of a property for an event listener attached to a run.
|
String[] |
getRunListeners(String runName)
Get the names of the event listeners attached to the run.
|
String |
getRunLog(String runName)
Returns the log of the workflow run.
|
String |
getRunOutputBaclavaFile(String runName)
Get the Baclava file where the output of the run will be written.
|
OutputDescription |
getRunOutputDescription(String runName)
Return a description of the outputs of a run.
|
String |
getRunOwner(String runName)
Get the owner of the run.
|
Date |
getRunStartTime(String runName)
Get the time when the run was started.
|
Status |
getRunStatus(String runName)
Get the current status of the run.
|
String |
getRunStderr(String runName)
Returns the standard error of the workflow run.
|
String |
getRunStdout(String runName)
Returns the standard output of the workflow run.
|
JobUsageRecord |
getRunUsageRecord(String runName)
Returns the usage record for the workflow run.
|
Workflow |
getRunWorkflow(String runName)
Get the workflow document used to create the given run.
|
WrappedWorkflow |
getRunWorkflowMTOM(String runName)
Get the workflow document used to create the given run.
|
ProfileList |
getRunWorkflowProfiles(String runName)
Get a description of the profiles supported by the workflow document used
to create the given run.
|
List<Capability> |
getServerCapabilities() |
String[] |
getServerListeners()
Get the list of allowed event listeners.
|
int |
getServerMaxRuns()
Get the upper limit on the number of runs that the user may create at
once.
|
String[] |
getServerNotifiers()
Get the list of notification fabrics.
|
String |
getServerStatus()
Gets the status of the server.
|
URI[] |
getServerWorkflows()
Get the list of allowed workflows.
|
PermissionList |
listRunPermissions(String runName)
Get the list of permissions associated with a workflow run.
|
RunReference[] |
listRuns()
Get the list of existing runs owned by the user.
|
DirEntry |
makeRunDirectory(String runName,
DirEntry parent,
String name)
Make a new empty directory beneath an existing one, which must be the
run's working directory or a directory beneath it.
|
DirEntry |
makeRunFile(String runName,
DirEntry parent,
String name)
Make a new empty file in an existing directory, which may be the run's
working directory or any directory beneath it.
|
String |
setRunCertificates(String runName,
String certificateID,
Trust certificate)
Set a certificate collection associated with the run.
|
String |
setRunCredential(String runName,
String credentialID,
Credential credential)
Set a credential associated with the run.
|
void |
setRunDescriptiveName(String runName,
String descriptiveName)
Set the descriptive name of the workflow run.
|
void |
setRunExpiry(String runName,
Date expiry)
Set when the run will be eligible to be automatically deleted.
|
void |
setRunFileContents(String runName,
DirEntry file,
byte[] newContents)
Set the contents of a file under the run's working directory.
|
void |
setRunFileContentsFromURI(String runName,
DirEntryReference file,
URI reference)
Set the contents of a file under the run's working directory to the
contents of a publicly readable URI.
|
void |
setRunFileContentsMTOM(String runName,
FileContents newContents)
Set the contents of a file under the run's working directory.
|
void |
setRunGenerateProvenance(String runName,
boolean generateProvenance)
Sets whether to generate provenance (in a run bundle) for a run.
|
void |
setRunInputBaclavaFile(String runName,
String fileName)
Tells the run to use the given Baclava file for all inputs.
|
void |
setRunInputPortFile(String runName,
String portName,
String portFilename)
Tells the run to use the given file for input on the given port.
|
void |
setRunInputPortListDelimiter(String runName,
String portName,
String delimiter)
Tells the given run to use the given list delimiter (a single-character
string value) for splitting the input on the given port.
|
void |
setRunInputPortValue(String runName,
String portName,
String portValue)
Tells the run to use the given value for input on the given port.
|
void |
setRunListenerProperty(String runName,
String listenerName,
String propertyName,
String value)
Set the value of a property for an event listener attached to a run.
|
void |
setRunOutputBaclavaFile(String runName,
String outputFile)
Set the Baclava file where the output of the run will be written.
|
void |
setRunPermission(String runName,
String userName,
Permission permission)
Set the permission for a user to access and update a particular workflow
run.
|
String |
setRunStatus(String runName,
Status status)
Set the status of a run.
|
RunReference |
submitWorkflow(Workflow workflow)
Make a run for a particular workflow.
|
RunReference |
submitWorkflowByURI(URI workflowURI)
Make a run for a particular workflow, where that workflow will be
downloaded from elsewhere.
|
RunReference |
submitWorkflowMTOM(WrappedWorkflow workflow)
Make a run for a particular workflow.
|
@WSDLDocumentation(value="Make a run for a particular workflow.") RunReference submitWorkflow(Workflow workflow) throws NoUpdateException, NoCreateException
workflow
- The workflow to instantiate.NoUpdateException
NoCreateException
@WSDLDocumentation(value="Make a run for a particular workflow.") RunReference submitWorkflowMTOM(WrappedWorkflow workflow) throws NoUpdateException
workflow
- The workflow to instantiate.NoUpdateException
NoCreateException
@WSDLDocumentation(value="Make a run for a particular workflow where that workflow is given by publicly readable URI.") RunReference submitWorkflowByURI(URI workflowURI) throws NoCreateException, NoUpdateException
workflowURI
- The URI to the workflow to instantiate.NoUpdateException
NoCreateException
@WSDLDocumentation(value="Get the list of existing runs owned by the user.") RunReference[] listRuns()
@WSDLDocumentation(value="Get the upper limit on the number of runs that the user may create at once.") int getServerMaxRuns()
@WSDLDocumentation(value="Get the list of URIs to allowed workflows. If the list is empty, any workflow may be used including those not submitted via URI.") URI[] getServerWorkflows()
@WSDLDocumentation(value="Get the list of allowed types of event listeners.") String[] getServerListeners()
@WSDLDocumentation(value="Get the list of notification fabrics. Each is a URI scheme.") String[] getServerNotifiers()
@WSDLDocumentation(value="Get the workflow execution capabilities of this Taverna Server instance.") List<Capability> getServerCapabilities()
@WSDLDocumentation(value="Destroy a run immediately.") void destroyRun(String runName) throws UnknownRunException, NoUpdateException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the lifetime of the
run.@WSDLDocumentation(value="Get the workflow document used to create the given run.") Workflow getRunWorkflow(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get the workflow document used to create the given run.") WrappedWorkflow getRunWorkflowMTOM(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get a description of the profiles supported by the workflow document used to create the given run.") ProfileList getRunWorkflowProfiles(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get the descriptive name of the workflow run. Carries no deep information.") String getRunDescriptiveName(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Set the descriptive name of the workflow run. Carries no deep information.") void setRunDescriptiveName(String runName, String descriptiveName) throws UnknownRunException, NoUpdateException
runName
- The handle of the run.descriptiveName
- The new descriptive name to set. Note that the implementation
is allowed to arbitrarily truncate this value.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not permitted to update this run.@WSDLDocumentation(value="Get the description of the inputs currently set up for the given workflow run.") InputDescription getRunInputs(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get a description of what inputs the given workflow run expects to receive.") InputDescription getRunInputDescriptor(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Tells the given run to use the given already-uploaded Baclava file for all inputs.") void setRunInputBaclavaFile(String runName, String fileName) throws UnknownRunException, NoUpdateException, FilesystemAccessException, BadStateChangeException
runName
- The handle of the run.fileName
- The name of the file to use. Must not start with a /
or contain a .. element.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.FilesystemAccessException
- If the filename is illegal.BadStateChangeException
- If the run is not in the Initialized
state@WSDLDocumentation(value="Tells the given run to use the given file for input on the given port.") void setRunInputPortFile(String runName, String portName, String portFilename) throws UnknownRunException, NoUpdateException, FilesystemAccessException, BadStateChangeException, BadPropertyValueException
runName
- The handle of the run.portName
- The port to use the file for.portFilename
- The file to use on the port. Must not start with a /
or contain a .. element.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.FilesystemAccessException
- If the filename is illegal.BadStateChangeException
- If the run is not in the Initialized
state.BadPropertyValueException
- If the input port may not be changed to the contents of the
given file.@WSDLDocumentation(value="Tells the given run to use the given literal string value for input on the given port.") void setRunInputPortValue(String runName, String portName, String portValue) throws UnknownRunException, NoUpdateException, BadStateChangeException, BadPropertyValueException
runName
- The handle of the run.portName
- The port to use the file for.portValue
- The literal value to use on the port.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.BadStateChangeException
- If the run is not in the Initialized
state.BadPropertyValueException
- If the input port may not be changed to the given literal
value.@WSDLDocumentation(value="Tells the given run to use the given list delimiter (a single-character string value) for splitting the input on the given port. Note that nullability of the delimiter is supported here.") void setRunInputPortListDelimiter(String runName, String portName, String delimiter) throws UnknownRunException, NoUpdateException, BadStateChangeException, BadPropertyValueException
runName
- The handle of the run.portName
- The port to set the list delimiter for.delimiter
- The single-character value (in range U+00001..U+0007F) to use
as the delimiter, or null for no delimiter at all.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.BadStateChangeException
- If the run is not in the Initialized
state.BadPropertyValueException
- If the delimiter may not be changed to the given literal
value.@WSDLDocumentation(value="Get the Baclava file where the output of the run will be written.") String getRunOutputBaclavaFile(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Set the Baclava file where the output of the run will be written.") void setRunOutputBaclavaFile(String runName, String outputFile) throws UnknownRunException, NoUpdateException, FilesystemAccessException, BadStateChangeException
runName
- The handle of the run.outputFile
- The filename for the Baclava file, or null or the
empty string to indicate that the results are to be written to
the subdirectory out of the run's working directory.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.FilesystemAccessException
- If the filename is illegal (starts with a / or
contains a .. element.BadStateChangeException
- If the run is not in the Initialized
state@WSDLDocumentation(value="Return a description of the outputs of a run. Only known during/after the run.") OutputDescription getRunOutputDescription(String runName) throws UnknownRunException, BadStateChangeException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.BadStateChangeException
- If the run is in the Initialized
stateFilesystemAccessException
- If there is an exception when accessing the filesystem.NoDirectoryEntryException
- If things are odd in the filesystem.@WSDLDocumentation(value="Get the time when the run will be eligible to be automatically deleted.") Date getRunExpiry(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Set when the run will be eligible to be automatically deleted.") void setRunExpiry(String runName, Date expiry) throws UnknownRunException, NoUpdateException
runName
- The handle of the run.expiry
- A date at which the expiry will be scheduled. The actual
deletion will happen an arbitrary amount of time later
(depending on system policy).UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the lifetime of the
run.@WSDLDocumentation(value="Get the time when the run was created.") Date getRunCreationTime(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get the time when the run was started.") Date getRunStartTime(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get the time when the run was detected as having finished.") Date getRunFinishTime(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get the current status of the given workflow run.") Status getRunStatus(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Set the status of a given workflow run.") String setRunStatus(String runName, Status status) throws UnknownRunException, NoUpdateException, BadStateChangeException
runName
- The handle of the run.status
- The status to change to. Changing to the current status will
always have no effect.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.BadStateChangeException
- If the state change requested is impossible.@WSDLDocumentation(value="Get the names of the event listeners attached to the run.") String[] getRunListeners(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Adds an event listener to the run.") String addRunListener(String runName, String listenerType, String configuration) throws UnknownRunException, NoUpdateException, NoListenerException
runName
- The handle of the run.listenerType
- The type of event listener to add. Must be one of the names
returned by the getServerListeners()
operation.configuration
- The configuration document for the event listener; the
interpretation of the configuration is up to the listener.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user isn't allowed to manipulate the run.NoListenerException
- If the listener construction fails (e.g., due to an
unsupported listenerType or a problem with the
configuration).@WSDLDocumentation(value="Returns the stdout from the run engine.") String getRunStdout(String runName) throws UnknownRunException
The equivalent thing can also be fetched from the relevant listener property (i.e., io/stdout).
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Returns the stderr from the run engine.") String getRunStderr(String runName) throws UnknownRunException
The equivalent thing can also be fetched from the relevant listener property (i.e., io/stderr).
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Returns the resource usage from the run engine.") JobUsageRecord getRunUsageRecord(String runName) throws UnknownRunException
The equivalent thing can also be fetched from the relevant listener property (i.e., io/usage).
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Returns the detailed log from the run engine.") String getRunLog(String runName) throws UnknownRunException
This can also be fetched from the appropriate file (i.e., logs/detail.log).
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Gets the run bundle of a finished run. MTOM support recommended!") FileContents getRunBundle(String runName) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If there was a problem reading the bundle.NoDirectoryEntryException
- If the bundle doesn't exist currently.@WSDLDocumentation(value="Gets whether a run generates provenance.") boolean getRunGenerateProvenance(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Sets whether a run generates provenance. Only usefully settable before the run is started.") void setRunGenerateProvenance(String runName, boolean generateProvenance) throws UnknownRunException, NoUpdateException
runName
- The handle of the run.generateProvenance
- Whether to generate provenance.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to manipulate the run.@WSDLDocumentation(value="Get the owner of the given workflow run.") String getRunOwner(String runName) throws UnknownRunException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.@WSDLDocumentation(value="Get the list of permissions associated with a given workflow run.") PermissionList listRunPermissions(String runName) throws UnknownRunException, NotOwnerException
runName
- The name of the run whose permissions are to be obtained.UnknownRunException
- If the server doesn't know about the run or if the current
user is not permitted to see it.NotOwnerException
- If asked to provide this information about a run that the
current user may see but where they are not the owner of it.@WSDLDocumentation(value="Set the permission for a user to access and update a given workflow run.") void setRunPermission(String runName, String userName, Permission permission) throws UnknownRunException, NotOwnerException
runName
- The name of the run whose permissions are to be updated.userName
- The name of the user about whom this call is talking.permission
- The permission level to set.UnknownRunException
- If the server doesn't know about the run or if the current
user is not permitted to see it.NotOwnerException
- If asked to provide this information about a run that the
current user may see but where they are not the owner of it.@WSDLDocumentation(value="Get the credentials (passwords, private keys) associated with the given workflow run. Only the owner may do this.") Credential[] getRunCredentials(String runName) throws UnknownRunException, NotOwnerException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NotOwnerException
- If the user is permitted to see the run, but isn't the owner;
only the owner may see the credentials.@WSDLDocumentation(value="Set a credential (password, private key, etc.) associated with the given run. Only the owner may do this.") String setRunCredential(String runName, String credentialID, Credential credential) throws UnknownRunException, NotOwnerException, InvalidCredentialException, NoCredentialException, BadStateChangeException
runName
- The handle of the run.credentialID
- The handle of the credential to set. If empty, a new
credential will be created.credential
- The credential to set.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NotOwnerException
- If the user is permitted to see the run, but isn't the owner;
only the owner may manipulate the credentials.InvalidCredentialException
- If the credential fails its checks.NoCredentialException
- If the credentialID is not empty but does not
correspond to an existing credential.BadStateChangeException
- If an attempt to manipulate the credentials is done after the
workflow has started running.@WSDLDocumentation(value="Delete a credential associated with the given run. Only the owner may do this.") void deleteRunCredential(String runName, String credentialID) throws UnknownRunException, NotOwnerException, NoCredentialException, BadStateChangeException
runName
- The handle of the run.credentialID
- The handle of the credential to delete. If empty, a new
credential will be created.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NotOwnerException
- If the user is permitted to see the run, but isn't the owner;
only the owner may manipulate the credentials.NoCredentialException
- If the given credentialID does not exist.BadStateChangeException
- If an attempt to manipulate the credentials is done after the
workflow has started running.@WSDLDocumentation(value="Get the trusted (server or CA) certificates associated with the run. Only the owner may do this.") Trust[] getRunCertificates(String runName) throws UnknownRunException, NotOwnerException
runName
- The handle of the run.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NotOwnerException
- If the user is permitted to see the run, but isn't the owner;
only the owner may see the credentials.@WSDLDocumentation(value="Set a trusted (server or CA) certificate associated with the run. Only the owner may do this.") String setRunCertificates(String runName, String certificateID, Trust certificate) throws UnknownRunException, NotOwnerException, InvalidCredentialException, NoCredentialException, BadStateChangeException
runName
- The handle of the run.certificateID
- The handle of the certificate collection to set. If empty, a
new certificate collection will be created.certificate
- The certificate collection to set.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NotOwnerException
- If the user is permitted to see the run, but isn't the owner;
only the owner may manipulate the certificates.InvalidCredentialException
- If the certificate fails its checks.NoCredentialException
- If the credentialID is not empty but does not
correspond to an existing certificate collection.BadStateChangeException
- If an attempt to manipulate the credentials is done after the
workflow has started running.@WSDLDocumentation(value="Delete a trusted (server or CA) certificate associated with the run. Only the owner may do this.") void deleteRunCertificates(String runName, String certificateID) throws UnknownRunException, NotOwnerException, NoCredentialException, BadStateChangeException
runName
- The handle of the run.certificateID
- The handle of the credential to delete.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NotOwnerException
- If the user is permitted to see the run, but isn't the owner;
only the owner may manipulate the certificates.NoCredentialException
- If the given certificateID does not exist.BadStateChangeException
- If an attempt to manipulate the credentials is done after the
workflow has started running.@WSDLDocumentation(value="Get the contents of any directory at/under the run\'s working directory.") DirEntry[] getRunDirectoryContents(String runName, DirEntry directory) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.directory
- The name of the directory to fetch; the main working directory
is / and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the contents of
a file).NoDirectoryEntryException
- If the name of the directory can't be looked up.@WSDLDocumentation(value="Get the contents of any directory (and its subdirectories) at/under the run\'s working directory, returning it as a compressed ZIP file.") byte[] getRunDirectoryAsZip(String runName, DirEntry directory) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.directory
- The name of the directory to fetch; the main working directory
is / and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the contents of
a file).NoDirectoryEntryException
- If the name of the directory can't be looked up.@WSDLDocumentation(value="Get the contents of any directory (and its subdirectories) at/under the run\'s working directory, returning it as a compressed ZIP file that is streamed by MTOM.") ZippedDirectory getRunDirectoryAsZipMTOM(String runName, DirEntry directory) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.directory
- The name of the directory to fetch; the main working directory
is / and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the contents of
a file).NoDirectoryEntryException
- If the name of the directory can't be looked up.@WSDLDocumentation(value="Make a new empty directory beneath an existing one, all relative to the given run\'s main working directory.") DirEntry makeRunDirectory(String runName, DirEntry parent, String name) throws UnknownRunException, NoUpdateException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.parent
- The parent directory that will have the new directory added
beneath it.name
- The name of the directory to create. Must not be the same as
any other file or directory in the parent directory.
The name must not consist of .. or have a
/ in it.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to make modifications to the run.FilesystemAccessException
- If some assumption is violated (e.g., making something with
the same name as something that already exists).NoDirectoryEntryException
- If the name of the containing directory can't be looked up.@WSDLDocumentation(value="Make a new empty file in an existing directory, which may be the run\'s working directory or any directory beneath it.") DirEntry makeRunFile(String runName, DirEntry parent, String name) throws UnknownRunException, NoUpdateException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.parent
- The parent directory that will have the new file added to it.name
- The name of the file to create. Must not be the same as any
other file or directory in the parent directory. The
name must not consist of .. or have a
/ in it.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to make modifications to the run.FilesystemAccessException
- If some assumption is violated (e.g., making something with
the same name as something that already exists).NoDirectoryEntryException
- If the name of the containing directory can't be looked up.@WSDLDocumentation(value="Destroy an entry (file or directory) in or beneath a run\'s working directory.") void destroyRunDirectoryEntry(String runName, DirEntry dirEntry) throws UnknownRunException, NoUpdateException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.dirEntry
- Reference to an existing item in a directory that will be
destroyed. May be a reference to either a file or a directory.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to make modifications to the run.FilesystemAccessException
- If some assumption is violated (e.g., deleting something
which doesn't exist or attempting to delete the main working
directory).NoDirectoryEntryException
- If the name of the file or directory can't be looked up.@WSDLDocumentation(value="Get the contents of a file under the run\'s working directory.") byte[] getRunFileContents(String runName, DirEntry file) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to fetch; the main working directory is
/ and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the contents of
a directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Get the contents of a file via MTOM.") FileContents getRunFileContentsMTOM(String runName, DirEntry file) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to fetch; the main working directory is
/ and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the contents of
a directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Set the contents of a file under the run\'s working directory.") void setRunFileContents(String runName, DirEntry file, byte[] newContents) throws UnknownRunException, NoUpdateException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to update; the main working directory is
/ and .. is always disallowed.newContents
- The literal bytes to set the file contents to.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to make modifications to the run.FilesystemAccessException
- If some assumption is violated (e.g., writing the contents of
a directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Set the contents of a file under the run\'s working directory.") void setRunFileContentsMTOM(String runName, FileContents newContents) throws UnknownRunException, NoUpdateException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.newContents
- The description of what file to set, and what to the file
contents should be set to.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to make modifications to the run.FilesystemAccessException
- If some assumption is violated (e.g., writing the contents of
a directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Set the contents of a file under the run\'s working directory from the contents of a publicly readable URI.") void setRunFileContentsFromURI(String runName, DirEntryReference file, URI reference) throws UnknownRunException, NoUpdateException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to update; the main working directory is
/ and .. is always disallowed.reference
- The publicly readable URI whose contents are to become the
literal bytes of the file's contents.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoUpdateException
- If the user is not allowed to make modifications to the run.FilesystemAccessException
- If some assumption is violated (e.g., writing the contents of
a directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Get the length of any file (in bytes) at/under the run\'s working directory.") long getRunFileLength(String runName, DirEntry file) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to get the length of; the main working
directory is / and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the length of a
directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Get the length of any file (in bytes) at/under the run\'s working directory.") Date getRunFileModified(String runName, DirEntry file) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to get the modification date of; the main
working directory is / and .. is always
disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated.NoDirectoryEntryException
- If the file or directory doesn't exist.@WSDLDocumentation(value="Get the content type of any file at/under the run\'s working directory.") String getRunFileType(String runName, DirEntry file) throws UnknownRunException, FilesystemAccessException, NoDirectoryEntryException
runName
- The handle of the run.file
- The name of the file to get the length of; the main working
directory is / and .. is always disallowed.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.FilesystemAccessException
- If some assumption is violated (e.g., reading the length of a
directory).NoDirectoryEntryException
- If the file doesn't exist.@WSDLDocumentation(value="Get the configuration document for an event listener attached to a run.") String getRunListenerConfiguration(String runName, String listenerName) throws UnknownRunException, NoListenerException
runName
- The handle of the run.listenerName
- The name of the listener attached.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoListenerException
- If no such listener exists.@WSDLDocumentation(value="Get the list of properties supported by an event listener attached to a run.") String[] getRunListenerProperties(String runName, String listenerName) throws UnknownRunException, NoListenerException
runName
- The handle of the run.listenerName
- The name of the listener attached.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoListenerException
- If no such listener exists.@WSDLDocumentation(value="Get the value of a property for an event listener attached to a run.") String getRunListenerProperty(String runName, String listenerName, String propertyName) throws UnknownRunException, NoListenerException
runName
- The handle of the run.listenerName
- The name of the listener attached.propertyName
- The name of the property to read.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoListenerException
- If no such listener exists or if the listener has no such
property.@WSDLDocumentation(value="Set the value of a property for an event listener attached to a run.") void setRunListenerProperty(String runName, String listenerName, String propertyName, String value) throws UnknownRunException, NoUpdateException, NoListenerException
runName
- The handle of the run.listenerName
- The name of the listener attached.propertyName
- The name of the property to write.value
- The value to set the property to.UnknownRunException
- If the server doesn't know about the run or if the user is
not permitted to see it.NoListenerException
- If no such listener exists, the listener has no such
property, or the value is considered "unacceptable" in some
way.NoUpdateException
- If the user is not allowed to make modifications to the run.@WSDLDocumentation(value="A simple way to get the status of the overall server.") String getServerStatus()
Copyright © 2015–2018 The Apache Software Foundation. All rights reserved.