osworkflow descriptor 解析片断

Osworkflow定义工作流是通过一个xml文件来完成的，你可以把它取成任何你想要的名字。大致框架如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE workflow PUBLIC

  "-//OpenSymphony Group//DTD OSWorkflow 2.7//EN"

  "http://www.opensymphony.com/osworkflow/workflow_2_7.dtd">

<workflow>

  <initial-actions>

    ...

  </initial-actions>

  <steps>

    ...

  </steps>

</workflow>

都是按照标准xml指定。通过指定的dtd来校验xml文件。一般需要辅助工具如xmlspy来自动校验xml文件里的错误，这样会方便大家检测xml文件中的错误。

Step和actions

理解这个xml文件的第一个重点在于理解step和actions的在工作流系统中的概念。一个step就是这样的一个概念：一个工作流中所处的不同位置。如在一个文档管理系统中。可以是起草、编辑阶段、发布等等。

Actions指定不同step中的变迁。还是用例子来理解更为形象一些。在一个文档管理系统当中如在“第一个起草”中的“开始第一个起草”和“结束第一个起草”就是actions。

Initial actions 是一个action的特殊类型。在工作流开始时候，是没有状态的，也没有任何step。用户必须利用某个action来开始流程，这个用来开始工作流的action就被指定为initial-actions。

例如，我们假定我们只有一个initial-action，非常简单，如下面：

<action id="1" name="Start Workflow">

  <results>

    <unconditional-result old-status="Finished" status="Queued" step="1"/>

  </results>

</action>

这个action是个action的最简单的例子。他只是简单定义我们需要走想的step。

工作流status

Status用来描述特定step中的一个工作流的状态。如在文档管理系统当中，我们的“第一次起草”step可以有两个statuses，“underway”和“queued”

用“queued”来指示此条已经在“first draft”中排队。没有安排谁来处理此文档，但是已经发出请求。而“underway”是指示一个作者已经从队列中取出此文档并且或许已经上锁。表明正在first draft上工作。

Step实例：在这个例子中有两个actions。第一个action（开始第一个起草）是在一个step中进行。但是，更改状态为underway，第二个action是工作流流转到下一个step，我们假定下一个工作流step为“finish”。

<step id="1" name="First Draft">

  <actions>

    <action id="1" name="Start First Draft">

      <results>

        <unconditional-result old-status="Finished" status="Underway" step="1"/>

      </results>

    </action>

    <action id="2" name="Finish First Draft">

      <results>

        <unconditional-result old-status="Finished" status="Queued" step="2"/>

      </results>

    </action>

  </actions>

</step>

<step id="2" name="finished" />

Old-status这个属性用来指示对于当前state（结束）将要进入哪个history table。在绝大多数情况下，被写为“finished”。

Conditions

Osworkflow有一些内建的conditon。请参看javadocs，如果需要一个特定的condition。Condition可以接收参数。如本例就接收了一个参数“status”用来指定status

<action id="1" name="Start First Draft">

  <restrict-to>

    <conditions>

      <condition type="class">

        <arg name="class.name">

          com.opensymphony.workflow.util.StatusCondition

        </arg>

        <arg name="status">Queued</arg>

      </condition>

    </conditions>

  </restrict-to>

  <results>

    <unconditional-result old-status="Finished" status="Underway" step="1"/>

  </results>

</action>

这样就能保证在initial action被调用后才可以正确执行。因为它需要确信当前status是“queued”。

Functions

接下来，如果我们希望指定一个用户开始first draft，他们变为“owner”为了达到这样的目的，我们需要这样做：

1、在当前context中防止一个“caller”变量

2、  设置result的“owner”属性为call变量。

function是osworkflow的一个非常强大的特征，一个function基本上是一个系列在工作流变迁之间执行的工作，并不影响工作流本身。例如，你能够有个sendmail功能，它的职责就是当一个特定的变迁发生后发送邮件通知。

Functions能够给当前context添加变量。可以在其他functions或者scripts中使用。

Osworkflow 有自己内建function。其中一个比较有用的就是“caller”。这个function的作用就是通过查找当前的能够调用工作流的用户，把该用户以字符串形式命名为caller变量的值。

<action id="1" name="Start First Draft">

  <pre-functions>

    <function type="class">

      <arg name="class.name">com.opensymphony.workflow.util.Caller</arg>

    </function>

  </pre-functions>

  <results>

    <unconditional-result old-status="Finished" status="Underway"

                                       step="1" owner="${caller}"/>

  </results>

</action>

整合后的结果：

<action id="1" name="Start First Draft">

  <restrict-to>

    <conditions>

      <condition type="class">

        <arg name="class.name">

                com.opensymphony.workflow.util.StatusCondition

        </arg>

        <arg name="status">Queued</arg>

      </condition>

    </conditions>

  </restrict-to>

  <pre-functions>

    <function type="class">

      <arg name="class.name">

              com.opensymphony.workflow.util.Caller

      </arg>

    </function>

  </pre-functions>

  <results>

    <unconditional-result old-status="Finished" status="Underway"

                                       step="1"  owner="${caller}"/>

  </results>

</action>

<action id="2" name="Finish First Draft">

  <restrict-to>

    <conditions type="AND">

      <condition type="class">

        <arg

        name="class.name">com.opensymphony.workflow.util.StatusCondition

        </arg>

        <arg name="status">Underway</arg>

      </condition>

      <condition type="class">

        <arg name="class.name">

              com.opensymphony.workflow.util.AllowOwnerOnlyCondition

       </arg>

      </condition>

    </conditions>

  </restrict-to>

  <results>

    <unconditional-result old-status="Finished" status="Queued" step="2"/>

  </results>

</action>

如果我们想要确保仅仅当用户开始first draft才能完成它（我们在以前的result的owner属性中指定）。Status condition同样确保“finish first draft” action只能在状态为“underway”的情况下才可以被执行。这就确保必须得有一个用户已经开始第一个起草工作。

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE workflow PUBLIC

                 "-//OpenSymphony Group//DTD OSWorkflow 2.7//EN"

                 "http://www.opensymphony.com/osworkflow/workflow_2_7.dtd">

<workflow>

  <initial-actions>

    <action id="1" name="Start Workflow">

      <results>

        <unconditional-result old-status="Finished" status="Queued" step="1"/>

      </results>

    </action>

  </initial-actions>

  <steps>

    <step id="1" name="First Draft">

      <actions>

        <action id="1" name="Start First Draft">

          <restrict-to>

            <conditions>

              <condition type="class">

                <arg name="class.name">

                   com.opensymphony.workflow.util.StatusCondition

                </arg>

                <arg name="status">Queued</arg>

              </condition>

            </conditions>

          </restrict-to>

          <pre-functions>

            <function type="class">

              <arg name="class.name">

                 com.opensymphony.workflow.util.Caller

              </arg>

            </function>

          </pre-functions>

          <results>

            <unconditional-result old-status="Finished" status="Underway"

                                           step="1"  owner="${caller}"/>

          </results>

        </action>

        <action id="2" name="Finish First Draft">

          <restrict-to>

            <conditions type="AND">

              <condition type="class">

                <arg name="class.name">

                    com.opensymphony.workflow.util.StatusCondition

                </arg>

                <arg name="status">Underway</arg>

              </condition>

              <condition type="class">

                <arg name="class.name">

                  com.opensymphony.workflow.util.AllowOwnerOnlyCondition

                </arg>

              </condition>

            </conditions>

          </restrict-to>

          <results>

            <unconditional-result old-status="Finished" status="Queued" step="2"/>

          </results>

        </action>

      </actions>

    </step>

    <step id="2" name="finished" />

  </steps>

</workflow>

创建osworkflow.xml，例子如下：

<osworkflow>

  <persistence class="com.opensymphony.workflow.spi.memory.MemoryWorkflowStore"/>

  <factory class="com.opensymphony.workflow.loader.XMLWorkflowFactory">

    <property name="resource" value="workflows.xml" />

  </factory>

</osworkflow>

指定使用内存数据库。即非永久保存性质。用做测试目的，这样做足够了。

Factory概念

上面的xml 文件同时指定了xml workflowfactory。Workflow factory是用来管理workflowworkflow描述符。Xml workflow factory有一个特定属性叫做“resource”它用来指定在哪里可以找到xml文件，这个resource必须从classpath中加载，所以对于上面的例子，你将要创建一个文件名为workflows.xml的文件追加到classpath中。文件样本如下；

<workflows>

  <workflow name="mytest" type="resource" location="myworkflow.xml"/>

</workflows>

所以，你还需要一个myworkflow.xml，

到此，我们完成了配置，首先初始化然后调用我们的workflow。

Initializing osworkflow：

Osworkflow有一个相对简单的的调用模式，有一个main入口，这个main入口点是workflow的接口，经常是作为实现AbstractWorkflow的子类。

首先，我们创建我们自己的工作流。这个对象应该存储在一个通用区域，并且能够被重复使用。这样做的一个办法就是做一个static。BasicWorkflow的构造器参数是一个当前调用者的。

需要初始化和配置工作流的session，

Workflow workflow = new BasicWorkflow("testuser");

DefaultConfiguration config = new DefaultConfiguration();

workflow.setConfiguration(config);

调用初始化方法：

long workflowId = workflow.initialize("mytest", 1, null);

参数含义：工作流名字，action的id，action。

校验工作流：

现在我们完成初始化工作流实例，我们期待着他的表现是我们所期待那样的。

Collection currentSteps = workflow.getCurrentSteps(workflowId);

//verify we only have one current step

assertEquals("Unexpected number of current steps", 1, currentSteps.size());

//verify it's step 1

Step currentStep = (Step)currentSteps.iterator().next();

assertEquals("Unexpected current step", 1, currentStep.getStepId());

int[] availableActions = workflow.getAvailableActions(workflowId);

//verify we only have one available action

assertEquals("Unexpected number of available actions", 1, availableActions.length);

//verify it's action 1

assertEquals("Unexpected available action", 1, availableActions[0]);

调用action

workflow.doAction(workflowId, 1, null);