openwferu 0.9.1 → 0.9.2

data/lib/openwfe/participants/soapparticipants.rb

@@ -0,0 +1,96 @@
+#
+#--
+# 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$
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'soap/rpc/driver'
+
+require 'openwfe/participants/participants'
+
+
+module OpenWFE
+
+    #
+    # Stores the incoming workitem into an 'atom feed'
+    #
+    class SoapParticipant < LocalParticipant
+
+        def initialize \
+            (endpoint_url, namespace, method_name, params, param_prefix="")
+
+            super()
+
+            @driver = SOAP::RPC::Driver.new(endpoint_url, namespace)
+
+            @method_name = method_name
+            @params = params
+            @param_prefix = param_prefix
+
+            @driver.add_method(method_name, *params)
+        end
+
+        def consume (workitem)
+
+            call_params = []
+
+            @params.each do |param|
+                call_params << get_param(workitem, param)
+            end
+
+            result = @driver.send(@method_name, *call_params)
+
+            workitem.attributes["__result__"] = result
+
+            reply_to_engine(workitem)
+        end
+
+        protected
+
+            def get_param (workitem, param_name)
+
+                param_name = @param_prefix + param_name if @param_prefix
+                r = workitem.attributes[param_name]
+                return r if r
+                return ""
+            end
+
+    end
+
+end
+

data/lib/{controlclient.rb → openwfe/rest/controlclient.rb}

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -39,12 +39,16 @@
 
 require 'definitions'
 require 'restclient'
-require 'codec'
+require 'xmlcodec'
 
 
 module OpenWFE
 
-
+    #
+    # This client is used to connect to an OpenWFE engine to call
+    # 'control methods' for monitoring process instances, freezing or
+    # cancelling them
+    #
     class ControlClient < RestClient
 
         def initialize (server, port, username, password)
@@ -60,7 +64,7 @@ module OpenWFE
         #
         # Returns the list of controlable expressions
         #
-        def listExpressions ()
+        def list_expressions ()
 
             r = self.get('listexpressions', nil, nil)
             return decode(r)
@@ -82,7 +86,7 @@ module OpenWFE
         #
         # Cancels a given expression (and potentially its whole subtree)
         #
-        def cancelExpression (flowExpressionId)
+        def cancel_expression (flowExpressionId)
 
             fei = OpenWFE.encode(flowExpressionId)
 
@@ -94,7 +98,7 @@ module OpenWFE
         #
         # Freezes an expression (and potentially its whole subtree)
         #
-        def freezeExpression (flowExpressionId)
+        def freeze_expression (flowExpressionId)
 
             fei = OpenWFE.encode(flowExpressionId)
 
@@ -106,7 +110,7 @@ module OpenWFE
         #
         # Unfreezes an expression (and potentially its whole subtree)
         #
-        def unfreezeExpression (flowExpressionId)
+        def unfreeze_expression (flowExpressionId)
 
             fei = OpenWFE.encode(flowExpressionId)
 
@@ -115,17 +119,12 @@ module OpenWFE
             return decode(self.post('unfreezeexpression', nil, params, fei))
         end
 
-        alias list_expressions listExpressions
-        alias cancel_expression cancelExpression
-        alias freeze_expression freezeExpression
-        alias unfreeze_expression unfreezeExpression
-
         protected
 
             def decode (reply)
 
                 xml = REXML::Document.new(reply.body)
-                return OpenWFE.decode(xml.root)
+                return OpenWFE.xml_decode(xml.root)
             end
 
     end

data/lib/{definitions.rb → openwfe/rest/definitions.rb}

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: definitions.rb 3454 2006-10-08 16:51:00Z jmettraux $
 #

data/lib/{exception.rb → openwfe/rest/exception.rb}

@@ -1,6 +1,6 @@
 #
-#<tt>
-# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
+#--
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -28,7 +28,7 @@
 # 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.
-#</tt>
+#++
 #
 # $Id: exception.rb 3454 2006-10-08 16:51:00Z jmettraux $
 #

data/lib/{restclient.rb → openwfe/rest/restclient.rb}

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -44,13 +44,17 @@ require 'rexml/document'
 
 module OpenWFE
 
+    #
+    # A basic REST client for OpenWFE services (control and worklist)
+    #
     class RestClient
 
-        attr_reader :host, :port, :resource, :sessionId
+        attr_reader \
+            :host, :port, :resource, :session_id
 
         def initialize (url, username, password)
 
-            splitUrl(url)
+            split_url(url)
             @username = username
 
             connect(password)
@@ -69,7 +73,7 @@ module OpenWFE
             def get (action, subResourceName, params)
 
                 return @httpclient\
-                    .get(computeResource(action, subResourceName, params))
+                    .get(compute_resource(action, subResourceName, params))
             end
 
             def post (action, subResourceName, params, data)
@@ -77,12 +81,12 @@ module OpenWFE
                 data = data.to_s()
 
                 return @httpclient\
-                    .post(computeResource(action, subResourceName, params), data)
+                    .post(compute_resource(action, subResourceName, params), data)
             end
 
         private
 
-            def splitUrl (url)
+            def split_url (url)
 
                 @host = nil
                 @port = nil
@@ -120,16 +124,16 @@ module OpenWFE
 
                 xml = REXML::Document.new(r.body)
 
-                @sessionId = Integer(xml.root.attributes["id"])
+                @session_id = Integer(xml.root.attributes["id"])
             end
 
-            def computeResource (action, subResourceName, params)
+            def compute_resource (action, subResourceName, params)
 
                 resource = @resource
                 resource = resource+'/'+subResourceName if subResourceName
 
                 resource = resource+\
-                    '?session='+@sessionId.to_s()+'&action='+action
+                    '?session='+@session_id.to_s()+'&action='+action
 
                 if params
                     params.keys.each do |k|
@@ -142,16 +146,3 @@ module OpenWFE
     end
 end
 
-
-# for test purposes
-#
-#client = RestClient::RestClient\
-#   .new("127.0.0.1:5080/worklist", "alice", "alice")
-#client = OpenWFE::RestClient\
-#   .new("http://127.0.0.1:5080/worklist", "alice", "alice")
-#
-#puts "sessionId : #{client.sessionId}"
-#
-#puts client.get('getstorenames', nil, nil)
-#puts client.get('getheaders', 'Store.alpha', nil)
-

data/lib/{worklistclient.rb → openwfe/rest/worklistclient.rb}

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2005-2006, John Mettraux, OpenWFE.org
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -39,11 +39,14 @@
 
 require 'definitions'
 require 'restclient'
-require 'codec'
+require 'xmlcodec'
 
 
 module OpenWFE
 
+    #
+    # a client to an OpenWFE worklists.
+    #
     class WorklistClient < RestClient
 
         def initialize (server, port, username, password)
@@ -59,7 +62,7 @@ module OpenWFE
         #
         # Returns the list of stores the worklist hosts
         #
-        def listStores ()
+        def list_stores ()
             r = self.get('listStores', nil, nil)
             return decode(r)
         end
@@ -67,14 +70,14 @@ module OpenWFE
         #
         # A synonym for listStores()
         #
-        def getStoreNames ()
+        def get_store_names ()
             return listStores()
         end
 
         #
         # Returns the headers of a given store.
         #
-        def getHeaders (storeName, limit=1000)
+        def get_headers (storeName, limit=1000)
 
             params = {}
             params["limit"] = limit
@@ -82,7 +85,7 @@ module OpenWFE
             return decode(self.get('getHeaders', storeName, params))
         end
 
-        def findFlowInstance (storeName, workflowInstanceId)
+        def find_flow_instance (storeName, workflowInstanceId)
 
             params = {}
             params["id"] = workflowInstanceId
@@ -95,9 +98,9 @@ module OpenWFE
         # The 'engineId' corresponds to an engine's participant name
         # (see etc/engine/participant-map.xml)
         #
-        def launchFlow (engineId, launchitem)
+        def launch_flow (engineId, launchitem)
 
-            eli = OpenWFE.encode(launchitem)
+            eli = OpenWFE.xml_encode(launchitem)
 
             params = {}
             params[ENGINEID] = engineId
@@ -110,9 +113,9 @@ module OpenWFE
         # to it cannot be communicated with saveWorkitem() or forwardWorkitem()
         # to the worklist)
         #
-        def getWorkitem (storeName, flowExpressionId)
+        def get_workitem (storeName, flowExpressionId)
 
-            return getItem('getWorkitem', storeName, flowExpressionId)
+            return get_item('getWorkitem', storeName, flowExpressionId)
         end
 
         #
@@ -120,20 +123,20 @@ module OpenWFE
         # the usage of the methods saveWorkitem() and forwardWorkitem() is
         # possible.
         #
-        def getAndLockWorkitem (storeName, flowExpressionId)
+        def get_and_lock_workitem (storeName, flowExpressionId)
 
             #puts "...getAndLockWorkitem() for #{flowExpressionId}"
 
-            return getItem('getAndLockWorkitem', storeName, flowExpressionId)
+            return get_item('getAndLockWorkitem', storeName, flowExpressionId)
         end
 
         #
         # Given a queryMap (a dict of keys and values), locks and returns 
         # the first workitem matching.
         #
-        def queryAndLockWorkitem (storeName, queryMap)
+        def query_and_lock_workitem (storeName, queryMap)
 
-            hs = getHeaders(storeName)
+            hs = get_headers(storeName)
             hs.each do |h|
 
                 #puts "...h.id  #{h.flowExpressionId}"
@@ -158,7 +161,8 @@ module OpenWFE
 
                 #puts "  .id is #{h.flowExpressionId}"
 
-                return getAndLockWorkitem(storeName, h.flowExpressionId) if ok
+                return get_and_lock_workitem(storeName, h.flowExpressionId) \
+                    if ok
             end
 
             return nil
@@ -168,33 +172,33 @@ module OpenWFE
         # Notifies the worklist that the given workitem has to be unlocked
         # any local (client-side) modification to it are ignored.
         #
-        def releaseWorkitem (workitem)
+        def release_workitem (workitem)
 
-            return postItem('releaseWorkitem', workitem)
+            return post_item('releaseWorkitem', workitem)
         end
 
         #
         # Saves back the workitem in the worklist (and releases it)
         #
-        def saveWorkitem (workitem)
+        def save_workitem (workitem)
 
-            return postItem('saveWorkitem', workitem)
+            return post_item('saveWorkitem', workitem)
         end
 
         #
         # Returns the workitem to the worklist so that it can resume 
         # its flow (changes to the workitem are saved).
         #
-        def proceedWorkitem (workitem)
+        def proceed_workitem (workitem)
 
-            return postItem('forwardWorkitem', workitem)
+            return post_item('forwardWorkitem', workitem)
         end
 
         #
         # Returns the list of flow URLs the user owning this session may
         # launch.
         #
-        def listLaunchables ()
+        def list_launchables ()
 
             params = {}
 
@@ -219,7 +223,7 @@ module OpenWFE
         # Delegate the workitem (ask the worklist to deliver it to 
         # another participant).
         #
-        def delegateToParticipant (workitem, targetParticipantName)
+        def delegate_to_participant (workitem, targetParticipantName)
 
             ewi = OpenWFE.encode(workitem)
 
@@ -232,35 +236,18 @@ module OpenWFE
         #def queryStore (storeName, query)
         #end
 
-        alias list_stores listStores
-        alias get_store_names getStoreNames
-        alias get_headers getHeaders
-        alias find_flow_instance findFlowInstance
-        alias launch_flow launchFlow
-        alias get_workitem getWorkitem
-        alias get_and_lock_workitem getAndLockWorkitem
-        alias query_and_lock_workitem queryAndLockWorkitem
-        alias release_workitem releaseWorkitem
-        alias save_workitem saveWorkitem
-        alias proceed_workitem proceedWorkitem
-        alias forwardWorkitem proceedWorkitem
-        alias forward_workitem proceedWorkitem
-        alias list_launchables listLaunchables
-        alias delegate_to_participant delegateToParticipant
-
-
         protected
 
             def decode (reply)
 
                 xml = REXML::Document.new(reply.body)
-                return OpenWFE.decode(xml.root)
+                return OpenWFE.xml_decode(xml.root)
             end
 
-            def getItem (restMethodName, storeName, flowExpressionId)
+            def get_item (restMethodName, storeName, flowExpressionId)
 
-                fei = OpenWFE.encode(flowExpressionId)
-                fei = OpenWFE.docToString(fei, false)
+                fei = OpenWFE.xml_encode(flowExpressionId)
+                fei = OpenWFE.xmldoc_to_string(fei, false)
 
                 params = {}
 
@@ -271,9 +258,9 @@ module OpenWFE
                 return wi
             end
 
-            def postItem (restMethodName, workitem)
+            def post_item (restMethodName, workitem)
 
-                ewi = OpenWFE.encode(workitem)
+                ewi = OpenWFE.xml_encode(workitem)
 
                 params = {}