Java WSDLDocumentation類代碼示例

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
@WebMethod(operationName = "getCapabilities")
@WebResult(name = "Capabilities")
@WSDLDocumentation("Get the workflow execution capabilities of this "
		+ "Taverna Server instance.")
List<Capability> getServerCapabilities();
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Make a run for a particular workflow, where that workflow will be
 * downloaded from elsewhere. The URI <i>must</i> be publicly readable.
 * 
 * @param workflowURI
 *            The URI to the workflow to instantiate.
 * @return Annotated handle for created run.
 * @throws NoUpdateException
 * @throws NoCreateException
 */
@WebResult(name = "Run")
@WSDLDocumentation("Make a run for a particular workflow where that "
		+ "workflow is given by publicly readable URI.")
RunReference submitWorkflowByURI(
		@WebParam(name = "workflowURI") @XmlElement(required = true) URI workflowURI)
		throws NoCreateException, NoUpdateException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Tells the run to use the given Baclava file for all inputs.
 * 
 * @param runName
 *            The handle of the run.
 * @param fileName
 *            The name of the file to use. Must not start with a <tt>/</tt>
 *            or contain a <tt>..</tt> element.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws FilesystemAccessException
 *             If the filename is illegal.
 * @throws BadStateChangeException
 *             If the run is not in the {@link Status#Initialized
 *             Initialized} state
 */
@WSDLDocumentation("Tells the given run to use the given already-uploaded Baclava file for all inputs.")
void setRunInputBaclavaFile(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "baclavaFileName") String fileName)
		throws UnknownRunException, NoUpdateException,
		FilesystemAccessException, BadStateChangeException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Tells the run to use the given file for input on the given port. This
 * overrides any previously set file or value on the port and causes the
 * server to forget about using a Baclava file for all inputs.
 * 
 * @param runName
 *            The handle of the run.
 * @param portName
 *            The port to use the file for.
 * @param portFilename
 *            The file to use on the port. Must not start with a <tt>/</tt>
 *            or contain a <tt>..</tt> element.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws FilesystemAccessException
 *             If the filename is illegal.
 * @throws BadStateChangeException
 *             If the run is not in the {@link Status#Initialized
 *             Initialized} state.
 * @throws BadPropertyValueException
 *             If the input port may not be changed to the contents of the
 *             given file.
 */
@WSDLDocumentation("Tells the given run to use the given file for input on the given port.")
void setRunInputPortFile(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "portName") @XmlElement(required = true) String portName,
		@WebParam(name = "portFileName") @XmlElement(required = true) String portFilename)
		throws UnknownRunException, NoUpdateException,
		FilesystemAccessException, BadStateChangeException,
		BadPropertyValueException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Tells the run to use the given value for input on the given port. This
 * overrides any previously set file or value on the port and causes the
 * server to forget about using a Baclava file for all inputs. Note that
 * this is wholly unsuitable for use with binary data.
 * 
 * @param runName
 *            The handle of the run.
 * @param portName
 *            The port to use the file for.
 * @param portValue
 *            The literal value to use on the port.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws BadStateChangeException
 *             If the run is not in the {@link Status#Initialized
 *             Initialized} state.
 * @throws BadPropertyValueException
 *             If the input port may not be changed to the given literal
 *             value.
 */
@WSDLDocumentation("Tells the given run to use the given literal string value for input on the given port.")
void setRunInputPortValue(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "portName") @XmlElement(required = true) String portName,
		@WebParam(name = "portValue") @XmlElement(required = true) String portValue)
		throws UnknownRunException, NoUpdateException,
		BadStateChangeException, BadPropertyValueException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * 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.
 * 
 * @param runName
 *            The handle of the run.
 * @param portName
 *            The port to set the list delimiter for.
 * @param delimiter
 *            The single-character value (in range U+00001..U+0007F) to use
 *            as the delimiter, or <tt>null</tt> for no delimiter at all.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws BadStateChangeException
 *             If the run is not in the {@link Status#Initialized
 *             Initialized} state.
 * @throws BadPropertyValueException
 *             If the delimiter may not be changed to the given literal
 *             value.
 */
@WSDLDocumentation("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(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "portName") @XmlElement(required = true) String portName,
		@WebParam(name = "delimiter") String delimiter)
		throws UnknownRunException, NoUpdateException,
		BadStateChangeException, BadPropertyValueException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Set the Baclava file where the output of the run will be written.
 * 
 * @param runName
 *            The handle of the run.
 * @param outputFile
 *            The filename for the Baclava file, or <tt>null</tt> or the
 *            empty string to indicate that the results are to be written to
 *            the subdirectory <tt>out</tt> of the run's working directory.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws FilesystemAccessException
 *             If the filename is illegal (starts with a <tt>/</tt> or
 *             contains a <tt>..</tt> element.
 * @throws BadStateChangeException
 *             If the run is not in the {@link Status#Initialized
 *             Initialized} state
 */
@WSDLDocumentation("Set the Baclava file where the output of the run will be written.")
void setRunOutputBaclavaFile(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "baclavaFileName") String outputFile)
		throws UnknownRunException, NoUpdateException,
		FilesystemAccessException, BadStateChangeException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Return a description of the outputs of a run.
 * 
 * @param runName
 *            The handle of the run.
 * @return Description document (higher level than filesystem traverse).
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws BadStateChangeException
 *             If the run is in the {@link Status#Initialized Initialized}
 *             state
 * @throws FilesystemAccessException
 *             If there is an exception when accessing the filesystem.
 * @throws NoDirectoryEntryException
 *             If things are odd in the filesystem.
 */
@WebResult(name = "OutputDescription")
@WSDLDocumentation("Return a description of the outputs of a run. Only known during/after the run.")
OutputDescription getRunOutputDescription(
		@WebParam(name = "runName") @XmlElement(required = true) String runName)
		throws UnknownRunException, BadStateChangeException,
		FilesystemAccessException, NoDirectoryEntryException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Set the status of a run. This is used to start it executing, make it stop
 * executing, etc. Note that changing the status of a run can <i>never</i>
 * cause the run to be destroyed.
 * 
 * @param runName
 *            The handle of the run.
 * @param status
 *            The status to change to. Changing to the current status will
 *            always have no effect.
 * @return An empty string if the state change was completed, or a
 *         description (never empty) of why the state change is ongoing.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws BadStateChangeException
 *             If the state change requested is impossible.
 */
@WebResult(name = "PartialityReason")
@WSDLDocumentation("Set the status of a given workflow run.")
String setRunStatus(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "status") @XmlElement(required = true) Status status)
		throws UnknownRunException, NoUpdateException,
		BadStateChangeException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Adds an event listener to the run.
 * 
 * @param runName
 *            The handle of the run.
 * @param listenerType
 *            The type of event listener to add. Must be one of the names
 *            returned by the {@link #getServerListeners()} operation.
 * @param configuration
 *            The configuration document for the event listener; the
 *            interpretation of the configuration is up to the listener.
 * @return The actual name of the listener.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user isn't allowed to manipulate the run.
 * @throws NoListenerException
 *             If the listener construction fails (<i>e.g.</i>, due to an
 *             unsupported <b>listenerType</b> or a problem with the
 *             <b>configuration</b>).
 */
@WebResult(name = "ListenerName")
@WSDLDocumentation("Adds an event listener to the run.")
String addRunListener(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "listenerType") @XmlElement(required = true) String listenerType,
		@WebParam(name = "configuration") @XmlElement(required = true) String configuration)
		throws UnknownRunException, NoUpdateException, NoListenerException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Returns the run bundle of a run. The run must be <i>finished</i> for this
 * to be guaranteed to be present, and must <i>not</i> have had its output
 * generated as Baclava.
 * 
 * @param runName
 *            The handle of the run.
 * @return The contents of the run bundle.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws FilesystemAccessException
 *             If there was a problem reading the bundle.
 * @throws NoDirectoryEntryException
 *             If the bundle doesn't exist currently.
 */
@WebResult(name = "RunBundle")
@WSDLDocumentation("Gets the run bundle of a finished run. MTOM support recommended!")
FileContents getRunBundle(
		@WebParam(name = "runName") @XmlElement(required = true) String runName)
		throws UnknownRunException, FilesystemAccessException,
		NoDirectoryEntryException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Sets whether to generate provenance (in a run bundle) for a run.
 * 
 * @param runName
 *            The handle of the run.
 * @param generateProvenance
 *            Whether to generate provenance.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NoUpdateException
 *             If the user is not allowed to manipulate the run.
 */
@WSDLDocumentation("Sets whether a run generates provenance. "
		+ "Only usefully settable before the run is started.")
void setRunGenerateProvenance(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "generateProvenance") @XmlElement(required = true) boolean generateProvenance)
		throws UnknownRunException, NoUpdateException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Set the permission for a user to access and update a particular workflow
 * run.
 * 
 * @param runName
 *            The name of the run whose permissions are to be updated.
 * @param userName
 *            The name of the user about whom this call is talking.
 * @param permission
 *            The permission level to set.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the current
 *             user is not permitted to see it.
 * @throws 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("Set the permission for a user to access and update a given workflow run.")
void setRunPermission(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "userName") @XmlElement(required = true) String userName,
		@WebParam(name = "permission") @XmlElement(required = true) Permission permission)
		throws UnknownRunException, NotOwnerException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Set a credential associated with the run.
 * 
 * @param runName
 *            The handle of the run.
 * @param credentialID
 *            The handle of the credential to set. If empty, a new
 *            credential will be created.
 * @param credential
 *            The credential to set.
 * @return The handle of the credential that was created or updated.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NotOwnerException
 *             If the user is permitted to see the run, but isn't the owner;
 *             only the owner may manipulate the credentials.
 * @throws InvalidCredentialException
 *             If the <b>credential</b> fails its checks.
 * @throws NoCredentialException
 *             If the <b>credentialID</b> is not empty but does not
 *             correspond to an existing credential.
 * @throws BadStateChangeException
 *             If an attempt to manipulate the credentials is done after the
 *             workflow has started running.
 */
@WebResult(name = "credentialID")
@WSDLDocumentation("Set a credential (password, private key, etc.) associated with the given run. Only the owner may do this.")
String setRunCredential(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "credentialID") @XmlElement(required = true) String credentialID,
		@WebParam(name = "credential") @XmlElement(required = true) Credential credential)
		throws UnknownRunException, NotOwnerException,
		InvalidCredentialException, NoCredentialException,
		BadStateChangeException;
 

import org.apache.cxf.annotations.WSDLDocumentation; //導入依賴的package包/類
/**
 * Delete a credential associated with the run.
 * 
 * @param runName
 *            The handle of the run.
 * @param credentialID
 *            The handle of the credential to delete. If empty, a new
 *            credential will be created.
 * @throws UnknownRunException
 *             If the server doesn't know about the run or if the user is
 *             not permitted to see it.
 * @throws NotOwnerException
 *             If the user is permitted to see the run, but isn't the owner;
 *             only the owner may manipulate the credentials.
 * @throws NoCredentialException
 *             If the given credentialID does not exist.
 * @throws BadStateChangeException
 *             If an attempt to manipulate the credentials is done after the
 *             workflow has started running.
 */
@WSDLDocumentation("Delete a credential associated with the given run. Only the owner may do this.")
void deleteRunCredential(
		@WebParam(name = "runName") @XmlElement(required = true) String runName,
		@WebParam(name = "credentialID") @XmlElement(required = true) String credentialID)
		throws UnknownRunException, NotOwnerException,
		NoCredentialException, BadStateChangeException;