Class OpenWFE::ControlClient
In: lib/openwfe/orest/controlclient.rb
Parent: RestClient

This client is used to connect to an OpenWFE engine to call ‘control methods’ for monitoring process instances, freezing or cancelling them

Methods

Public Class methods

[Source]

    # File lib/openwfe/orest/controlclient.rb, line 52
52:         def initialize (url, username, password)
53: 
54:             super(url, username, password)
55:         end

Public Instance methods

Cancels a given expression (and potentially its whole subtree)

[Source]

    # File lib/openwfe/orest/controlclient.rb, line 83
83:         def cancel_expression (flowExpressionId)
84: 
85:             fei = OpenWFE.encode(flowExpressionId)
86: 
87:             params = {}
88: 
89:             decode(self.post('cancelexpression', nil, params, fei))
90:         end

Freezes an expression (and potentially its whole subtree)

[Source]

     # File lib/openwfe/orest/controlclient.rb, line 95
 95:         def freeze_expression (flowExpressionId)
 96: 
 97:             fei = OpenWFE.encode(flowExpressionId)
 98: 
 99:             params = {}
100: 
101:             decode(self.post('freezeexpression', nil, params, fei))
102:         end

Returns the list of expressions currently applied for a given workflow instance

[Source]

    # File lib/openwfe/orest/controlclient.rb, line 70
70:         def get_flow_position (workflowInstanceId)
71: 
72:             params = {}
73:             params['id'] = workflowInstanceId
74: 
75:             r = self.get('getflowposition', nil, params)
76:             decode(r)
77:         end
get_flow_stack(workflowInstanceId)

Alias for get_flow_position

Returns the list of controlable expressions

[Source]

    # File lib/openwfe/orest/controlclient.rb, line 60
60:         def list_expressions ()
61: 
62:             r = self.get('listexpressions', nil, nil)
63:             decode(r)
64:         end

Unfreezes an expression (and potentially its whole subtree)

[Source]

     # File lib/openwfe/orest/controlclient.rb, line 107
107:         def unfreeze_expression (flowExpressionId)
108: 
109:             fei = OpenWFE.encode(flowExpressionId)
110: 
111:             params = {}
112: 
113:             decode(self.post('unfreezeexpression', nil, params, fei))
114:         end

[Validate]