Class: SOAP::RPC::Proxy

Inherits:
Object show all
Includes:
SOAP
Defined in:
lib/soap/rpc/proxy.rb

Defined Under Namespace

Classes: Operation

Constant Summary

Constants included from SOAP

AttrActor, AttrActorName, AttrArrayType, AttrArrayTypeName, AttrEncodingStyle, AttrEncodingStyleName, AttrMustUnderstand, AttrMustUnderstandName, AttrOffset, AttrOffsetName, AttrPosition, AttrPositionName, AttrRoot, AttrRootName, Base64Literal, Charset, EleBody, EleBodyName, EleEnvelope, EleEnvelopeName, EleFault, EleFaultActor, EleFaultActorName, EleFaultCode, EleFaultCodeName, EleFaultDetail, EleFaultDetailName, EleFaultName, EleFaultString, EleFaultStringName, EleHeader, EleHeaderName, EncodingNamespace, EnvelopeNamespace, LiteralNamespace, MediaType, NS, NextActor, PropertyName, SOAP::RPCRouter, SOAP::RPCServerException, SOAP::RPCUtils, SOAPNamespaceTag, SOAPProxy, TypeMap, VERSION, ValueArray, ValueArrayName, XSDNamespaceTag, XSINamespaceTag

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_url, soapaction, options) ⇒ Proxy

Returns a new instance of Proxy.


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/soap/rpc/proxy.rb', line 45

def initialize(endpoint_url, soapaction, options)
  @endpoint_url = endpoint_url
  @soapaction = soapaction
  @options = options
  @protocol_option = options["protocol"] ||= ::SOAP::Property.new
  initialize_streamhandler(@protocol_option)
  @operation = {}
  @operation_by_qname = {}
  @operation_by_soapaction = {}
  @mandatorycharset = nil
  @allow_unqualified_element = true
  @default_encodingstyle = nil
  @generate_explicit_type = true
  @return_response_as_xml = false
  @headerhandler = Header::HandlerSet.new
  @filterchain = Filter::FilterChain.new
  @mapping_registry = nil
  @literal_mapping_registry = ::SOAP::Mapping::LiteralRegistry.new
end

Instance Attribute Details

#allow_unqualified_elementObject

Returns the value of attribute allow_unqualified_element


32
33
34
# File 'lib/soap/rpc/proxy.rb', line 32

def allow_unqualified_element
  @allow_unqualified_element
end

#default_encodingstyleObject

Returns the value of attribute default_encodingstyle


33
34
35
# File 'lib/soap/rpc/proxy.rb', line 33

def default_encodingstyle
  @default_encodingstyle
end

#filterchainObject (readonly)

Returns the value of attribute filterchain


37
38
39
# File 'lib/soap/rpc/proxy.rb', line 37

def filterchain
  @filterchain
end

#generate_explicit_typeObject

Returns the value of attribute generate_explicit_type


34
35
36
# File 'lib/soap/rpc/proxy.rb', line 34

def generate_explicit_type
  @generate_explicit_type
end

#headerhandlerObject (readonly)

Returns the value of attribute headerhandler


36
37
38
# File 'lib/soap/rpc/proxy.rb', line 36

def headerhandler
  @headerhandler
end

#literal_mapping_registryObject

Returns the value of attribute literal_mapping_registry


41
42
43
# File 'lib/soap/rpc/proxy.rb', line 41

def literal_mapping_registry
  @literal_mapping_registry
end

#mandatorycharsetObject

Returns the value of attribute mandatorycharset


31
32
33
# File 'lib/soap/rpc/proxy.rb', line 31

def mandatorycharset
  @mandatorycharset
end

#mapping_registryObject

Returns the value of attribute mapping_registry


40
41
42
# File 'lib/soap/rpc/proxy.rb', line 40

def mapping_registry
  @mapping_registry
end

#operationObject (readonly)

Returns the value of attribute operation


43
44
45
# File 'lib/soap/rpc/proxy.rb', line 43

def operation
  @operation
end

#return_response_as_xmlObject

Returns the value of attribute return_response_as_xml


35
36
37
# File 'lib/soap/rpc/proxy.rb', line 35

def return_response_as_xml
  @return_response_as_xml
end

#soapactionObject

Returns the value of attribute soapaction


30
31
32
# File 'lib/soap/rpc/proxy.rb', line 30

def soapaction
  @soapaction
end

#streamhandlerObject (readonly)

Returns the value of attribute streamhandler


38
39
40
# File 'lib/soap/rpc/proxy.rb', line 38

def streamhandler
  @streamhandler
end

Instance Method Details

#add_document_operation(soapaction, name, param_def, opt = {}) ⇒ Object Also known as: add_document_method


97
98
99
100
101
# File 'lib/soap/rpc/proxy.rb', line 97

def add_document_operation(soapaction, name, param_def, opt = {})
  ensure_styleuse_option(opt, :document, :literal)
  op = Operation.new(soapaction, param_def, opt)
  assign_operation(name, nil, soapaction, op)
end

#add_rpc_operation(qname, soapaction, name, param_def, opt = {}) ⇒ Object Also known as: add_method, add_rpc_method


90
91
92
93
94
95
# File 'lib/soap/rpc/proxy.rb', line 90

def add_rpc_operation(qname, soapaction, name, param_def, opt = {})
  ensure_styleuse_option(opt, :rpc, :encoded)
  opt[:request_qname] = qname
  op = Operation.new(soapaction, param_def, opt)
  assign_operation(name, qname, soapaction, op)
end

#call(name, *params) ⇒ Object

Raises:


118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/soap/rpc/proxy.rb', line 118

def call(name, *params)
  # name must be used only for lookup
  op_info = lookup_operation(name)
  mapping_opt = create_mapping_opt
  req_header = create_request_header
  req_body = SOAPBody.new(
    op_info.request_body(params, @mapping_registry,
      @literal_mapping_registry, mapping_opt)
  )
  reqopt = create_encoding_opt(
    :soapaction => op_info.soapaction || @soapaction,
    :envelopenamespace => @options["soap.envelope.requestnamespace"],
    :default_encodingstyle =>
      @default_encodingstyle || op_info.request_default_encodingstyle,
    :elementformdefault => op_info.elementformdefault,
    :attributeformdefault => op_info.attributeformdefault
  )
  resopt = create_encoding_opt(
    :envelopenamespace => @options["soap.envelope.responsenamespace"],
    :default_encodingstyle =>
      @default_encodingstyle || op_info.response_default_encodingstyle,
    :elementformdefault => op_info.elementformdefault,
    :attributeformdefault => op_info.attributeformdefault
  )
  env = route(req_header, req_body, reqopt, resopt)
  if op_info.response_use.nil?
    return nil
  end
  raise EmptyResponseError unless env
  receive_headers(env.header)
  begin
    check_fault(env.body)
  rescue ::SOAP::FaultError => e
    op_info.raise_fault(e, @mapping_registry, @literal_mapping_registry)
  end
  if @return_response_as_xml
    resopt[:response_as_xml]
  else
    op_info.response_obj(env.body, @mapping_registry,
      @literal_mapping_registry, mapping_opt)
  end
end

#check_fault(body) ⇒ Object


186
187
188
189
190
# File 'lib/soap/rpc/proxy.rb', line 186

def check_fault(body)
  if body.fault
    raise SOAP::FaultError.new(body.fault)
  end
end

#endpoint_urlObject


69
70
71
# File 'lib/soap/rpc/proxy.rb', line 69

def endpoint_url
  @endpoint_url
end

#endpoint_url=(endpoint_url) ⇒ Object


73
74
75
76
# File 'lib/soap/rpc/proxy.rb', line 73

def endpoint_url=(endpoint_url)
  @endpoint_url = endpoint_url
  reset_stream
end

#inspectObject


65
66
67
# File 'lib/soap/rpc/proxy.rb', line 65

def inspect
  "#<#{self.class}:#{@endpoint_url}>"
end

#invoke(req_header, req_body, opt = nil) ⇒ Object


108
109
110
111
112
113
114
115
116
# File 'lib/soap/rpc/proxy.rb', line 108

def invoke(req_header, req_body, opt = nil)
  opt ||= create_encoding_opt
  env = route(req_header, req_body, opt, opt)
  if @return_response_as_xml
    opt[:response_as_xml]
  else
    env
  end
end

#reset_streamObject


78
79
80
# File 'lib/soap/rpc/proxy.rb', line 78

def reset_stream
  @streamhandler.reset(@endpoint_url)
end

#route(req_header, req_body, reqopt, resopt) ⇒ Object


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/soap/rpc/proxy.rb', line 161

def route(req_header, req_body, reqopt, resopt)
  req_env = ::SOAP::SOAPEnvelope.new(req_header, req_body)
  unless reqopt[:envelopenamespace].nil?
    set_envelopenamespace(req_env, reqopt[:envelopenamespace])
  end
  reqopt[:external_content] = nil
  conn_data = marshal(req_env, reqopt)
  if ext = reqopt[:external_content]
    mime = MIMEMessage.new
    ext.each do |k, v|
    	mime.add_attachment(v.data)
    end
    mime.add_part(conn_data.send_string + "\r\n")
    mime.close
    conn_data.send_string = mime.content_str
    conn_data.send_contenttype = mime.headers['content-type'].str
  end
  conn_data = @streamhandler.send(@endpoint_url, conn_data,
    reqopt[:soapaction])
  if conn_data.receive_string.empty?
    return nil
  end
  unmarshal(conn_data, resopt)
end

#set_wiredump_file_base(wiredump_file_base) ⇒ Object


82
83
84
# File 'lib/soap/rpc/proxy.rb', line 82

def set_wiredump_file_base(wiredump_file_base)
  @streamhandler.wiredump_file_base = wiredump_file_base
end

#test_loopback_responseObject


86
87
88
# File 'lib/soap/rpc/proxy.rb', line 86

def test_loopback_response
  @streamhandler.test_loopback_response
end