Module: ActionWebService::Invocation::ClassMethods
- Defined in:
- lib/action_web_service/invocation.rb
Overview
Invocation interceptors provide a means to execute custom code before and after method invocations on ActionWebService::Base objects.
When running in Direct dispatching mode, ActionController filters should be used for this functionality instead.
The semantics of invocation interceptors are the same as ActionController filters, and accept the same parameters and options.
A before interceptor can also cancel execution by returning false
, or returning a [false, "cancel reason"]
array if it wishes to supply a reason for canceling the request.
Example
class CustomService < ActionWebService::Base
before_invocation :intercept_add, :only => [:add]
def add(a, b)
a + b
end
private
def intercept_add
return [false, "permission denied"] # cancel it
end
end
Options:
:except
-
A list of methods for which the interceptor will NOT be called
:only
-
A list of methods for which the interceptor WILL be called
Instance Method Summary collapse
-
#after_invocation_interceptors ⇒ Object
:nodoc:.
-
#append_after_invocation(*interceptors, &block) ⇒ Object
(also: #after_invocation)
Appends the given
interceptors
to be called after method invocation. -
#append_before_invocation(*interceptors, &block) ⇒ Object
(also: #before_invocation)
Appends the given
interceptors
to be called before method invocation. -
#before_invocation_interceptors ⇒ Object
:nodoc:.
-
#prepend_after_invocation(*interceptors, &block) ⇒ Object
Prepends the given
interceptors
to be called after method invocation. -
#prepend_before_invocation(*interceptors, &block) ⇒ Object
Prepends the given
interceptors
to be called before method invocation.
Instance Method Details
#after_invocation_interceptors ⇒ Object
:nodoc:
92 93 94 |
# File 'lib/action_web_service/invocation.rb', line 92 def after_invocation_interceptors # :nodoc: self.after_invocation_interceptors_attr end |
#append_after_invocation(*interceptors, &block) ⇒ Object Also known as: after_invocation
Appends the given interceptors
to be called after method invocation.
70 71 72 73 74 75 |
# File 'lib/action_web_service/invocation.rb', line 70 def append_after_invocation(*interceptors, &block) conditions = extract_conditions!(interceptors) interceptors << block if block_given? add_interception_conditions(interceptors, conditions) append_interceptors_to_chain("after", interceptors) end |
#append_before_invocation(*interceptors, &block) ⇒ Object Also known as: before_invocation
Appends the given interceptors
to be called before method invocation.
50 51 52 53 54 55 |
# File 'lib/action_web_service/invocation.rb', line 50 def append_before_invocation(*interceptors, &block) conditions = extract_conditions!(interceptors) interceptors << block if block_given? add_interception_conditions(interceptors, conditions) append_interceptors_to_chain("before", interceptors) end |
#before_invocation_interceptors ⇒ Object
:nodoc:
88 89 90 |
# File 'lib/action_web_service/invocation.rb', line 88 def before_invocation_interceptors # :nodoc: self.before_invocation_interceptors_attr end |
#prepend_after_invocation(*interceptors, &block) ⇒ Object
Prepends the given interceptors
to be called after method invocation.
79 80 81 82 83 84 |
# File 'lib/action_web_service/invocation.rb', line 79 def prepend_after_invocation(*interceptors, &block) conditions = extract_conditions!(interceptors) interceptors << block if block_given? add_interception_conditions(interceptors, conditions) prepend_interceptors_to_chain("after", interceptors) end |
#prepend_before_invocation(*interceptors, &block) ⇒ Object
Prepends the given interceptors
to be called before method invocation.
59 60 61 62 63 64 |
# File 'lib/action_web_service/invocation.rb', line 59 def prepend_before_invocation(*interceptors, &block) conditions = extract_conditions!(interceptors) interceptors << block if block_given? add_interception_conditions(interceptors, conditions) prepend_interceptors_to_chain("before", interceptors) end |