org.apache.oodt.cas.workflow.system

Class XmlRpcWorkflowManager

java.lang.Object

org.apache.oodt.cas.workflow.system.XmlRpcWorkflowManager

public class XmlRpcWorkflowManager
extends Object

An XML RPC-based Workflow manager.

Author:

mattmann (Chris Mattmann), bfoster (Brian Foster)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WEB_SERVER_PORT
static String	ENGINE_RUNNER_FACTORY_PROPERTY
static String	PROPERTIES_FILE_PROPERTY
static String	WORKFLOW_ENGINE_FACTORY_PROPERTY
static String	WORKFLOW_REPOSITORY_FACTORY_PROPERTY
static String	XML_RPC_HANDLER_NAME

Constructor Summary

Constructors

Constructor and Description
XmlRpcWorkflowManager()
XmlRpcWorkflowManager(int port)

Method Summary

Modifier and Type	Method and Description
boolean	clearWorkflowInstances()
String	executeDynamicWorkflow(Vector<String> taskIds, Hashtable metadata)
String	executeDynamicWorkflowCore(Vector<String> taskIds, Map metadata)
Map	getConditionById(String conditionId)
Map	getFirstPage()
Map	getLastPage()
Map	getNextPage(Hashtable currentPage)
Map	getNextPageCore(Map currentPage)
int	getNumWorkflowInstances()
int	getNumWorkflowInstancesByStatus(String status)
Map	getPrevPage(Hashtable currentPage)
Map	getPrevPageCore(Map currentPage)
List	getRegisteredEvents()
Map	getTaskById(String taskId)
Map	getWorkflowById(String workflowId)
double	getWorkflowCurrentTaskWallClockMinutes(String workflowInstId)
Map	getWorkflowInstanceById(String wInstId)
Map	getWorkflowInstanceMetadata(String wInstId)
List	getWorkflowInstances()
List	getWorkflowInstancesByStatus(String status)
List	getWorkflows()
List	getWorkflowsByEvent(String eventName)
double	getWorkflowWallClockMinutes(String workflowInstId)
boolean	handleEvent(String eventName, Hashtable metadata)
boolean	handleEventCore(String eventName, Map metadata)
static void	loadProperties()
static void	main(String[] args)
Map	paginateWorkflowInstances(int pageNum)
Map	paginateWorkflowInstances(int pageNum, String status)
boolean	pauseWorkflowInstance(String workflowInstId)
boolean	refreshRepository()
boolean	resumeWorkflowInstance(String workflowInstId)
boolean	setWorkflowInstanceCurrentTaskEndDateTime(String wInstId, String endDateTimeIsoStr)
boolean	setWorkflowInstanceCurrentTaskStartDateTime(String wInstId, String startDateTimeIsoStr)
boolean	shutdown()
boolean	stopWorkflowInstance(String workflowInstId)
boolean	updateMetadataForWorkflow(String workflowInstId, Hashtable metadata)
boolean	updateWorkflowInstance(Hashtable workflowInst)
boolean	updateWorkflowInstanceCore(Map workflowInst)
boolean	updateWorkflowInstanceStatus(String workflowInstanceId, String status)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WEB_SERVER_PORT

public static final int DEFAULT_WEB_SERVER_PORT

See Also:

Constant Field Values

XML_RPC_HANDLER_NAME

public static final String XML_RPC_HANDLER_NAME

See Also:

Constant Field Values

PROPERTIES_FILE_PROPERTY

public static final String PROPERTIES_FILE_PROPERTY

See Also:

Constant Field Values

WORKFLOW_ENGINE_FACTORY_PROPERTY

public static final String WORKFLOW_ENGINE_FACTORY_PROPERTY

See Also:

Constant Field Values

ENGINE_RUNNER_FACTORY_PROPERTY

public static final String ENGINE_RUNNER_FACTORY_PROPERTY

See Also:

Constant Field Values

WORKFLOW_REPOSITORY_FACTORY_PROPERTY

public static final String WORKFLOW_REPOSITORY_FACTORY_PROPERTY

See Also:

Constant Field Values

Constructor Detail

XmlRpcWorkflowManager

public XmlRpcWorkflowManager()

XmlRpcWorkflowManager

public XmlRpcWorkflowManager(int port)

Method Detail

shutdown

public boolean shutdown()

refreshRepository

public boolean refreshRepository()

executeDynamicWorkflow

public String executeDynamicWorkflow(Vector<String> taskIds,
                                     Hashtable metadata)
                              throws RepositoryException,
                                     EngineException

Throws:

RepositoryException

EngineException

executeDynamicWorkflowCore

public String executeDynamicWorkflowCore(Vector<String> taskIds,
                                         Map metadata)
                                  throws RepositoryException,
                                         EngineException

Throws:

RepositoryException

EngineException

getRegisteredEvents

public List getRegisteredEvents()
                         throws RepositoryException

Throws:

RepositoryException

getFirstPage

public Map getFirstPage()

getNextPage

public Map getNextPage(Hashtable currentPage)

getNextPageCore

public Map getNextPageCore(Map currentPage)

getPrevPage

public Map getPrevPage(Hashtable currentPage)

getPrevPageCore

public Map getPrevPageCore(Map currentPage)

getLastPage

public Map getLastPage()

paginateWorkflowInstances

public Map paginateWorkflowInstances(int pageNum,
                                     String status)
                              throws InstanceRepositoryException

Throws:

InstanceRepositoryException

paginateWorkflowInstances

public Map paginateWorkflowInstances(int pageNum)
                              throws InstanceRepositoryException

Throws:

InstanceRepositoryException

getWorkflowInstanceMetadata

public Map getWorkflowInstanceMetadata(String wInstId)

getWorkflowsByEvent

public List getWorkflowsByEvent(String eventName)
                         throws RepositoryException

Throws:

RepositoryException

handleEvent

public boolean handleEvent(String eventName,
                           Hashtable metadata)
                    throws RepositoryException,
                           EngineException

Throws:

RepositoryException

EngineException

handleEventCore

public boolean handleEventCore(String eventName,
                               Map metadata)
                        throws RepositoryException,
                               EngineException

Throws:

RepositoryException

EngineException

getWorkflowInstanceById

public Map getWorkflowInstanceById(String wInstId)

stopWorkflowInstance

public boolean stopWorkflowInstance(String workflowInstId)

pauseWorkflowInstance

public boolean pauseWorkflowInstance(String workflowInstId)

resumeWorkflowInstance

public boolean resumeWorkflowInstance(String workflowInstId)

getWorkflowWallClockMinutes

public double getWorkflowWallClockMinutes(String workflowInstId)

getWorkflowCurrentTaskWallClockMinutes

public double getWorkflowCurrentTaskWallClockMinutes(String workflowInstId)

getNumWorkflowInstancesByStatus

public int getNumWorkflowInstancesByStatus(String status)
                                    throws InstanceRepositoryException

Throws:

InstanceRepositoryException

getNumWorkflowInstances

public int getNumWorkflowInstances()
                            throws InstanceRepositoryException

Throws:

InstanceRepositoryException

getWorkflowInstancesByStatus

public List getWorkflowInstancesByStatus(String status)
                                  throws EngineException

Throws:

EngineException

getWorkflowInstances

public List getWorkflowInstances()
                          throws EngineException

Throws:

EngineException

clearWorkflowInstances

public boolean clearWorkflowInstances()
                               throws InstanceRepositoryException

Throws:

InstanceRepositoryException

getWorkflows

public List getWorkflows()
                  throws RepositoryException

Throws:

RepositoryException

getTaskById

public Map getTaskById(String taskId)
                throws RepositoryException

Throws:

RepositoryException

getConditionById

public Map getConditionById(String conditionId)
                     throws RepositoryException

Throws:

RepositoryException

getWorkflowById

public Map getWorkflowById(String workflowId)
                    throws RepositoryException

Throws:

RepositoryException

updateMetadataForWorkflow

public boolean updateMetadataForWorkflow(String workflowInstId,
                                         Hashtable metadata)

updateWorkflowInstance

public boolean updateWorkflowInstance(Hashtable workflowInst)

updateWorkflowInstanceCore

public boolean updateWorkflowInstanceCore(Map workflowInst)

setWorkflowInstanceCurrentTaskStartDateTime

public boolean setWorkflowInstanceCurrentTaskStartDateTime(String wInstId,
                                                           String startDateTimeIsoStr)

setWorkflowInstanceCurrentTaskEndDateTime

public boolean setWorkflowInstanceCurrentTaskEndDateTime(String wInstId,
                                                         String endDateTimeIsoStr)

updateWorkflowInstanceStatus

public boolean updateWorkflowInstanceStatus(String workflowInstanceId,
                                            String status)
                                     throws InstanceRepositoryException

Throws:

InstanceRepositoryException

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException

loadProperties

public static void loadProperties()
                           throws IOException

Throws:

IOException