Implements SOAP client support (using RPC encoding for the messages).
Example Usage
class PersonAPI < ActionWebService::API::Base api_method :find_all, :returns => [[Person]] end soap_client = ActionWebService::Client::Soap.new(PersonAPI, "http://...") persons = soap_client.find_all
- N
- P
- S
[R] | driver | provides access to the underlying soap driver |
Creates a new web service client using the SOAP RPC protocol.
api
must be an ActionWebService::API::Base derivative, and
endpoint_uri
must point at the relevant URL to which protocol
requests will be sent with HTTP POST.
Valid options:
:namespace
-
If the remote server has used a custom namespace to declare its custom types, you can specify it here. This would be the namespace declared with a [WebService(Namespace = “namespace”)] attribute in .NET, for example.
:driver_options
-
If you want to supply any custom SOAP RPC driver options, you can provide them as a Hash here
The :driver_options
option can be used to configure the
backend SOAP RPC driver. An example of configuring the SOAP backend to do
client-certificate authenticated SSL connections to the server:
opts = {} opts['protocol.http.ssl_config.verify_mode'] = 'OpenSSL::SSL::VERIFY_PEER' opts['protocol.http.ssl_config.client_cert'] = client_cert_file_path opts['protocol.http.ssl_config.client_key'] = client_key_file_path opts['protocol.http.ssl_config.ca_file'] = ca_cert_file_path client = ActionWebService::Client::Soap.new(api, 'https://some/service', :driver_options => opts)
Source: show
# File rails/actionwebservice/lib/action_web_service/client/soap_client.rb, line 46 def initialize(api, endpoint_uri, options={}) super(api, endpoint_uri) @namespace = options[:namespace] || 'urn:ActionWebService' @driver_options = options[:driver_options] || {} @protocol = ActionWebService::Protocol::Soap::SoapProtocol.new @namespace @soap_action_base = options[:soap_action_base] @soap_action_base ||= URI.parse(endpoint_uri).path @driver = create_soap_rpc_driver(api, endpoint_uri) @driver_options.each do |name, value| @driver.options[name.to_s] = value end end
Source: show
# File rails/actionwebservice/lib/action_web_service/client/soap_client.rb, line 60 def perform_invocation(method_name, args) method = @api.api_methods[method_name.to_sym] args = method.cast_expects(args.dup) rescue args return_value = @driver.send(method_name, *args) method.cast_returns(return_value.dup) rescue return_value end
Source: show
# File rails/actionwebservice/lib/action_web_service/client/soap_client.rb, line 67 def soap_action(method_name) "#{@soap_action_base}/#{method_name}" end