osworkflow API 分析(转)

http://pfwang.iteye.com/blog/98185

 

 

1.com.opensymphony.workflow.Workflow 工作流的用户接口。

       主要定义了用户对工作流的操作方法和用户获得工作流信息的方法。如doAction(long id, int actionId, Map inputs)方法可以执行工作流的Action并产生transaction；用户调用getAvailableActions(long id, Map inputs)可以获得知道工作流实例中符合条件的可以执行的Action。

2.com.opensymphony.workflow.WorkflowContext 工作流的Context接口。

      只有两个方法，其中getCaller()获得调用者，setRollbackOnly()可以回滚Action造成的transaction。

      setRollbackOnly()方法非常重要，可以在此方法中实现工作流数据与业务数据的事务处理。由于工作流引擎将流程数据与业务数据分离开管理， 所以工作流数据与业务数据之间的事务处理往往比较困难，甚至有很多商业的工作流引擎都没有解决这个问题，造成软件上的漏洞。可惜在 BasicWorkflowContext中并没有实现回滚时的事务处理，但实现起来应该不会很困难，在以后会单独考虑。

3.com.opensymphony.workflow.spi.WorkflowEntry 工作流实例的接口。

     定义了获得工作流实例信息的方法。

4.com.opensymphony.workflow.config.Configuration 工作流配置接口。

      获得osworkflw的配置信息和流程的定义信息， osworkflow中的例子就是使用此接口的默认实现。如果想让osworkflw与自己的系统更好的整合，这个接口需要自己实现。

5.com.opensymphony.workflow.loader.AbstractWorkflowFactory 流程定义的解析器。

      osworkflow中提供了此抽象类的3种实现，最常用的是XMLWorkflowFactory，可以对编写的工作流定义xml文件进行解析。

6.com.opensymphony.workflow.spi.WorkflowStore 工作流存储接口。

      实现此接口可以实现用多种途径保存工作流信息，jdbc,hibernate,ejb,memory.........

AbstractWorkflow类是workflow接口的最基本的实现。

1.public int[] getAvailableActions(long id, Map inputs)方法：

返回当前可以执行的Ation。

• 得到工作流流程实例。
• 得到工作流实例的定义。
• 得到工作流实例的PropertySet。
• 得到工作流的当前Step。
• 产生TransientVars。
• 得到Global Actions。
• 判断可以执行的Global Action增加到可执行Action列表中。
• 获得当前Steps中的可执行Action并添加到可执行Action列表中。
• 返回可执行Actions。

2. public void setConfiguration(Configuration configuration)方法：

设置工作流配置方法。

3.public Configuration getConfiguration()方法：

返回工作流配置方法，如果没有获得配置信息，初始化配置信息。

4.public List getCurrentSteps(long id)：

获得工作流当前所在步骤。

5.public int getEntryState(long id):

获得工作流的状态。

6.public List getHistorySteps(long id)

获得工作流的历史步骤。

7. public Properties getPersistenceProperties()

获得设置的持久化参数。

8.public PropertySet getPropertySet(long id)

得到工作流的PropertySet，调用store中的方法。

9.public List getSecurityPermissions(long id)

得到工作流当前Step的permissions。

10.public WorkflowDescriptor getWorkflowDescriptor(String workflowName)

得到工作流的定义。

11.public String getWorkflowName(long id)

根据工作流实例返回工作流定义名。

12. public String[] getWorkflowNames()

返回系统中配置的所有工作流的名字。

13.public boolean canInitialize(String workflowName, int initialAction)，public boolean canInitialize(String workflowName, int initialAction, Map inputs)，private boolean canInitialize(String workflowName, int initialAction, Map transientVars, PropertySet ps) throws WorkflowException

判断指定的工作流初始化Action是不是可以执行。

14.public boolean canModifyEntryState(long id, int newState)

判断工作流是不是可以转换到指定状态。

• 不可以转换到CREATED状态。
• CREATED，SUSPENDED可以转换到ACTIVATED状态。
• ACTIVATED可以转换到SUSPENDED状态。
• CREATED，ACTIVATED，SUSPENDED 可以转换到KILLED状态。

15.public void changeEntryState(long id, int newState) throws WorkflowException

转换工作流状态。

16.public void doAction(long id, int actionId, Map inputs) throws WorkflowException

执行Action。

• 获得工作流store，和流程实例entry。
• 判断是不是活动的工作流，不是就返回。
• 获得工作流的定义。
• 获得工作流当前所再Steps。
• 获得工作流PropertySet。
• 生成transientVars。
• 从GlobalActions中和当前Steps的普通Actions中判断执行的Action是否试可执行的。
• 完成Action的Transition。

17.public void executeTriggerFunction(long id, int triggerId) throws WorkflowException

调用工作流的Trigger Function

18.public long initialize(String workflowName, int initialAction, Map inputs) throws InvalidRoleException, InvalidInputException, WorkflowException

初始化一个新的流程实例。返回流程实例id。

19.public List query(WorkflowQuery query)，public List query(WorkflowExpressionQuery query)

查询流程实例。

20.public boolean removeWorkflowDescriptor(String workflowName) throws FactoryException

删除已经配置的工作流定义。

21.public boolean saveWorkflowDescriptor(String workflowName, WorkflowDescriptor descriptor, boolean replace) throws FactoryException

保存工作流定义。

22.protected List getAvailableActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps) throws WorkflowException

获得指定步骤的可用Actions。

23.protected int[] getAvailableAutoActions(long id, Map inputs)

返回可执行的AutoActions。

24.protected List getAvailableAutoActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps) throws WorkflowException

返回指定Step中可执行的AutoActions。

25.protected WorkflowStore getPersistence() throws StoreException

返回配置的store。

26.protected void checkImplicitFinish(long id) throws WorkflowException

判断工作流是不是还有可执行的Action，如果没有，完成此工作流实例。

27.protected void completeEntry(long id, Collection currentSteps) throws StoreException

结束工作流实例，就是把改变流程实例的状态并把当前的Steps都放入到历史表中。 

28.protected boolean passesCondition(ConditionDescriptor conditionDesc, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException

29.protected boolean passesCondition(ConditionDescriptor conditionDesc, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException，protected boolean passesConditions(String conditionType, List conditions, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException

判断条件是不是符合。

30.protected void populateTransientMap(WorkflowEntry entry, Map transientVars, List registers, Integer actionId, Collection currentSteps) throws WorkflowException

产生临时变量transientVars，包含context，entry，store，descriptor，actionId，currentSteps，以及定义的register和用户的输入变量。

31.protected void verifyInputs(WorkflowEntry entry, List validators, Map transientVars, PropertySet ps) throws WorkflowException

验证用户的输入。

32.private boolean isActionAvailable(ActionDescriptor action, Map transientVars, PropertySet ps, int stepId) throws WorkflowException

判断Action是否可用。

33.private Step getCurrentStep(WorkflowDescriptor wfDesc, int actionId, List currentSteps, Map transientVars, PropertySet ps) throws WorkflowException

获得Action所在Step。

34.private boolean canInitialize(String workflowName, int initialAction, Map transientVars, PropertySet ps) throws WorkflowException

判断工作流是不是可以实例化。

35.private Step createNewCurrentStep(ResultDescriptor theResult, WorkflowEntry entry, WorkflowStore store, int actionId, Step currentStep, long[] previousIds, Map transientVars, PropertySet ps) throws WorkflowException

产生新的当前Step。

• 从resulte中获得nextStep，如果为-1，nextStep为当前Step。
• 获得定义中的owner，oldStatus，status。
• 完成当前Step，并且将当前Step保存到历史库中。
• 生成新的Step。

36.private void executeFunction(FunctionDescriptor function, Map transientVars, PropertySet ps) throws WorkflowException

执行Function。

37.private boolean transitionWorkflow(WorkflowEntry entry, List currentSteps, WorkflowStore store, WorkflowDescriptor wf, ActionDescriptor action, Map transientVars, Map inputs, PropertySet ps) throws WorkflowException

完成工作流的transation。

DefaultConfiguration是Configuration接口的默认实现，用于初始化系统的基本配置信息。

1.public WorkflowDescriptor getWorkflow(String name) throws FactoryException

根据工作流的定义名获得工作流的定义。

2.public WorkflowStore getWorkflowStore() throws StoreException

获得配置的持久化类Store。

3.public void load(URL url) throws FactoryException

装载配置信息。

• 得到配置文件流，并解析。
• 获得持久化信息，包括持久化类的路径和持久化类初始化参数。
• 获得工作流信息解析类路径，并初始化。

4. public WorkflowStore getWorkflowStore() throws StoreException

获得工作流初始化类。

XMLWorkflowFactory用于解析工作流定义xml文件，获得工作流信息。

1.public WorkflowDescriptor getWorkflow(String name) throws FactoryException

根据工作流定义名获得工作流定义。

2.public String[] getWorkflowNames()

得到所有已经定义的工作流名称。

3.public void initDone() throws FactoryException

初始化workflows.xml文件中列出的工作流定义文件信息。