openwferu 0.9.6 → 0.9.7

data/bin/validate-workflow.rb

@@ -10,6 +10,7 @@
 require 'net/http'
 require 'optparse'
 require 'uri'
+
 # From the gems archive
 require 'rubygems'
 require 'xml/libxml'

data/examples/openwferu.rb

@@ -0,0 +1,57 @@
+
+require 'rubygems'
+require 'openwfe/def'
+require 'openwfe/workitem'
+require 'openwfe/engine/engine'
+
+#
+# instantiating an engine
+
+engine = OpenWFE::Engine.new
+
+#
+# adding some participants
+
+engine.register_participant :alice do |workitem|
+    puts "alice got a workitem..."
+    workitem.alice_comment = "this thing looks interesting"
+end
+
+engine.register_participant :bob do |workitem|
+    puts "bob got a workitem..."
+    workitem.bob_comment = "not for me, I prefer VB"
+    workitem.bob_comment2 = "Bob rules"
+end
+
+engine.register_participant :summarize do |workitem|
+    puts 
+    puts "summary of process #{workitem.fei.workflow_instance_id}"
+    workitem.attributes.each do |k, v|
+        next unless k.match ".*_comment$"
+        puts " - #{k} : '#{v}'"
+    end
+end
+
+#
+# a process definition
+
+class TheProcessDefinition0 < OpenWFE::ProcessDefinition
+    def make
+        sequence do
+            concurrence do
+                participant :alice
+                participant :bob
+            end
+            participant :summarize
+        end
+    end
+end
+
+#
+# launching the process
+
+li = OpenWFE::LaunchItem.new(TheProcessDefinition0)
+
+li.initial_comment = "please give your impressions about http://ruby-lang.org"
+
+engine.launch(li)

data/lib/openwfe/contextual.rb

@@ -50,6 +50,8 @@ module OpenWFE
 
         attr_accessor :application_context
 
+        alias :ac :application_context
+
         #
         # Looks up something in the application context, if the given
         # key is a class, then the first value in the context of that

data/lib/openwfe/engine/engine.rb

@@ -47,6 +47,7 @@ require 'openwfe/rudefinitions'
 require 'openwfe/service'
 require 'openwfe/util/scheduler'
 require 'openwfe/util/schedulers'
+require 'openwfe/expool/wfidgen'
 require 'openwfe/expool/expressionpool'
 require 'openwfe/expool/expstorage'
 require 'openwfe/expressions/expressionmap'
@@ -82,20 +83,41 @@ module OpenWFE
 
             build_expression_map()
 
+            build_wfid_generator()
             build_expression_pool()
             build_expression_storage()
 
             build_participant_map()
 
-            #
-            # engine components are ready for operation, it's time to 
-            # check persisted expressions (if any) to see if something
-            # has to be rescheduled (like a long time sleep expression or
-            # a cron)
+            #get_expression_pool.reschedule()
+
+            linfo { "new() --- engine started --- #{self.object_id}" }
+        end
 
+        #
+        # Call this method once the participant for a persisted engine
+        # have been [re]added.
+        # If you call this method too soon, missing participants will 
+        # cause troubles... Call this method after all the participants
+        # have been added.
+        #
+        def reschedule
             get_expression_pool.reschedule()
+        end
 
-            linfo { "new() --- engine started --- #{self.object_id}" }
+        alias :reload :reschedule
+
+        #
+        # When 'parameters' are used at the top of a process definition, this
+        # method can be used to assert a launchitem before launch.
+        # An expression will get raised if the parameters do not match the
+        # requirements.
+        #
+        # Note that the launch method will raise those exceptions as well.
+        # This method can be useful in some scenarii though.
+        #
+        def pre_launch_check (launchitem)
+            get_expression_pool.prepare_raw_expression(launchitem)
         end
 
         #
@@ -137,16 +159,6 @@ module OpenWFE
             get_expression_pool.launch(launchitem, async)
         end
 
-        #
-        # Returns the list of applied expressions belonging to a given
-        # workflow instance.
-        # May be used to determine where a process instance currently is.
-        #
-        def get_flow_position (workflow_instance_id)
-
-            get_expression_pool.get_flow_position(workflow_instance_id)
-        end
-
         #
         # This method is used to feed a workitem back to the engine (after
         # it got sent to a worklist or wherever by a participant).
@@ -282,8 +294,11 @@ module OpenWFE
             linfo { "stop() stopping engine '#{@service_name}'" }
 
             @application_context.each do |name, service|
+
                 next if name == self.service_name
+
                 #service.stop if service.respond_to? :stop
+
                 if service.kind_of? ServiceMixin
                     service.stop
                     linfo do 
@@ -294,6 +309,67 @@ module OpenWFE
             end
         end
 
+        #
+        # METHODS FROM THE EXPRESSION POOL
+        #
+        # These methods are 'proxy' to method found in the expression pool.
+        # They are made available here for a simpler model.
+        #
+
+        #
+        # Returns the list of applied expressions belonging to a given
+        # workflow instance.
+        # May be used to determine where a process instance currently is.
+        #
+        def get_flow_position (workflow_instance_id)
+            get_expression_pool.get_flow_position(workflow_instance_id)
+        end
+        alias :get_process_position :get_flow_position
+
+        #
+        # Lists all workflows (processes) currently in the expool (in
+        # the engine).
+        # This method will return a list of "process-definition" expressions
+        # (root of flows).
+        #
+        # If consider_subprocesses is set to true, "process-definition" 
+        # expressions of subprocesses will be returned as well.
+        #
+        # "wfid_prefix" allows your to query for specific workflow instance
+        # id prefixes.
+        #
+        def list_workflows (consider_subprocesses=false, wfid_prefix=nil)
+
+            get_expression_pool.list_workflows(
+                consider_subprocesses, wfid_prefix)
+        end
+        alias :list_processes :list_workflows
+
+        #
+        # Given any expression of a process, cancels the complete process
+        # instance.
+        #
+        def cancel_flow (exp_or_wfid)
+            get_expression_pool.cancel_flow(exp_or_wfid)
+        end
+        alias :cancel_process :cancel_flow
+
+        #
+        # Cancels the given expression (and its children if any)
+        # (warning : advanced method)
+        #
+        def cancel_expression (exp_or_fei)
+            get_expression_pool.cancel(exp_or_fei)
+        end
+
+        #
+        # Forgets the given expression (make it an orphan)
+        # (warning : advanced method)
+        #
+        def forget_expression (exp_or_fei)
+            get_expression_pool.forget(exp_or_fei)
+        end
+
         protected
 
             #
@@ -303,7 +379,23 @@ module OpenWFE
 
             def build_expression_map ()
 
-                init_service(S_EXPRESSION_MAP, ExpressionMap)
+                @application_context[S_EXPRESSION_MAP] = ExpressionMap.new
+                    #
+                    # the expression map is not a Service anymore,
+                    # it's a simple instance (that will be reused in other
+                    # OpenWFEru components)
+
+                #ldebug do 
+                #    "build_expression_map() :\n" +
+                #    get_expression_map.to_s
+                #end
+            end
+
+            def build_wfid_generator ()
+
+                #init_service(S_WFID_GENERATOR, DefaultWfidGenerator)
+                #init_service(S_WFID_GENERATOR, UuidWfidGenerator)
+                init_service(S_WFID_GENERATOR, KotobaWfidGenerator)
             end
 
             def build_expression_pool ()

data/lib/openwfe/engine/file_persisted_engine.rb

@@ -47,7 +47,12 @@ require 'openwfe/expool/yamlexpstorage'
 module OpenWFE
 
     #
-    # An engine persisted to a tree of yaml files
+    # An engine persisted to a tree of yaml files.
+    #
+    # Remember that once you have added the participants to a persisted
+    # engine, you should call its reload method, to reschedule expressions
+    # like 'sleep', 'cron', ... But if you do it before registering the
+    # participants you'll end up with broken processes.
     #
     class FilePersistedEngine < Engine
 
@@ -68,6 +73,11 @@ module OpenWFE
     #
     # An engine with a cache in front of its file persisted expression storage.
     #
+    # Remember that once you have added the participants to a persisted
+    # engine, you should call its reload method, to reschedule expressions
+    # like 'sleep', 'cron', ... But if you do it before registering the
+    # participants you'll end up with broken processes.
+    #
     class CachedFilePersistedEngine < Engine
 
         protected

data/lib/openwfe/exceptions.rb

@@ -0,0 +1,53 @@
+#
+#--
+# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without 
+# modification, are permitted provided that the following conditions are met:
+# 
+# . Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.  
+# 
+# . Redistributions in binary form must reproduce the above copyright notice, 
+#   this list of conditions and the following disclaimer in the documentation 
+#   and/or other materials provided with the distribution.
+# 
+# . Neither the name of the "OpenWFE" nor the names of its contributors may be
+#   used to endorse or promote products derived from this software without
+#   specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#++
+#
+# $Id: workitem.rb 3555 2006-11-13 00:47:53Z jmettraux $
+#
+
+#
+# Made in Japan
+#
+# john.mettraux@openwfe.org
+#
+
+
+module OpenWFE
+
+    #
+    # The exception thrown at launch time, when there are parameter missing
+    # or whose value isn't matching what is required.
+    #
+    class ParameterException < Exception
+    end
+
+end
+