Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.oodt.cas.workflow.repository
Class XMLWorkflowRepository

java.lang.Object
  extended by org.apache.oodt.cas.workflow.repository.XMLWorkflowRepository
All Implemented Interfaces:
WorkflowRepository
public class XMLWorkflowRepository
extends Object
implements WorkflowRepository

Version:
$Revsion$

A WorkflowRepository that loads events, Workflows, WorkflowTasks and WorkflowConditions from specialized xml files. The WorkflowRepository is given an initial set of seed directory uris, where it looks for the following files:

All of the WorkflowTasks, WorkflowConditions and Workflows themselves are cached in memory by their ids (which are typically URNs).
Author:
mattmann

Constructor Summary
XMLWorkflowRepository(List uris)
           Constructs a new XMLWorkflowRepository with the given parameter uris.
 
Method Summary
 String addTask(WorkflowTask task)
          Adds the provided new WorkflowTask to the model repository.
 String addWorkflow(Workflow workflow)
          Adds the specified new Workflow to this Repository.
 List getConditionsByTaskId(String taskId)
           Returns an ordered List of WorkflowConditions associated with the given taskId.
 List getConditionsByTaskName(String taskName)
           Returns an ordered List of WorkflowConditions associated with the given taskName.
 List<WorkflowCondition> getConditionsByWorkflowId(String workflowId)
          Gets the associated WorkflowConditions for this Workflow specified by its workflowId.
 WorkflowTaskConfiguration getConfigurationByTaskId(String taskId)
           Gets the WorkflowTaskConfiguration metadata for the WorkflowTask with the given taskId.
 List getRegisteredEvents()
           Gets a List of Events that are registered in the Workflow Manager as having valid Workflows mapped to their names.
 WorkflowTask getTaskById(String taskId)
          Returns the WorkflowTask identified by the given taskId.
 List getTasksByWorkflowId(String workflowId)
           Returns a List of WorkflowTasks associated with the specified Workflow identified by its workflowId.
 List getTasksByWorkflowName(String workflowName)
           Returns a List of WorkflowTasks associated with the specified Workflow identified by its workflowName.
 Workflow getWorkflowById(String workflowId)
           Returns a Workflow with the given workflowId.
 Workflow getWorkflowByName(String workflowName)
           Returns a Workflow with the given workflowName.
 WorkflowCondition getWorkflowConditionById(String conditionId)
           Returns the WorkflowCondition with the given conditionId.
 List getWorkflows()
           Gets all Workflows from the repository.
 List getWorkflowsForEvent(String eventName)
           Returns a List of Workflows associated with the specified eventName.
 WorkflowTask getWorkflowTaskById(String taskId)
           Returns the WorkflowTask with the given taskId.
static void main(String[] args)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLWorkflowRepository

public XMLWorkflowRepository(List uris)

Constructs a new XMLWorkflowRepository with the given parameter uris.

Parameters:
uris - URIs pointing to directories that follow the XML workflow repository convention documented at the top of this class.
Method Detail

getRegisteredEvents

public List getRegisteredEvents()
                         throws RepositoryException
Description copied from interface: WorkflowRepository

Gets a List of Events that are registered in the Workflow Manager as having valid Workflows mapped to their names.

Specified by:
getRegisteredEvents in interface WorkflowRepository
Returns:
a List of Events that are registered in the Workflow Manager as having valid Workflows mapped to their names.
Throws:
RepositoryException - If any error occurs.

getWorkflowTaskById

public WorkflowTask getWorkflowTaskById(String taskId)
                                 throws RepositoryException
Description copied from interface: WorkflowRepository

Returns the WorkflowTask with the given taskId.

Specified by:
getWorkflowTaskById in interface WorkflowRepository
Parameters:
taskId - The ID of the WorkflowTask to return.
Returns:
the WorkflowTask with the given taskId.
Throws:
RepositoryException - If any error occurs.

getWorkflowConditionById

public WorkflowCondition getWorkflowConditionById(String conditionId)
                                           throws RepositoryException
Description copied from interface: WorkflowRepository

Returns the WorkflowCondition with the given conditionId.

Specified by:
getWorkflowConditionById in interface WorkflowRepository
Parameters:
conditionId - The ID of the WorkflowCondition to return.
Returns:
the WorkflowCondition with the given conditionId.
Throws:
RepositoryException - If any error occurs.

getWorkflowByName

public Workflow getWorkflowByName(String workflowName)
                           throws RepositoryException
Description copied from interface: WorkflowRepository

Returns a Workflow with the given workflowName.

Specified by:
getWorkflowByName in interface WorkflowRepository
Parameters:
workflowName - The name of the Workflow to obtain.
Returns:
A Workflow with the specified name.
Throws:
RepositoryException - If any error occurs.

getWorkflowById

public Workflow getWorkflowById(String workflowId)
                         throws RepositoryException
Description copied from interface: WorkflowRepository

Returns a Workflow with the given workflowId.

Specified by:
getWorkflowById in interface WorkflowRepository
Parameters:
workflowId - The ID of the Workflow to obtain.
Returns:
A Workflow with the given ID.
Throws:
RepositoryException - If any error occurs.

getWorkflows

public List getWorkflows()
                  throws RepositoryException
Description copied from interface: WorkflowRepository

Gets all Workflows from the repository.

Specified by:
getWorkflows in interface WorkflowRepository
Returns:
A List of all Workflows in the repository.
Throws:
RepositoryException - If any error occurs.

getTasksByWorkflowId

public List getTasksByWorkflowId(String workflowId)
                          throws RepositoryException
Description copied from interface: WorkflowRepository

Returns a List of WorkflowTasks associated with the specified Workflow identified by its workflowId.

Specified by:
getTasksByWorkflowId in interface WorkflowRepository
Parameters:
workflowId - The ID of the Workflow to obtain the List of WorkflowTasks for.
Returns:
A List of WorkflowTasks associated with the specified Workflow.
Throws:
RepositoryException - If any error occurs.

getTasksByWorkflowName

public List getTasksByWorkflowName(String workflowName)
                            throws RepositoryException
Description copied from interface: WorkflowRepository

Returns a List of WorkflowTasks associated with the specified Workflow identified by its workflowName.

Specified by:
getTasksByWorkflowName in interface WorkflowRepository
Parameters:
workflowName - The Name of the Workflow to obtain the List of WorkflowTasks for.
Returns:
A List of WorkflowTasks associated with the specified Workflow.
Throws:
RepositoryException - If any error occurs.

getWorkflowsForEvent

public List getWorkflowsForEvent(String eventName)
                          throws RepositoryException
Description copied from interface: WorkflowRepository

Returns a List of Workflows associated with the specified eventName.

Specified by:
getWorkflowsForEvent in interface WorkflowRepository
Parameters:
eventName - The name of the event to search for workflows for.
Returns:
A List of Workflows associated with the specified event.
Throws:
RepositoryException - If any error occurs.

getConditionsByTaskName

public List getConditionsByTaskName(String taskName)
                             throws RepositoryException
Description copied from interface: WorkflowRepository

Returns an ordered List of WorkflowConditions associated with the given taskName.

Specified by:
getConditionsByTaskName in interface WorkflowRepository
Parameters:
taskName - The taskName to obtain the conditions for.
Returns:
Returns a List of WorkflowConditions associated with the given taskName
Throws:
RepositoryException - If any error occurs.

getConditionsByTaskId

public List getConditionsByTaskId(String taskId)
                           throws RepositoryException
Description copied from interface: WorkflowRepository

Returns an ordered List of WorkflowConditions associated with the given taskId.

Specified by:
getConditionsByTaskId in interface WorkflowRepository
Parameters:
taskId - The ID of the task to obtain the conditions for.
Returns:
Returns a List of WorkflowConditions associated with the given taskId
Throws:
RepositoryException - If any error occurs.

getConfigurationByTaskId

public WorkflowTaskConfiguration getConfigurationByTaskId(String taskId)
                                                   throws RepositoryException
Description copied from interface: WorkflowRepository

Gets the WorkflowTaskConfiguration metadata for the WorkflowTask with the given taskId.

Specified by:
getConfigurationByTaskId in interface WorkflowRepository
Parameters:
taskId - The ID of the WorkflowTask to get the WorkflowTaskConfiguration metadata for.
Returns:
The WorkflowTaskConfiguration metadata for the WorkflowTask with the given taskId.
Throws:
RepositoryException - If any error occurs.

addTask

public String addTask(WorkflowTask task)
               throws RepositoryException
Description copied from interface: WorkflowRepository
Adds the provided new WorkflowTask to the model repository.

Specified by:
addTask in interface WorkflowRepository
Parameters:
task - The new WorkflowTask to add.
Returns:
The identifier of the new WorkflowTask. Calling this function and providing a task with its identifier already set will cause this function to return that same identifier back.
Throws:
RepositoryException - If any error occurs.

addWorkflow

public String addWorkflow(Workflow workflow)
                   throws RepositoryException
Description copied from interface: WorkflowRepository
Adds the specified new Workflow to this Repository.

Specified by:
addWorkflow in interface WorkflowRepository
Parameters:
workflow - The Workflow to add.
Returns:
The identifier of the new Workflow as defined by this repository.
Throws:
RepositoryException - If any error occurs.

getConditionsByWorkflowId

public List<WorkflowCondition> getConditionsByWorkflowId(String workflowId)
                                                  throws RepositoryException
Description copied from interface: WorkflowRepository
Gets the associated WorkflowConditions for this Workflow specified by its workflowId.

Specified by:
getConditionsByWorkflowId in interface WorkflowRepository
Parameters:
workflowId - The Identifier of the Workflow to get the WorkflowConditions for.
Returns:
A List of WorkflowConditions for this Workflow.
Throws:
RepositoryException - If any error occurs.

getTaskById

public WorkflowTask getTaskById(String taskId)
                         throws RepositoryException
Description copied from interface: WorkflowRepository
Returns the WorkflowTask identified by the given taskId.

Specified by:
getTaskById in interface WorkflowRepository
Parameters:
taskId - The identifier for the WorkflowTask to return.
Returns:
The WorkflowTask identified by the given taskId.
Throws:
RepositoryException - If any error occurs.

main

public static void main(String[] args)
                 throws RepositoryException
Parameters:
args -
Throws:
RepositoryException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2012 Apache OODT. All Rights Reserved.