org.apache.oodt.cas.workflow.system

Class XmlRpcWorkflowManagerClient

java.lang.Object

org.apache.oodt.cas.workflow.system.XmlRpcWorkflowManagerClient

public class XmlRpcWorkflowManagerClient
extends Object

Version:

$Revision$

The XML RPC based workflow manager client.

Author:

mattmann

Constructor Summary

Constructors

Constructor and Description
XmlRpcWorkflowManagerClient(URL url) Constructs a new XmlRpcWorkflowManagerClient with the given url.

Method Summary

Modifier and Type	Method and Description
boolean	clearWorkflowInstances()
String	executeDynamicWorkflow(List<String> taskIds, Metadata metadata)
WorkflowCondition	getConditionById(String conditionId)
WorkflowInstancePage	getFirstPage()
WorkflowInstancePage	getLastPage()
WorkflowInstancePage	getNextPage(WorkflowInstancePage currentPage)
int	getNumWorkflowInstances()
int	getNumWorkflowInstancesByStatus(String status)
WorkflowInstancePage	getPrevPage(WorkflowInstancePage currentPage)
List	getRegisteredEvents()
WorkflowTask	getTaskById(String taskId)
Workflow	getWorkflowById(String workflowId)
double	getWorkflowCurrentTaskWallClockMinutes(String workflowInstId)
WorkflowInstance	getWorkflowInstanceById(String wInstId)
Metadata	getWorkflowInstanceMetadata(String wInstId)
List	getWorkflowInstances()
List	getWorkflowInstancesByStatus(String status)
URL	getWorkflowManagerUrl()
List	getWorkflows()
List	getWorkflowsByEvent(String eventName)
double	getWorkflowWallClockMinutes(String workflowInstId)
static void	main(String[] args)
WorkflowInstancePage	paginateWorkflowInstances(int pageNum)
WorkflowInstancePage	paginateWorkflowInstances(int pageNum, String status)
boolean	pauseWorkflowInstance(String workflowInstId)
boolean	refreshRepository()
boolean	resumeWorkflowInstance(String workflowInstId)
boolean	sendEvent(String eventName, Metadata metadata)
boolean	setWorkflowInstanceCurrentTaskEndDateTime(String wInstId, String endDateTimeIsoStr)
boolean	setWorkflowInstanceCurrentTaskStartDateTime(String wInstId, String startDateTimeIsoStr)
void	setWorkflowManagerUrl(URL workflowManagerUrl)
boolean	stopWorkflowInstance(String workflowInstId)
boolean	updateMetadataForWorkflow(String workflowInstId, Metadata metadata)
boolean	updateWorkflowInstance(WorkflowInstance instance)
boolean	updateWorkflowInstanceStatus(String workflowInstId, String status)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlRpcWorkflowManagerClient

public XmlRpcWorkflowManagerClient(URL url)

Constructs a new XmlRpcWorkflowManagerClient with the given url.

Parameters:

url - The url pointer to the xml rpc workflow manager service.

Method Detail

refreshRepository

public boolean refreshRepository()
                          throws org.apache.xmlrpc.XmlRpcException,
                                 IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

executeDynamicWorkflow

public String executeDynamicWorkflow(List<String> taskIds,
                                     Metadata metadata)
                              throws org.apache.xmlrpc.XmlRpcException,
                                     IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getRegisteredEvents

public List getRegisteredEvents()
                         throws org.apache.xmlrpc.XmlRpcException,
                                IOException,
                                RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getFirstPage

public WorkflowInstancePage getFirstPage()
                                  throws org.apache.xmlrpc.XmlRpcException,
                                         IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getNextPage

public WorkflowInstancePage getNextPage(WorkflowInstancePage currentPage)
                                 throws org.apache.xmlrpc.XmlRpcException,
                                        IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getPrevPage

public WorkflowInstancePage getPrevPage(WorkflowInstancePage currentPage)
                                 throws Exception

Throws:

Exception

getLastPage

public WorkflowInstancePage getLastPage()
                                 throws org.apache.xmlrpc.XmlRpcException,
                                        IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

paginateWorkflowInstances

public WorkflowInstancePage paginateWorkflowInstances(int pageNum,
                                                      String status)
                                               throws org.apache.xmlrpc.XmlRpcException,
                                                      IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

paginateWorkflowInstances

public WorkflowInstancePage paginateWorkflowInstances(int pageNum)
                                               throws org.apache.xmlrpc.XmlRpcException,
                                                      IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getWorkflowsByEvent

public List getWorkflowsByEvent(String eventName)
                         throws org.apache.xmlrpc.XmlRpcException,
                                IOException,
                                RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getWorkflowInstanceMetadata

public Metadata getWorkflowInstanceMetadata(String wInstId)
                                     throws org.apache.xmlrpc.XmlRpcException,
                                            IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

setWorkflowInstanceCurrentTaskStartDateTime

public boolean setWorkflowInstanceCurrentTaskStartDateTime(String wInstId,
                                                           String startDateTimeIsoStr)
                                                    throws org.apache.xmlrpc.XmlRpcException,
                                                           IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getWorkflowCurrentTaskWallClockMinutes

public double getWorkflowCurrentTaskWallClockMinutes(String workflowInstId)
                                              throws org.apache.xmlrpc.XmlRpcException,
                                                     IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getWorkflowWallClockMinutes

public double getWorkflowWallClockMinutes(String workflowInstId)
                                   throws org.apache.xmlrpc.XmlRpcException,
                                          IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

stopWorkflowInstance

public boolean stopWorkflowInstance(String workflowInstId)
                             throws org.apache.xmlrpc.XmlRpcException,
                                    IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

pauseWorkflowInstance

public boolean pauseWorkflowInstance(String workflowInstId)
                              throws org.apache.xmlrpc.XmlRpcException,
                                     IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

resumeWorkflowInstance

public boolean resumeWorkflowInstance(String workflowInstId)
                               throws org.apache.xmlrpc.XmlRpcException,
                                      IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

setWorkflowInstanceCurrentTaskEndDateTime

public boolean setWorkflowInstanceCurrentTaskEndDateTime(String wInstId,
                                                         String endDateTimeIsoStr)
                                                  throws org.apache.xmlrpc.XmlRpcException,
                                                         IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

updateWorkflowInstanceStatus

public boolean updateWorkflowInstanceStatus(String workflowInstId,
                                            String status)
                                     throws org.apache.xmlrpc.XmlRpcException,
                                            IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

updateWorkflowInstance

public boolean updateWorkflowInstance(WorkflowInstance instance)
                               throws org.apache.xmlrpc.XmlRpcException,
                                      IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

updateMetadataForWorkflow

public boolean updateMetadataForWorkflow(String workflowInstId,
                                         Metadata metadata)
                                  throws org.apache.xmlrpc.XmlRpcException,
                                         IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

sendEvent

public boolean sendEvent(String eventName,
                         Metadata metadata)
                  throws org.apache.xmlrpc.XmlRpcException,
                         IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

clearWorkflowInstances

public boolean clearWorkflowInstances()
                               throws org.apache.xmlrpc.XmlRpcException,
                                      IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getTaskById

public WorkflowTask getTaskById(String taskId)
                         throws org.apache.xmlrpc.XmlRpcException,
                                IOException,
                                RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getConditionById

public WorkflowCondition getConditionById(String conditionId)
                                   throws org.apache.xmlrpc.XmlRpcException,
                                          IOException,
                                          RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getWorkflowInstanceById

public WorkflowInstance getWorkflowInstanceById(String wInstId)
                                         throws org.apache.xmlrpc.XmlRpcException,
                                                IOException,
                                                RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getWorkflowById

public Workflow getWorkflowById(String workflowId)
                         throws org.apache.xmlrpc.XmlRpcException,
                                IOException,
                                RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getWorkflows

public List getWorkflows()
                  throws org.apache.xmlrpc.XmlRpcException,
                         IOException,
                         RepositoryException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

RepositoryException

getNumWorkflowInstancesByStatus

public int getNumWorkflowInstancesByStatus(String status)
                                    throws org.apache.xmlrpc.XmlRpcException,
                                           IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getNumWorkflowInstances

public int getNumWorkflowInstances()
                            throws org.apache.xmlrpc.XmlRpcException,
                                   IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getWorkflowInstancesByStatus

public List getWorkflowInstancesByStatus(String status)
                                  throws org.apache.xmlrpc.XmlRpcException,
                                         IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

getWorkflowInstances

public List getWorkflowInstances()
                          throws org.apache.xmlrpc.XmlRpcException,
                                 IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException

main

public static void main(String[] args)

getWorkflowManagerUrl

public URL getWorkflowManagerUrl()

Returns:

Returns the workflowManagerUrl.

setWorkflowManagerUrl

public void setWorkflowManagerUrl(URL workflowManagerUrl)

Parameters:

workflowManagerUrl - The workflowManagerUrl to set.