ruote 0.9.18 → 0.9.19
Sign up to get free protection for your applications and to get access to all the features.
- data/README.txt +2 -0
- data/examples/about_state.rb +29 -29
- data/examples/bigflow.rb +9 -9
- data/examples/csv_weather.rb +4 -4
- data/examples/engine_template.rb +141 -129
- data/examples/flowtracing.rb +8 -8
- data/examples/homeworkreview.rb +15 -15
- data/examples/kotoba.rb +9 -9
- data/examples/mano_tracker.rb +63 -63
- data/examples/openwferu.rb +22 -20
- data/examples/quotereporter.rb +79 -79
- data/lib/openwfe/contextual.rb +72 -72
- data/lib/openwfe/def.rb +21 -21
- data/lib/openwfe/engine.rb +19 -19
- data/lib/openwfe/engine/engine.rb +578 -614
- data/lib/openwfe/engine/expool_methods.rb +144 -115
- data/lib/openwfe/engine/file_persisted_engine.rb +77 -77
- data/lib/openwfe/engine/participant_methods.rb +96 -96
- data/lib/openwfe/engine/status_methods.rb +271 -247
- data/lib/openwfe/engine/update_exp_methods.rb +69 -69
- data/lib/openwfe/exceptions.rb +25 -25
- data/lib/openwfe/expool/errorjournal.rb +334 -348
- data/lib/openwfe/expool/expool_pause_methods.rb +98 -0
- data/lib/openwfe/expool/expressionpool.rb +793 -800
- data/lib/openwfe/expool/expstorage.rb +284 -313
- data/lib/openwfe/expool/history.rb +193 -105
- data/lib/openwfe/expool/journal.rb +163 -163
- data/lib/openwfe/expool/journal_replay.rb +228 -228
- data/lib/openwfe/expool/parser.rb +178 -142
- data/lib/openwfe/{orest/exception.rb → expool/paused_error.rb} +49 -32
- data/lib/openwfe/expool/representation.rb +59 -59
- data/lib/openwfe/expool/threadedexpstorage.rb +137 -134
- data/lib/openwfe/expool/wfidgen.rb +289 -287
- data/lib/openwfe/expool/yamlexpstorage.rb +154 -154
- data/lib/openwfe/expressions/condition.rb +175 -168
- data/lib/openwfe/expressions/environment.rb +165 -165
- data/lib/openwfe/expressions/expressionmap.rb +135 -131
- data/lib/openwfe/expressions/fe_cancel.rb +68 -68
- data/lib/openwfe/expressions/fe_command.rb +190 -190
- data/lib/openwfe/expressions/fe_concurrence.rb +531 -531
- data/lib/openwfe/expressions/fe_cron.rb +152 -197
- data/lib/openwfe/expressions/fe_cursor.rb +152 -186
- data/lib/openwfe/expressions/fe_define.rb +118 -118
- data/lib/openwfe/expressions/fe_do.rb +109 -109
- data/lib/openwfe/expressions/fe_equals.rb +219 -219
- data/lib/openwfe/expressions/fe_filter.rb +98 -98
- data/lib/openwfe/expressions/fe_filter_definition.rb +122 -122
- data/lib/openwfe/expressions/fe_fqv.rb +203 -203
- data/lib/openwfe/expressions/fe_http.rb +212 -0
- data/lib/openwfe/expressions/fe_if.rb +214 -214
- data/lib/openwfe/expressions/fe_iterator.rb +91 -91
- data/lib/openwfe/expressions/fe_listen.rb +268 -268
- data/lib/openwfe/expressions/fe_losfor.rb +73 -73
- data/lib/openwfe/expressions/fe_misc.rb +343 -351
- data/lib/openwfe/expressions/fe_participant.rb +206 -206
- data/lib/openwfe/expressions/fe_reserve.rb +153 -142
- data/lib/openwfe/expressions/fe_save.rb +226 -226
- data/lib/openwfe/expressions/fe_sequence.rb +66 -56
- data/lib/openwfe/expressions/fe_set.rb +80 -80
- data/lib/openwfe/expressions/fe_sleep.rb +132 -125
- data/lib/openwfe/expressions/fe_step.rb +113 -111
- data/lib/openwfe/expressions/fe_subprocess.rb +139 -136
- data/lib/openwfe/expressions/fe_timeout.rb +74 -78
- data/lib/openwfe/expressions/fe_wait.rb +48 -49
- data/lib/openwfe/expressions/fe_when.rb +106 -106
- data/lib/openwfe/expressions/filter.rb +60 -60
- data/lib/openwfe/expressions/flowexpression.rb +618 -612
- data/lib/openwfe/expressions/iterator.rb +158 -158
- data/lib/openwfe/expressions/merge.rb +53 -53
- data/lib/openwfe/expressions/raw.rb +396 -397
- data/lib/openwfe/expressions/rprocdef.rb +261 -266
- data/lib/openwfe/expressions/time.rb +238 -243
- data/lib/openwfe/expressions/timeout.rb +135 -135
- data/lib/openwfe/expressions/value.rb +55 -55
- data/lib/openwfe/extras/engine/db_persisted_engine.rb +94 -0
- data/lib/openwfe/extras/expool/dberrorjournal.rb +189 -0
- data/lib/openwfe/extras/expool/dbexpstorage.rb +355 -0
- data/lib/openwfe/extras/expool/dbhistory.rb +135 -0
- data/lib/openwfe/extras/listeners/sqslisteners.rb +146 -0
- data/lib/openwfe/extras/misc/activityfeed.rb +264 -0
- data/lib/openwfe/extras/misc/basecamp.rb +485 -0
- data/lib/openwfe/extras/participants/activeparticipants.rb +749 -0
- data/lib/openwfe/extras/participants/atomfeed_participants.rb +173 -0
- data/lib/openwfe/extras/participants/atompub_participants.rb +267 -0
- data/lib/openwfe/extras/participants/basecamp_participants.rb +87 -0
- data/lib/openwfe/extras/participants/csvparticipants.rb +127 -0
- data/lib/openwfe/extras/participants/sqsparticipants.rb +125 -0
- data/lib/openwfe/extras/participants/twitterparticipants.rb +176 -0
- data/lib/openwfe/filterdef.rb +191 -191
- data/lib/openwfe/flowexpressionid.rb +271 -269
- data/lib/openwfe/listeners/listener.rb +61 -61
- data/lib/openwfe/listeners/listeners.rb +81 -81
- data/lib/openwfe/listeners/socketlisteners.rb +189 -189
- data/lib/openwfe/logging.rb +74 -74
- data/lib/openwfe/omixins.rb +55 -54
- data/lib/openwfe/orest/definitions.rb +90 -90
- data/lib/openwfe/orest/osocket.rb +91 -91
- data/lib/openwfe/orest/xmlcodec.rb +471 -459
- data/lib/openwfe/participants.rb +19 -19
- data/lib/openwfe/participants/enoparticipants.rb +187 -187
- data/lib/openwfe/participants/participant.rb +100 -100
- data/lib/openwfe/participants/participantmap.rb +170 -170
- data/lib/openwfe/participants/participants.rb +316 -316
- data/lib/openwfe/participants/soapparticipants.rb +90 -90
- data/lib/openwfe/participants/socketparticipants.rb +143 -143
- data/lib/openwfe/participants/storeparticipants.rb +198 -198
- data/lib/openwfe/rexml.rb +44 -0
- data/lib/openwfe/rudefinitions.rb +87 -91
- data/lib/openwfe/service.rb +65 -65
- data/lib/openwfe/storage/yamlcustom.rb +71 -71
- data/lib/openwfe/storage/yamlfilestorage.rb +190 -190
- data/lib/openwfe/tools/flowtracer.rb +41 -45
- data/lib/openwfe/util/dollar.rb +125 -139
- data/lib/openwfe/util/irb.rb +42 -42
- data/lib/openwfe/util/observable.rb +93 -99
- data/lib/openwfe/util/ometa.rb +36 -36
- data/lib/openwfe/util/treechecker.rb +122 -0
- data/lib/openwfe/util/workqueue.rb +73 -73
- data/lib/openwfe/util/xml.rb +285 -279
- data/lib/openwfe/utils.rb +415 -442
- data/lib/openwfe/version.rb +1 -1
- data/lib/openwfe/workitem.rb +444 -437
- data/lib/openwfe/worklist/oldrest.rb +161 -161
- data/lib/openwfe/worklist/storelocks.rb +218 -218
- data/lib/openwfe/worklist/storeparticipant.rb +19 -19
- data/lib/openwfe/worklist/worklist.rb +223 -223
- data/test/back_0916_test.rb +57 -59
- data/test/bm/bm_1_xml_vs_prog.rb +25 -22
- data/test/bm/bm_2_step.rb +81 -81
- data/test/bm/ft_0f_5ms.rb +13 -13
- data/test/bm/ft_26_load.rb +177 -179
- data/test/bm/ft_26b_load.rb +57 -59
- data/test/bm/ft_26c_load.rb +70 -65
- data/test/bm/ft_recu.rb +51 -51
- data/test/clone_test.rb +145 -99
- data/test/concurrence_test.rb +41 -41
- data/test/condition_test.rb +104 -90
- data/test/description_test.rb +46 -45
- data/test/eno_test.rb +36 -36
- data/test/expmap_test.rb +26 -26
- data/test/extras/README.txt +5 -0
- data/test/extras/active_connection.rb +48 -0
- data/test/extras/active_with_engine_test.rb +140 -0
- data/test/extras/activityfeed_test.rb +85 -0
- data/test/extras/ap_0_test.rb +287 -0
- data/test/extras/ap_1_test.rb +53 -0
- data/test/extras/ap_test_base.rb +24 -0
- data/test/extras/atomfeedp_test.rb +113 -0
- data/test/extras/atompubp_test.rb +91 -0
- data/test/extras/basecamp_test.rb +53 -0
- data/test/extras/db_errorjournal_utest.rb +75 -0
- data/test/extras/db_expstorage_utest.rb +171 -0
- data/test/extras/db_history_0_test.rb +58 -0
- data/test/extras/ft_19_csv.rb +58 -0
- data/test/extras/ft_71_b14008.rb +85 -0
- data/test/extras/sqs_test.rb +57 -0
- data/test/extras/twitter_test.rb +62 -0
- data/test/fe_lookup_att_test.rb +41 -41
- data/test/fei_test.rb +131 -131
- data/test/file_persisted_engine_test.rb +30 -30
- data/test/file_persistence_test.rb +112 -111
- data/test/filep_cancel_test.rb +58 -58
- data/test/filter_test.rb +67 -67
- data/test/flowtestbase.rb +207 -219
- data/test/ft_0.rb +35 -35
- data/test/ft_0b_sequence.rb +15 -15
- data/test/ft_0c_testname.rb +12 -12
- data/test/ft_0d_participant.rb +9 -9
- data/test/ft_0e_multibody.rb +11 -11
- data/test/ft_10_loop.rb +103 -104
- data/test/ft_11_ppd.rb +285 -289
- data/test/ft_11b_ppd.rb +26 -26
- data/test/ft_12_blockparticipant.rb +57 -57
- data/test/ft_13_eno.rb +31 -31
- data/test/ft_14_subprocess.rb +45 -45
- data/test/ft_14b_subprocess.rb +107 -107
- data/test/ft_14c_subprocess.rb +33 -33
- data/test/ft_15_iterator.rb +127 -127
- data/test/ft_15b_iterator.rb +41 -41
- data/test/ft_16_fqv.rb +44 -44
- data/test/ft_17_condition.rb +48 -48
- data/test/ft_18_pname.rb +26 -26
- data/test/ft_1_unset.rb +140 -140
- data/test/ft_1b_unset.rb +17 -17
- data/test/ft_20_cron.rb +33 -33
- data/test/ft_21_cron.rb +51 -51
- data/test/ft_21b_cron_pause.rb +41 -41
- data/test/ft_22_history.rb +45 -41
- data/test/ft_23_when.rb +51 -51
- data/test/ft_23b_when.rb +43 -43
- data/test/ft_23c_wait.rb +48 -48
- data/test/ft_23d_cww.rb +28 -28
- data/test/ft_24_def.rb +15 -15
- data/test/ft_25_cancel.rb +57 -54
- data/test/ft_27_getflowpos.rb +79 -83
- data/test/ft_28_fileparticipant.rb +25 -25
- data/test/ft_29_httprb.rb +57 -57
- data/test/ft_2_concurrence.rb +99 -97
- data/test/ft_2b_concurrence.rb +132 -132
- data/test/ft_2c_concurrence.rb +37 -37
- data/test/ft_30_socketlistener.rb +133 -133
- data/test/ft_31_flowname.rb +15 -16
- data/test/ft_32_journal.rb +48 -48
- data/test/ft_32c_journal.rb +54 -54
- data/test/ft_32d_journal.rb +43 -46
- data/test/ft_33_description.rb +62 -62
- data/test/ft_34_cancelwfid.rb +37 -37
- data/test/ft_35_localdefs.rb +36 -34
- data/test/ft_36_subprocids.rb +61 -61
- data/test/ft_37_pnames.rb +33 -33
- data/test/ft_38_tag.rb +82 -82
- data/test/ft_38b_tag.rb +97 -97
- data/test/ft_38c_tag.rb +50 -50
- data/test/ft_38d_tag.rb +53 -0
- data/test/ft_39_reserve.rb +33 -33
- data/test/ft_39b_reserve.rb +59 -59
- data/test/ft_3_equals.rb +131 -131
- data/test/ft_3b_lookup_vf.rb +43 -43
- data/test/ft_40_defined.rb +33 -33
- data/test/ft_41_case.rb +80 -80
- data/test/ft_42_environments.rb +48 -48
- data/test/ft_43_pat10.rb +51 -51
- data/test/ft_44_save.rb +37 -37
- data/test/ft_44b_restore.rb +151 -151
- data/test/ft_45_citerator.rb +149 -149
- data/test/ft_45b_citerator.rb +77 -0
- data/test/ft_46_pparams.rb +27 -27
- data/test/ft_47_filter.rb +100 -100
- data/test/ft_48_fe_filter.rb +41 -41
- data/test/ft_49_condition.rb +101 -94
- data/test/ft_4_misc.rb +185 -190
- data/test/ft_50_xml_attribute.rb +101 -104
- data/test/ft_51_stack.rb +30 -30
- data/test/ft_52_obs_participant.rb +73 -73
- data/test/ft_53_null_noop_participant.rb +31 -31
- data/test/ft_54_listen.rb +183 -183
- data/test/ft_54b_listen.rb +32 -32
- data/test/ft_54c_listen.rb +60 -60
- data/test/ft_55_ptimeout.rb +29 -30
- data/test/ft_56_timeout.rb +29 -29
- data/test/ft_57_a.rb +105 -102
- data/test/ft_58_ejournal.rb +83 -80
- data/test/ft_58b_ejournal.rb +82 -0
- data/test/ft_59_ps.rb +148 -86
- data/test/ft_5_time.rb +77 -77
- data/test/ft_60_ecancel.rb +98 -98
- data/test/ft_61_elsub.rb +23 -23
- data/test/ft_62_procparticipant.rb +46 -46
- data/test/ft_63_pause.rb +82 -69
- data/test/ft_64_alias.rb +56 -57
- data/test/ft_65_stringlaunch.rb +29 -29
- data/test/ft_66_subforget.rb +42 -42
- data/test/ft_67_schedlaunch.rb +58 -59
- data/test/ft_68_ifparticipant.rb +39 -39
- data/test/ft_69_cancelmissing.rb +23 -21
- data/test/ft_6_lambda.rb +37 -37
- data/test/ft_70_lookupvar.rb +25 -25
- data/test/ft_71_log.rb +35 -35
- data/test/ft_72_lookup_processes.rb +43 -40
- data/test/ft_73_cancel_sub.rb +79 -79
- data/test/ft_74_block_and_workitem_dup.rb +42 -42
- data/test/ft_75_ruby_attributes.rb +53 -51
- data/test/ft_76_merge_isolate.rb +57 -57
- data/test/ft_77_segments.rb +13 -13
- data/test/ft_78_eval.rb +94 -94
- data/test/ft_79_tticket.rb +79 -79
- data/test/ft_79b_tticket.rb +73 -73
- data/test/ft_79c_outcome.rb +36 -36
- data/test/ft_7_lose.rb +73 -73
- data/test/ft_7b_lose.rb +49 -49
- data/test/ft_80_spname.rb +65 -65
- data/test/ft_81_exp.rb +30 -30
- data/test/ft_82_trecu.rb +30 -24
- data/test/ft_83_badpause.rb +35 -35
- data/test/ft_84_updateexp.rb +118 -118
- data/test/ft_84b_subrepr.rb +72 -0
- data/test/ft_85_dolhash.rb +18 -18
- data/test/ft_86_dollar_fv.rb +33 -33
- data/test/ft_87_define.rb +47 -47
- data/test/ft_88_http.rb +100 -0
- data/test/ft_8_forget.rb +25 -25
- data/test/ft_9_cursor.rb +119 -110
- data/test/ft_9b_cursor.rb +70 -70
- data/test/ft_tests.rb +6 -0
- data/test/hash_test.rb +52 -34
- data/test/hparticipant_test.rb +92 -88
- data/test/lookup_att_test.rb +70 -70
- data/test/lookup_vf_test.rb +52 -52
- data/test/misc_test.rb +55 -51
- data/test/obs_test.rb +82 -82
- data/test/param_test.rb +181 -181
- data/test/participant_test.rb +46 -46
- data/test/pending.rb +12 -12
- data/test/ps_representation.rb +70 -70
- data/test/rake_ltest.rb +2 -2
- data/test/rake_qtest.rb +11 -11
- data/test/raw_prog_test.rb +303 -308
- data/test/restart_cron_test.rb +74 -74
- data/test/restart_paused_test.rb +52 -47
- data/test/restart_sleep_test.rb +80 -80
- data/test/restart_when_test.rb +64 -64
- data/test/ruby_procdef_test.rb +71 -71
- data/test/rutest_utils.rb +32 -32
- data/test/sec_test.rb +143 -142
- data/test/slock_test.rb +41 -41
- data/test/storage_test.rb +15 -15
- data/test/timeout_test.rb +53 -53
- data/test/treechecker_test.rb +111 -0
- data/test/util_xml_test.rb +57 -57
- data/test/wfid_test.rb +93 -93
- data/test/wi_test.rb +58 -58
- metadata +64 -19
- data/examples/scheduler_cron_usage.rb +0 -48
- data/examples/scheduler_usage.rb +0 -56
- data/lib/openwfe/orest/controlclient.rb +0 -119
- data/lib/openwfe/orest/oldrestservlet.rb +0 -279
- data/lib/openwfe/orest/restclient.rb +0 -176
- data/lib/openwfe/orest/workitem.rb +0 -206
- data/lib/openwfe/orest/worklistclient.rb +0 -272
- data/test/bm/ft_26d_load.rb +0 -97
- data/test/ft_59b_ps_for_pat.rb +0 -58
- data/test/ft_64_clone.rb +0 -69
- data/test/orest_test.rb +0 -251
data/lib/openwfe/version.rb
CHANGED
data/lib/openwfe/workitem.rb
CHANGED
@@ -2,31 +2,31 @@
|
|
2
2
|
#--
|
3
3
|
# Copyright (c) 2005-2008, John Mettraux, OpenWFE.org
|
4
4
|
# All rights reserved.
|
5
|
-
#
|
6
|
-
# Redistribution and use in source and binary forms, with or without
|
5
|
+
#
|
6
|
+
# Redistribution and use in source and binary forms, with or without
|
7
7
|
# modification, are permitted provided that the following conditions are met:
|
8
|
-
#
|
8
|
+
#
|
9
9
|
# . Redistributions of source code must retain the above copyright notice, this
|
10
|
-
# list of conditions and the following disclaimer.
|
11
|
-
#
|
12
|
-
# . Redistributions in binary form must reproduce the above copyright notice,
|
13
|
-
# this list of conditions and the following disclaimer in the documentation
|
10
|
+
# list of conditions and the following disclaimer.
|
11
|
+
#
|
12
|
+
# . Redistributions in binary form must reproduce the above copyright notice,
|
13
|
+
# this list of conditions and the following disclaimer in the documentation
|
14
14
|
# and/or other materials provided with the distribution.
|
15
|
-
#
|
15
|
+
#
|
16
16
|
# . Neither the name of the "OpenWFE" nor the names of its contributors may be
|
17
17
|
# used to endorse or promote products derived from this software without
|
18
18
|
# specific prior written permission.
|
19
|
-
#
|
20
|
-
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
21
|
-
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
22
|
-
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
23
|
-
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
24
|
-
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
25
|
-
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
26
|
-
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
27
|
-
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
28
|
-
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
29
|
-
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
19
|
+
#
|
20
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
21
|
+
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
22
|
+
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
23
|
+
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
24
|
+
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
25
|
+
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
26
|
+
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
27
|
+
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
28
|
+
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
29
|
+
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
30
30
|
# POSSIBILITY OF SUCH DAMAGE.
|
31
31
|
#++
|
32
32
|
#
|
@@ -43,457 +43,464 @@ require 'openwfe/utils'
|
|
43
43
|
|
44
44
|
module OpenWFE
|
45
45
|
|
46
|
+
#
|
47
|
+
# The convention for the result of some expressions is to store
|
48
|
+
# their result in a workitem field named "__result__".
|
49
|
+
#
|
50
|
+
FIELD_RESULT = "__result__"
|
51
|
+
|
52
|
+
#--
|
53
|
+
# WORKITEMS
|
54
|
+
#++
|
55
|
+
|
56
|
+
#
|
57
|
+
# The base class for all the workitems.
|
58
|
+
#
|
59
|
+
class WorkItem
|
60
|
+
|
61
|
+
attr_accessor :last_modified, :attributes
|
62
|
+
|
63
|
+
def initialize
|
64
|
+
@last_modified = nil
|
65
|
+
@attributes = {}
|
66
|
+
end
|
67
|
+
|
68
|
+
alias :fields :attributes
|
69
|
+
alias :fields= :attributes=
|
70
|
+
|
46
71
|
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
|
50
|
-
FIELD_RESULT = "__result__"
|
51
|
-
|
52
|
-
#--
|
53
|
-
# WORKITEMS
|
54
|
-
#++
|
55
|
-
|
56
|
-
#
|
57
|
-
# The base class for all the workitems.
|
58
|
-
#
|
59
|
-
class WorkItem
|
60
|
-
|
61
|
-
attr_accessor :last_modified, :attributes
|
62
|
-
|
63
|
-
def initialize
|
64
|
-
@last_modified = nil
|
65
|
-
@attributes = {}
|
66
|
-
end
|
67
|
-
|
68
|
-
alias :fields :attributes
|
69
|
-
alias :fields= :attributes=
|
70
|
-
|
71
|
-
#
|
72
|
-
# Sets the last_modified field to now
|
73
|
-
#
|
74
|
-
def touch
|
75
|
-
|
76
|
-
@last_modified = Time.now
|
77
|
-
end
|
78
|
-
|
79
|
-
def to_h
|
80
|
-
|
81
|
-
h = {}
|
82
|
-
h[:type] = self.class.name
|
83
|
-
h[:last_modified] = @last_modified
|
84
|
-
h[:attributes] = @attributes
|
85
|
-
h
|
86
|
-
end
|
87
|
-
|
88
|
-
def self.from_h (h)
|
89
|
-
|
90
|
-
#wi = eval("#{h[:type]}.new")
|
91
|
-
wi = OpenWFE.get_class(h).new
|
92
|
-
wi.last_modified = h[:last_modified]
|
93
|
-
wi.attributes = h[:attributes]
|
94
|
-
wi
|
95
|
-
end
|
96
|
-
|
97
|
-
#
|
98
|
-
# A shortcut for
|
99
|
-
#
|
100
|
-
# workitem.attributes['key']
|
101
|
-
#
|
102
|
-
# is
|
103
|
-
#
|
104
|
-
# workitem['key']
|
105
|
-
#
|
106
|
-
# (Note that
|
107
|
-
#
|
108
|
-
# workitem.key
|
109
|
-
#
|
110
|
-
# will raise an exception if there is no attribute key).
|
111
|
-
#
|
112
|
-
def [] (key)
|
113
|
-
|
114
|
-
@attributes[key]
|
115
|
-
end
|
116
|
-
|
117
|
-
#
|
118
|
-
# A shortcut for
|
119
|
-
#
|
120
|
-
# workitem.attributes['key'] = value
|
121
|
-
#
|
122
|
-
# is
|
123
|
-
#
|
124
|
-
# workitem['key'] = value
|
125
|
-
#
|
126
|
-
def []= (key, value)
|
127
|
-
|
128
|
-
@attributes[key] = value
|
129
|
-
end
|
130
|
-
|
131
|
-
#
|
132
|
-
# In order to simplify code like :
|
133
|
-
#
|
134
|
-
# value = workitem.attributes['xyz']
|
135
|
-
#
|
136
|
-
# to
|
137
|
-
#
|
138
|
-
# value = workitem.xyz
|
139
|
-
#
|
140
|
-
# or
|
141
|
-
#
|
142
|
-
# value = workitem['xyz']
|
143
|
-
#
|
144
|
-
# we overrode method_missing.
|
145
|
-
#
|
146
|
-
# workitem.xyz = "my new value"
|
147
|
-
#
|
148
|
-
# is also possible
|
149
|
-
#
|
150
|
-
def method_missing (m, *args)
|
151
|
-
|
152
|
-
methodname = m.to_s
|
153
|
-
|
154
|
-
if args.length == 0
|
155
|
-
value = @attributes[methodname]
|
156
|
-
return value if value
|
157
|
-
raise "Missing attribute '#{methodname}' in workitem"
|
158
|
-
end
|
159
|
-
|
160
|
-
#if methodname == "[]" and args.length == 1
|
161
|
-
# value = @attributes[args[0]]
|
162
|
-
# return value if value
|
163
|
-
# raise "Missing attribute '#{methodname}' in workitem"
|
164
|
-
#end
|
165
|
-
#if methodname == "[]=" and args.length == 2
|
166
|
-
# return @attributes[args[0]] = args[1]
|
167
|
-
#end
|
168
|
-
|
169
|
-
if args.length == 1 and methodname[-1, 1] == "="
|
170
|
-
return @attributes[methodname[0..-2]] = args[0]
|
171
|
-
end
|
172
|
-
|
173
|
-
super(m, args)
|
174
|
-
end
|
175
|
-
|
176
|
-
#
|
177
|
-
# Produces a deep copy of the workitem
|
178
|
-
#
|
179
|
-
def dup
|
180
|
-
OpenWFE::fulldup(self)
|
181
|
-
end
|
182
|
-
|
183
|
-
#
|
184
|
-
# A smarter alternative to
|
185
|
-
#
|
186
|
-
# value = workitem.attributes[x]
|
187
|
-
#
|
188
|
-
# Via this method, nested values can be reached. For example :
|
189
|
-
#
|
190
|
-
# wi = InFlowWorkItem.new()
|
191
|
-
# wi.attributes = {
|
192
|
-
# "field0" => "value0",
|
193
|
-
# "field1" => [ 0, 1, 2, 3, [ "a", "b", "c" ]],
|
194
|
-
# "field2" => {
|
195
|
-
# "a" => "AA",
|
196
|
-
# "b" => "BB",
|
197
|
-
# "c" => [ "C0", "C1", "C3" ]
|
198
|
-
# },
|
199
|
-
# "field3" => 3,
|
200
|
-
# "field99" => nil
|
201
|
-
# }
|
202
|
-
#
|
203
|
-
# will verify the following assertions :
|
204
|
-
#
|
205
|
-
# assert wi.lookup_attribute("field3") == 3
|
206
|
-
# assert wi.lookup_attribute("field1.1") == 1
|
207
|
-
# assert wi.lookup_attribute("field1.4.1") == "b"
|
208
|
-
# assert wi.lookup_attribute("field2.c.1") == "C1"
|
209
|
-
#
|
210
|
-
def lookup_attribute (key)
|
211
|
-
OpenWFE.lookup_attribute(@attributes, key)
|
212
|
-
end
|
213
|
-
|
214
|
-
#
|
215
|
-
# The partner to the lookup_attribute() method. Behaves like it.
|
216
|
-
#
|
217
|
-
def has_attribute? (key)
|
218
|
-
OpenWFE.has_attribute?(@attributes, key)
|
219
|
-
end
|
220
|
-
|
221
|
-
#
|
222
|
-
# set_attribute() accomodates itself with nested key constructs.
|
223
|
-
#
|
224
|
-
def set_attribute (key, value)
|
225
|
-
OpenWFE.set_attribute(@attributes, key, value)
|
226
|
-
end
|
227
|
-
|
228
|
-
#
|
229
|
-
# unset_attribute() accomodates itself with nested key constructs.
|
230
|
-
#
|
231
|
-
def unset_attribute (key)
|
232
|
-
OpenWFE.unset_attribute(@attributes, key)
|
233
|
-
end
|
234
|
-
|
235
|
-
alias :lookup_field :lookup_attribute
|
236
|
-
alias :has_field? :has_attribute?
|
237
|
-
alias :set_field :set_attribute
|
238
|
-
alias :unset_field :unset_attribute
|
72
|
+
# Sets the last_modified field to now
|
73
|
+
#
|
74
|
+
def touch
|
239
75
|
|
76
|
+
@last_modified = Time.now
|
240
77
|
end
|
241
78
|
|
79
|
+
def to_h
|
80
|
+
|
81
|
+
h = {}
|
82
|
+
h['type'] = self.class.name
|
83
|
+
h['last_modified'] = @last_modified
|
84
|
+
h['attributes'] = @attributes
|
85
|
+
h
|
86
|
+
end
|
87
|
+
|
88
|
+
def self.from_h (h)
|
89
|
+
|
90
|
+
wi = OpenWFE.get_class(h).new
|
91
|
+
wi.last_modified = h['last_modified']
|
92
|
+
wi.attributes = h['attributes']
|
93
|
+
wi
|
94
|
+
end
|
95
|
+
|
96
|
+
#
|
97
|
+
# A shortcut for
|
98
|
+
#
|
99
|
+
# workitem.attributes['key']
|
100
|
+
#
|
101
|
+
# is
|
102
|
+
#
|
103
|
+
# workitem['key']
|
242
104
|
#
|
243
|
-
#
|
105
|
+
# (Note that
|
244
106
|
#
|
245
|
-
|
107
|
+
# workitem.key
|
108
|
+
#
|
109
|
+
# will raise an exception if there is no attribute key).
|
110
|
+
#
|
111
|
+
def [] (key)
|
246
112
|
|
247
|
-
|
113
|
+
@attributes[key]
|
114
|
+
end
|
248
115
|
|
249
|
-
|
250
|
-
|
251
|
-
|
116
|
+
#
|
117
|
+
# A shortcut for
|
118
|
+
#
|
119
|
+
# workitem.attributes['key'] = value
|
120
|
+
#
|
121
|
+
# is
|
122
|
+
#
|
123
|
+
# workitem['key'] = value
|
124
|
+
#
|
125
|
+
def []= (key, value)
|
252
126
|
|
253
|
-
|
254
|
-
|
255
|
-
end
|
127
|
+
@attributes[key] = value
|
128
|
+
end
|
256
129
|
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
130
|
+
#
|
131
|
+
# In order to simplify code like :
|
132
|
+
#
|
133
|
+
# value = workitem.attributes['xyz']
|
134
|
+
#
|
135
|
+
# to
|
136
|
+
#
|
137
|
+
# value = workitem.xyz
|
138
|
+
#
|
139
|
+
# or
|
140
|
+
#
|
141
|
+
# value = workitem['xyz']
|
142
|
+
#
|
143
|
+
# we overrode method_missing.
|
144
|
+
#
|
145
|
+
# workitem.xyz = "my new value"
|
146
|
+
#
|
147
|
+
# is also possible
|
148
|
+
#
|
149
|
+
def method_missing (m, *args)
|
150
|
+
|
151
|
+
methodname = m.to_s
|
152
|
+
|
153
|
+
if args.length == 0
|
154
|
+
value = @attributes[methodname]
|
155
|
+
return value if value != nil
|
156
|
+
raise "Missing attribute '#{methodname}' in workitem"
|
157
|
+
end
|
158
|
+
|
159
|
+
#if methodname == "[]" and args.length == 1
|
160
|
+
# value = @attributes[args[0]]
|
161
|
+
# return value if value
|
162
|
+
# raise "Missing attribute '#{methodname}' in workitem"
|
163
|
+
#end
|
164
|
+
#if methodname == "[]=" and args.length == 2
|
165
|
+
# return @attributes[args[0]] = args[1]
|
166
|
+
#end
|
167
|
+
|
168
|
+
if args.length == 1 and methodname[-1, 1] == '='
|
169
|
+
return @attributes[methodname[0..-2]] = args[0]
|
170
|
+
end
|
171
|
+
|
172
|
+
super(m, args)
|
173
|
+
end
|
262
174
|
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
175
|
+
#
|
176
|
+
# Produces a deep copy of the workitem
|
177
|
+
#
|
178
|
+
def dup
|
179
|
+
OpenWFE::fulldup(self)
|
180
|
+
end
|
181
|
+
|
182
|
+
#
|
183
|
+
# A smarter alternative to
|
184
|
+
#
|
185
|
+
# value = workitem.attributes[x]
|
186
|
+
#
|
187
|
+
# Via this method, nested values can be reached. For example :
|
188
|
+
#
|
189
|
+
# wi = InFlowWorkItem.new()
|
190
|
+
# wi.attributes = {
|
191
|
+
# "field0" => "value0",
|
192
|
+
# "field1" => [ 0, 1, 2, 3, [ "a", "b", "c" ]],
|
193
|
+
# "field2" => {
|
194
|
+
# "a" => "AA",
|
195
|
+
# "b" => "BB",
|
196
|
+
# "c" => [ "C0", "C1", "C3" ]
|
197
|
+
# },
|
198
|
+
# "field3" => 3,
|
199
|
+
# "field99" => nil
|
200
|
+
# }
|
201
|
+
#
|
202
|
+
# will verify the following assertions :
|
203
|
+
#
|
204
|
+
# assert wi.lookup_attribute("field3") == 3
|
205
|
+
# assert wi.lookup_attribute("field1.1") == 1
|
206
|
+
# assert wi.lookup_attribute("field1.4.1") == "b"
|
207
|
+
# assert wi.lookup_attribute("field2.c.1") == "C1"
|
208
|
+
#
|
209
|
+
def lookup_attribute (key)
|
210
|
+
OpenWFE.lookup_attribute(@attributes, key)
|
211
|
+
end
|
269
212
|
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
end
|
213
|
+
#
|
214
|
+
# The partner to the lookup_attribute() method. Behaves like it.
|
215
|
+
#
|
216
|
+
def has_attribute? (key)
|
217
|
+
OpenWFE.has_attribute?(@attributes, key)
|
276
218
|
end
|
277
219
|
|
278
220
|
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
|
282
|
-
|
283
|
-
#
|
284
|
-
class InFlowWorkItem < InFlowItem
|
285
|
-
|
286
|
-
attr_accessor :dispatch_time
|
287
|
-
attr_accessor :filter
|
288
|
-
|
289
|
-
#
|
290
|
-
# In OpenWFEja, workitem history was stored, OpenWFEru doesn't do
|
291
|
-
# it (no need to copy history over and over).
|
292
|
-
#
|
293
|
-
# (deprecated)
|
294
|
-
#
|
295
|
-
attr_accessor :history
|
296
|
-
|
297
|
-
attr_accessor :store
|
298
|
-
#
|
299
|
-
# special : added by the ruby lib, not given by the worklist
|
300
|
-
|
301
|
-
#
|
302
|
-
# Outputting the workitem in a human readable format
|
303
|
-
#
|
304
|
-
def to_s
|
305
|
-
|
306
|
-
s = ""
|
307
|
-
s << " #{self.class} :\n"
|
308
|
-
s << " - flow_expression_id : #{@flow_expression_id}\n"
|
309
|
-
s << " - participant_name : #{@participant_name}\n"
|
310
|
-
s << " - last_modified : #{@last_modified}\n"
|
311
|
-
s << " - dispatch_time : #{@dispatch_time}\n"
|
312
|
-
s << " - attributes :\n"
|
313
|
-
|
314
|
-
s << " {\n"
|
315
|
-
@attributes.keys.sort.each do |k|
|
316
|
-
v = @attributes[k]
|
317
|
-
s << " #{k.inspect} => #{v.inspect},\n"
|
318
|
-
end
|
319
|
-
s << " }"
|
320
|
-
s
|
321
|
-
end
|
322
|
-
|
323
|
-
#
|
324
|
-
# For some easy YAML encoding, turns the workitem into a Hash
|
325
|
-
# (Any YAML-enabled platform can thus read it).
|
326
|
-
#
|
327
|
-
def to_h
|
328
|
-
|
329
|
-
h = super
|
330
|
-
h[:dispatch_time] = @dispatch_time
|
331
|
-
#h[:history] = @history
|
332
|
-
h[:filter] = @filter
|
333
|
-
h
|
334
|
-
end
|
335
|
-
|
336
|
-
#
|
337
|
-
# Rebuilds an InFlowWorkItem from its hash version.
|
338
|
-
#
|
339
|
-
def InFlowWorkItem.from_h (h)
|
340
|
-
|
341
|
-
wi = super
|
342
|
-
wi.dispatch_time = h[:dispatch_time]
|
343
|
-
#wi.history = h[:history]
|
344
|
-
wi.filter = h[:filter]
|
345
|
-
wi
|
346
|
-
end
|
347
|
-
|
348
|
-
#
|
349
|
-
# Sets the '__result__' field of this workitem
|
350
|
-
#
|
351
|
-
def set_result (result)
|
352
|
-
|
353
|
-
@attributes[FIELD_RESULT] = result
|
354
|
-
end
|
355
|
-
|
356
|
-
#
|
357
|
-
# Makes sure the '__result__' field of this workitem is empty.
|
358
|
-
#
|
359
|
-
def unset_result
|
360
|
-
|
361
|
-
@attributes.delete FIELD_RESULT
|
362
|
-
end
|
363
|
-
|
364
|
-
#
|
365
|
-
# Just a shortcut (for consistency) of
|
366
|
-
#
|
367
|
-
# workitem.attributes["__result__"]
|
368
|
-
#
|
369
|
-
def get_result
|
370
|
-
|
371
|
-
@attributes[FIELD_RESULT]
|
372
|
-
end
|
373
|
-
|
374
|
-
#
|
375
|
-
# Returns true or false.
|
376
|
-
#
|
377
|
-
def get_boolean_result
|
378
|
-
|
379
|
-
r = get_result
|
380
|
-
return false unless r
|
381
|
-
(r == true or r == "true")
|
382
|
-
end
|
221
|
+
# set_attribute() accomodates itself with nested key constructs.
|
222
|
+
#
|
223
|
+
def set_attribute (key, value)
|
224
|
+
OpenWFE.set_attribute(@attributes, key, value)
|
383
225
|
end
|
384
226
|
|
385
227
|
#
|
386
|
-
#
|
387
|
-
# emits a CancelItem towards it.
|
388
|
-
# It's especially important for participants to react correctly upon
|
389
|
-
# receiving a cancel item.
|
228
|
+
# unset_attribute() accomodates itself with nested key constructs.
|
390
229
|
#
|
391
|
-
|
230
|
+
def unset_attribute (key)
|
231
|
+
OpenWFE.unset_attribute(@attributes, key)
|
232
|
+
end
|
233
|
+
|
234
|
+
alias :lookup_field :lookup_attribute
|
235
|
+
alias :has_field? :has_attribute?
|
236
|
+
alias :set_field :set_attribute
|
237
|
+
alias :unset_field :unset_attribute
|
238
|
+
|
239
|
+
end
|
392
240
|
|
393
|
-
|
241
|
+
#
|
242
|
+
# The common parent class for InFlowWorkItem and CancelItem.
|
243
|
+
#
|
244
|
+
class InFlowItem < WorkItem
|
394
245
|
|
395
|
-
|
396
|
-
|
397
|
-
|
246
|
+
attr_accessor :flow_expression_id, :participant_name
|
247
|
+
|
248
|
+
def last_expression_id
|
249
|
+
@flow_expression_id
|
250
|
+
end
|
251
|
+
|
252
|
+
def last_expression_id= (fei)
|
253
|
+
@flow_expression_id = fei
|
398
254
|
end
|
399
255
|
|
400
256
|
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
#, :description_map
|
412
|
-
|
413
|
-
alias :wfdurl :workflow_definition_url
|
414
|
-
alias :wfdurl= :workflow_definition_url=
|
415
|
-
|
416
|
-
#
|
417
|
-
# This constructor will build an empty LaunchItem.
|
418
|
-
#
|
419
|
-
# If the optional parameter process_definition is set, the
|
420
|
-
# definition will be embedded in the launchitem attributes
|
421
|
-
# for retrieval by the engine.
|
422
|
-
#
|
423
|
-
# There are several ways to specify the process definition.
|
424
|
-
# Here are some examples:
|
425
|
-
#
|
426
|
-
# # Use a Ruby class that extends OpenWFE::ProcessDefinition
|
427
|
-
# LaunchItem.new(MyProcessDefinition)
|
428
|
-
#
|
429
|
-
# # Provide an XML process definition as a string
|
430
|
-
# definition = """
|
431
|
-
# <process-definition name="x" revision="y">
|
432
|
-
# <sequence>
|
433
|
-
# <participant ref="alpha" />
|
434
|
-
# <participant ref="bravo" />
|
435
|
-
# </sequence>
|
436
|
-
# </process-definition>
|
437
|
-
# """.strip
|
438
|
-
# LaunchItem.new(definition)
|
439
|
-
#
|
440
|
-
# # Load an XML process definition from a local file
|
441
|
-
# require 'uri'
|
442
|
-
# LaunchItem.new(URI.parse("file:///tmp/my_process_definition.xml"))
|
443
|
-
#
|
444
|
-
# # If you initialized your engine with
|
445
|
-
# # {:remote_definitions_allowed => true}, then you can also load an
|
446
|
-
# # XML process definition from a remote url
|
447
|
-
# require 'uri'
|
448
|
-
# LaunchItem.new(URI.parse("http://foo.bar/my_process_definition.xml"))
|
449
|
-
#
|
450
|
-
def initialize (process_definition=nil)
|
451
|
-
|
452
|
-
super()
|
453
|
-
|
454
|
-
if process_definition
|
455
|
-
@workflow_definition_url = FIELD_DEF
|
456
|
-
@attributes[DEF] = process_definition
|
457
|
-
end
|
458
|
-
end
|
459
|
-
|
460
|
-
#
|
461
|
-
# Turns the LaunchItem instance into a simple 'hash' (easily
|
462
|
-
# serializable to other formats).
|
463
|
-
#
|
464
|
-
def to_h
|
465
|
-
|
466
|
-
h = super
|
467
|
-
h[:workflow_definition_url] = @workflow_definition_url
|
468
|
-
h
|
469
|
-
end
|
470
|
-
|
471
|
-
def self.from_h (h)
|
472
|
-
|
473
|
-
li = super
|
474
|
-
li.workflow_definition_url = h[:workflow_definition_url]
|
475
|
-
li
|
476
|
-
end
|
257
|
+
# Just a handy alias for flow_expression_id
|
258
|
+
#
|
259
|
+
alias :fei :flow_expression_id
|
260
|
+
alias :fei= :flow_expression_id=
|
261
|
+
|
262
|
+
def to_h
|
263
|
+
h = super
|
264
|
+
h['flow_expression_id'] = @flow_expression_id.to_h
|
265
|
+
h['participant_name'] = @participant_name
|
266
|
+
h
|
477
267
|
end
|
478
268
|
|
269
|
+
def InFlowItem.from_h (h)
|
270
|
+
wi = super
|
271
|
+
wi.flow_expression_id = FlowExpressionId.from_h(h['flow_expression_id'])
|
272
|
+
wi.participant_name = h['participant_name']
|
273
|
+
wi
|
274
|
+
end
|
275
|
+
end
|
276
|
+
|
277
|
+
#
|
278
|
+
# When the term 'workitem' is used it's generally referring to instances
|
279
|
+
# of this InFlowWorkItem class.
|
280
|
+
# InFlowWorkItem are circulating within process instances and carrying
|
281
|
+
# data around. Their 'payload' is located in their attribute Hash field.
|
282
|
+
#
|
283
|
+
class InFlowWorkItem < InFlowItem
|
284
|
+
|
285
|
+
attr_accessor :dispatch_time
|
286
|
+
attr_accessor :filter
|
287
|
+
|
479
288
|
#
|
480
|
-
#
|
481
|
-
#
|
289
|
+
# in some contexts (ruote-rest, ruote-web2, the web...) workitems
|
290
|
+
# have an URI
|
482
291
|
#
|
483
|
-
|
292
|
+
attr_accessor :uri
|
484
293
|
|
485
|
-
|
486
|
-
|
487
|
-
|
294
|
+
#
|
295
|
+
# In OpenWFEja, workitem history was stored, OpenWFEru doesn't do
|
296
|
+
# it (no need to copy history over and over).
|
297
|
+
#
|
298
|
+
# (deprecated)
|
299
|
+
#
|
300
|
+
attr_accessor :history
|
301
|
+
|
302
|
+
attr_accessor :store
|
303
|
+
#
|
304
|
+
# special : added by the ruby lib, not given by the worklist
|
305
|
+
|
306
|
+
#
|
307
|
+
# Outputting the workitem in a human readable format
|
308
|
+
#
|
309
|
+
def to_s
|
310
|
+
|
311
|
+
s = ""
|
312
|
+
s << " #{self.class} :\n"
|
313
|
+
s << " - flow_expression_id : #{@flow_expression_id}\n"
|
314
|
+
s << " - participant_name : #{@participant_name}\n"
|
315
|
+
s << " - last_modified : #{@last_modified}\n"
|
316
|
+
s << " - dispatch_time : #{@dispatch_time}\n"
|
317
|
+
s << " - attributes :\n"
|
318
|
+
|
319
|
+
s << " {\n"
|
320
|
+
@attributes.keys.sort.each do |k|
|
321
|
+
v = @attributes[k]
|
322
|
+
s << " #{k.inspect} => #{v.inspect},\n"
|
323
|
+
end
|
324
|
+
s << " }"
|
325
|
+
s
|
326
|
+
end
|
327
|
+
|
328
|
+
#
|
329
|
+
# For some easy YAML encoding, turns the workitem into a Hash
|
330
|
+
# (Any YAML-enabled platform can thus read it).
|
331
|
+
#
|
332
|
+
def to_h
|
333
|
+
|
334
|
+
h = super
|
335
|
+
h['dispatch_time'] = @dispatch_time
|
336
|
+
#h[:history] = @history
|
337
|
+
h['filter'] = @filter
|
338
|
+
h
|
339
|
+
end
|
340
|
+
|
341
|
+
#
|
342
|
+
# Rebuilds an InFlowWorkItem from its hash version.
|
343
|
+
#
|
344
|
+
def InFlowWorkItem.from_h (h)
|
345
|
+
|
346
|
+
wi = super
|
347
|
+
wi.dispatch_time = h['dispatch_time']
|
348
|
+
wi.filter = h['filter']
|
349
|
+
wi
|
350
|
+
end
|
351
|
+
|
352
|
+
#
|
353
|
+
# Sets the '__result__' field of this workitem
|
354
|
+
#
|
355
|
+
def set_result (result)
|
356
|
+
|
357
|
+
@attributes[FIELD_RESULT] = result
|
358
|
+
end
|
359
|
+
|
360
|
+
#
|
361
|
+
# Makes sure the '__result__' field of this workitem is empty.
|
362
|
+
#
|
363
|
+
def unset_result
|
364
|
+
|
365
|
+
@attributes.delete FIELD_RESULT
|
366
|
+
end
|
367
|
+
|
368
|
+
#
|
369
|
+
# Just a shortcut (for consistency) of
|
370
|
+
#
|
371
|
+
# workitem.attributes["__result__"]
|
372
|
+
#
|
373
|
+
def get_result
|
374
|
+
|
375
|
+
@attributes[FIELD_RESULT]
|
376
|
+
end
|
377
|
+
|
378
|
+
#
|
379
|
+
# Returns true or false.
|
380
|
+
#
|
381
|
+
def get_boolean_result
|
382
|
+
|
383
|
+
r = get_result
|
384
|
+
return false unless r
|
385
|
+
(r == true or r == 'true')
|
386
|
+
end
|
387
|
+
end
|
388
|
+
|
389
|
+
#
|
390
|
+
# When it needs to cancel a branch of a process instance, the engine
|
391
|
+
# emits a CancelItem towards it.
|
392
|
+
# It's especially important for participants to react correctly upon
|
393
|
+
# receiving a cancel item.
|
394
|
+
#
|
395
|
+
class CancelItem < InFlowItem
|
396
|
+
|
397
|
+
def initialize (workitem)
|
398
|
+
|
399
|
+
super()
|
400
|
+
@flow_expression_id = workitem.fei.dup
|
401
|
+
end
|
402
|
+
end
|
403
|
+
|
404
|
+
#
|
405
|
+
# LaunchItem instances are used to instantiate and launch processes.
|
406
|
+
# They contain attributes that are used as the initial payload of the
|
407
|
+
# workitem circulating in the process instances.
|
408
|
+
#
|
409
|
+
class LaunchItem < WorkItem
|
410
|
+
|
411
|
+
DEF = "__definition"
|
412
|
+
FIELD_DEF = "field:#{DEF}"
|
413
|
+
|
414
|
+
attr_accessor :workflow_definition_url
|
415
|
+
#, :description_map
|
416
|
+
|
417
|
+
alias :wfdurl :workflow_definition_url
|
418
|
+
alias :wfdurl= :workflow_definition_url=
|
419
|
+
|
420
|
+
#
|
421
|
+
# This constructor will build an empty LaunchItem.
|
422
|
+
#
|
423
|
+
# If the optional parameter process_definition is set, the
|
424
|
+
# definition will be embedded in the launchitem attributes
|
425
|
+
# for retrieval by the engine.
|
426
|
+
#
|
427
|
+
# There are several ways to specify the process definition.
|
428
|
+
# Here are some examples:
|
429
|
+
#
|
430
|
+
# # Use a Ruby class that extends OpenWFE::ProcessDefinition
|
431
|
+
# LaunchItem.new(MyProcessDefinition)
|
432
|
+
#
|
433
|
+
# # Provide an XML process definition as a string
|
434
|
+
# definition = """
|
435
|
+
# <process-definition name="x" revision="y">
|
436
|
+
# <sequence>
|
437
|
+
# <participant ref="alpha" />
|
438
|
+
# <participant ref="bravo" />
|
439
|
+
# </sequence>
|
440
|
+
# </process-definition>
|
441
|
+
# """.strip
|
442
|
+
# LaunchItem.new(definition)
|
443
|
+
#
|
444
|
+
# # Load an XML process definition from a local file
|
445
|
+
# require 'uri'
|
446
|
+
# LaunchItem.new(URI.parse("file:///tmp/my_process_definition.xml"))
|
447
|
+
#
|
448
|
+
# # If you initialized your engine with
|
449
|
+
# # {:remote_definitions_allowed => true}, then you can also load an
|
450
|
+
# # XML process definition from a remote url
|
451
|
+
# require 'uri'
|
452
|
+
# LaunchItem.new(URI.parse("http://foo.bar/my_process_definition.xml"))
|
453
|
+
#
|
454
|
+
def initialize (process_definition=nil)
|
455
|
+
|
456
|
+
super()
|
457
|
+
|
458
|
+
if process_definition
|
459
|
+
@workflow_definition_url = FIELD_DEF
|
460
|
+
@attributes[DEF] = process_definition
|
461
|
+
end
|
488
462
|
end
|
489
463
|
|
490
|
-
|
464
|
+
#
|
465
|
+
# Turns the LaunchItem instance into a simple 'hash' (easily
|
466
|
+
# serializable to other formats).
|
467
|
+
#
|
468
|
+
def to_h
|
491
469
|
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
eval(cl)
|
470
|
+
h = super
|
471
|
+
h['workflow_definition_url'] = @workflow_definition_url
|
472
|
+
h
|
496
473
|
end
|
497
474
|
|
475
|
+
def self.from_h (h)
|
476
|
+
|
477
|
+
li = super
|
478
|
+
li.workflow_definition_url = h['workflow_definition_url']
|
479
|
+
li
|
480
|
+
end
|
481
|
+
end
|
482
|
+
|
483
|
+
#
|
484
|
+
# Turns a hash into its corresponding workitem (InFlowWorkItem, CancelItem,
|
485
|
+
# LaunchItem).
|
486
|
+
#
|
487
|
+
def OpenWFE.workitem_from_h (h)
|
488
|
+
|
489
|
+
wi_class = get_class(h)
|
490
|
+
wi_class.from_h(h)
|
491
|
+
end
|
492
|
+
|
493
|
+
WI_CLASSES = [
|
494
|
+
OpenWFE::LaunchItem, OpenWFE::InFlowWorkItem, OpenWFE::CancelItem
|
495
|
+
].inject({}) { |r, c| r[c.to_s] = c; r }
|
496
|
+
|
497
|
+
#
|
498
|
+
# returns the workitem class for the given hash
|
499
|
+
#
|
500
|
+
def OpenWFE.get_class (h)
|
501
|
+
|
502
|
+
WI_CLASSES[h['type']]
|
503
|
+
end
|
504
|
+
|
498
505
|
end
|
499
506
|
|