eu.planets_project.ifr.core.wee.api.wsinterface
Interface WeeService

@BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true")
public interface WeeService

WebService Interface for the Planets Workflow Execution Engine. This allows - job submission - querying on a job's status and position in queue - retrieving execution results

Since:

12.11.2008

Field Summary

static java.lang.String	NAME
static javax.xml.namespace.QName	QNAME

Method Summary

int	getPositionInQueue(java.util.UUID ticket) Returns the position in the workflow execution enginge's queue.
int	getProgress(java.util.UUID ticket) Percent of processed (completed) objects
WorkflowResult	getResult(java.util.UUID ticket) Returns a WorkflowResult containing the workflow execution's results.
java.lang.String	getStatus(java.util.UUID ticket) A successfully executed workflow is marked by the status message 'completed'
java.util.UUID	submitWorkflow(java.util.ArrayList<DigitalObject> digObjs, java.lang.String qWorkflowTemplateName, java.lang.String xmlWorkflowConfig)
java.util.UUID	submitWorkflowByReference(java.util.ArrayList<java.net.URI> digObjRefs, java.lang.String qWorkflowTemplateName, java.lang.String xmlWorkflowConfig) since 12.03.2010 An updated interface taking data registry pointers to digital objects instead of submitting the entire payload.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

QNAME

static final javax.xml.namespace.QName QNAME

Method Detail

submitWorkflow

java.util.UUID submitWorkflow(java.util.ArrayList<DigitalObject> digObjs,
                              java.lang.String qWorkflowTemplateName,
                              java.lang.String xmlWorkflowConfig)
                              throws java.lang.Exception

Parameters:

digitalObjects - A listof Planets Digital Objects - this contains the payload the wf is invoked upon

QWorkflowTemplateName - the fully qualified name of the java workflowTemplate to use for this submission. i.e. specifying the structure. Please note: the template must be registered.

xmlWorkflowConfig - holding the workflowTemplate's configuration i.e. specifying how to populate a static template

Returns:

a ticket (UUID) for the submitted job which can be used for polling on the status and its results

Throws:

java.lang.Exception

getStatus

java.lang.String getStatus(java.util.UUID ticket)
                           throws java.lang.Exception

A successfully executed workflow is marked by the status message 'completed'

Parameters:

ticket - the UUID obtained when submitting a job

Returns:

Throws:

java.lang.Exception - for an unknown ticket request

See Also:

for all possible status messages

getPositionInQueue

int getPositionInQueue(java.util.UUID ticket)
                       throws java.lang.Exception

Returns the position in the workflow execution enginge's queue.

Parameters:

ticket - the UUID obtained when submitting a job

Returns:

-1 when already completed, 0 when currently running

Throws:

java.lang.Exception - for an unknown ticket request

getProgress

int getProgress(java.util.UUID ticket)
                throws java.lang.Exception

Percent of processed (completed) objects

Parameters:

ticket - the UUID obtained when submitting a job

Returns:

-1 when scheduled, failed or completed, 0-100 when currently running

Throws:

java.lang.Exception - for an unknown ticket request

getResult

WorkflowResult getResult(java.util.UUID ticket)
                         throws java.lang.Exception

Returns a WorkflowResult containing the workflow execution's results. (e.g. pointers to the Planets data registry on digital objects, events, etc.) Incremental workflow results as they come in when execution is running

Parameters:

ticket - the UUID obtained when submitting a job

Returns:

Throws:

java.lang.Exception - if the workflow failed to terminate successfully or if the ticket is unknown

submitWorkflowByReference

java.util.UUID submitWorkflowByReference(java.util.ArrayList<java.net.URI> digObjRefs,
                                         java.lang.String qWorkflowTemplateName,
                                         java.lang.String xmlWorkflowConfig)
                                         throws java.lang.Exception

since 12.03.2010 An updated interface taking data registry pointers to digital objects instead of submitting the entire payload. This approach requires a shared repository between the caller and the WEE in place

Parameters:

digitalObjects - A list of Planets Digital Object references which contain the payload the wf is invoked upon - object references must be accessible to the WEE

QWorkflowTemplateName - the fully qualified name of the java workflowTemplate to use for this submission. i.e. specifying the structure. Please note: the template must be registered.

xmlWorkflowConfig - holding the workflowTemplate's configuration i.e. specifying how to populate a static template

Returns:

a ticket (UUID) for the submitted job which can be used for polling on the status and its results

Throws:

java.lang.Exception