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

java.lang.Object
  extended by 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
XmlRpcWorkflowManagerClient(URL url)
           Constructs a new XmlRpcWorkflowManagerClient with the given url.
 
Method Summary
 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)
           
 org.apache.oodt.cas.metadata.Metadata getWorkflowInstanceMetadata(String wInstId)
           
 Vector getWorkflowInstances()
           
 Vector getWorkflowInstancesByStatus(String status)
           
 URL getWorkflowManagerUrl()
           
 Vector 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 resumeWorkflowInstance(String workflowInstId)
           
 boolean sendEvent(String eventName, org.apache.oodt.cas.metadata.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, org.apache.oodt.cas.metadata.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

getRegisteredEvents

public List getRegisteredEvents()
                         throws Exception
Throws:
Exception

getFirstPage

public WorkflowInstancePage getFirstPage()
                                  throws Exception
Throws:
Exception

getNextPage

public WorkflowInstancePage getNextPage(WorkflowInstancePage currentPage)
                                 throws Exception
Throws:
Exception

getPrevPage

public WorkflowInstancePage getPrevPage(WorkflowInstancePage currentPage)
                                 throws Exception
Throws:
Exception

getLastPage

public WorkflowInstancePage getLastPage()
                                 throws Exception
Throws:
Exception

paginateWorkflowInstances

public WorkflowInstancePage paginateWorkflowInstances(int pageNum,
                                                      String status)
                                               throws Exception
Throws:
Exception

paginateWorkflowInstances

public WorkflowInstancePage paginateWorkflowInstances(int pageNum)
                                               throws Exception
Throws:
Exception

getWorkflowsByEvent

public List getWorkflowsByEvent(String eventName)
                         throws Exception
Throws:
Exception

getWorkflowInstanceMetadata

public org.apache.oodt.cas.metadata.Metadata getWorkflowInstanceMetadata(String wInstId)
                                                                  throws Exception
Throws:
Exception

setWorkflowInstanceCurrentTaskStartDateTime

public boolean setWorkflowInstanceCurrentTaskStartDateTime(String wInstId,
                                                           String startDateTimeIsoStr)
                                                    throws Exception
Throws:
Exception

getWorkflowCurrentTaskWallClockMinutes

public double getWorkflowCurrentTaskWallClockMinutes(String workflowInstId)
                                              throws Exception
Throws:
Exception

getWorkflowWallClockMinutes

public double getWorkflowWallClockMinutes(String workflowInstId)
                                   throws Exception
Throws:
Exception

stopWorkflowInstance

public boolean stopWorkflowInstance(String workflowInstId)
                             throws Exception
Throws:
Exception

pauseWorkflowInstance

public boolean pauseWorkflowInstance(String workflowInstId)
                              throws Exception
Throws:
Exception

resumeWorkflowInstance

public boolean resumeWorkflowInstance(String workflowInstId)
                               throws Exception
Throws:
Exception

setWorkflowInstanceCurrentTaskEndDateTime

public boolean setWorkflowInstanceCurrentTaskEndDateTime(String wInstId,
                                                         String endDateTimeIsoStr)
                                                  throws Exception
Throws:
Exception

updateWorkflowInstanceStatus

public boolean updateWorkflowInstanceStatus(String workflowInstId,
                                            String status)
                                     throws Exception
Throws:
Exception

updateWorkflowInstance

public boolean updateWorkflowInstance(WorkflowInstance instance)
                               throws Exception
Throws:
Exception

updateMetadataForWorkflow

public boolean updateMetadataForWorkflow(String workflowInstId,
                                         org.apache.oodt.cas.metadata.Metadata metadata)
                                  throws Exception
Throws:
Exception

sendEvent

public boolean sendEvent(String eventName,
                         org.apache.oodt.cas.metadata.Metadata metadata)
                  throws Exception
Throws:
Exception

getTaskById

public WorkflowTask getTaskById(String taskId)
                         throws Exception
Throws:
Exception

getConditionById

public WorkflowCondition getConditionById(String conditionId)
                                   throws Exception
Throws:
Exception

getWorkflowInstanceById

public WorkflowInstance getWorkflowInstanceById(String wInstId)
                                         throws Exception
Throws:
Exception

getWorkflowById

public Workflow getWorkflowById(String workflowId)
                         throws Exception
Throws:
Exception

getWorkflows

public Vector getWorkflows()
                    throws Exception
Throws:
Exception

getNumWorkflowInstancesByStatus

public int getNumWorkflowInstancesByStatus(String status)
                                    throws Exception
Throws:
Exception

getNumWorkflowInstances

public int getNumWorkflowInstances()
                            throws Exception
Throws:
Exception

getWorkflowInstancesByStatus

public Vector getWorkflowInstancesByStatus(String status)
                                    throws Exception
Throws:
Exception

getWorkflowInstances

public Vector getWorkflowInstances()
                            throws Exception
Throws:
Exception

main

public static void main(String[] args)
                 throws MalformedURLException,
                        EngineException,
                        RepositoryException
Throws:
MalformedURLException
EngineException
RepositoryException

getWorkflowManagerUrl

public URL getWorkflowManagerUrl()
Returns:
Returns the workflowManagerUrl.

setWorkflowManagerUrl

public void setWorkflowManagerUrl(URL workflowManagerUrl)
Parameters:
workflowManagerUrl - The workflowManagerUrl to set.


Copyright © 1999-2011 Apache OODT. All Rights Reserved.