Class: SOAP::RPC::Router

Inherits:
Object show all
Includes:
SOAP
Defined in:
lib/soap/compat.rb,
lib/soap/rpc/router.rb

Defined Under Namespace

Classes: ApplicationScopeOperation, Operation, RequestScopeOperation

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(actor) ⇒ Router

Returns a new instance of Router.


36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/soap/rpc/router.rb', line 36

def initialize(actor)
  @actor = actor
  @mapping_registry = nil
  @headerhandler = Header::HandlerSet.new
  @literal_mapping_registry = ::SOAP::Mapping::LiteralRegistry.new
  @generate_explicit_type = true
  @external_ces = nil
  @operation_by_soapaction = {}
  @operation_by_qname = {}
  @headerhandlerfactory = []
  @filterchain = Filter::FilterChain.new
end

Instance Attribute Details

#actorObject (readonly)

Returns the value of attribute actor


29
30
31
# File 'lib/soap/rpc/router.rb', line 29

def actor
  @actor
end

#external_cesObject

Returns the value of attribute external_ces


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

def external_ces
  @external_ces
end

#filterchainObject (readonly)

Returns the value of attribute filterchain


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

def filterchain
  @filterchain
end

#generate_explicit_typeObject

Returns the value of attribute generate_explicit_type


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

def generate_explicit_type
  @generate_explicit_type
end

#literal_mapping_registryObject

Returns the value of attribute literal_mapping_registry


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

def literal_mapping_registry
  @literal_mapping_registry
end

#mapping_registryObject Also known as: mappingRegistry

Returns the value of attribute mapping_registry


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

def mapping_registry
  @mapping_registry
end

Instance Method Details

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


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/soap/rpc/router.rb', line 123

def add_document_operation(receiver, soapaction, name, param_def, opt = {})
  #
  # adopt workaround for doc/lit wrapper method
  # (you should consider to simply use rpc/lit service)
  #
  #unless soapaction
  #  raise RPCRoutingError.new("soapaction is a must for document method")
  #end
  ensure_styleuse_option(opt, :document, :literal)
  op = ApplicationScopeOperation.new(soapaction, receiver, name, param_def,
    opt)
  if opt[:request_style] != :document
    raise RPCRoutingError.new("illegal request_style given")
  end
  assign_operation(soapaction, first_input_part_qname(param_def), op)
end

#add_document_request_operation(factory, soapaction, name, param_def, opt = {}) ⇒ Object


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/soap/rpc/router.rb', line 141

def add_document_request_operation(factory, soapaction, name, param_def, opt = {})
  #
  # adopt workaround for doc/lit wrapper method
  # (you should consider to simply use rpc/lit service)
  #
  #unless soapaction
  #  raise RPCRoutingError.new("soapaction is a must for document method")
  #end
  ensure_styleuse_option(opt, :document, :literal)
  op = RequestScopeOperation.new(soapaction, receiver, name, param_def, opt)
  if opt[:request_style] != :document
    raise RPCRoutingError.new("illegal request_style given")
  end
  assign_operation(soapaction, first_input_part_qname(param_def), op)
end

#add_headerhandler(handler) ⇒ Object


59
60
61
# File 'lib/soap/rpc/router.rb', line 59

def add_headerhandler(handler)
  @headerhandler.add(handler)
end

#add_request_headerhandler(factory) ⇒ Object

header handler interface


52
53
54
55
56
57
# File 'lib/soap/rpc/router.rb', line 52

def add_request_headerhandler(factory)
  unless factory.respond_to?(:create)
    raise TypeError.new("factory must respond to 'create'")
  end
  @headerhandlerfactory << factory
end

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

operation definition interface


100
101
102
103
104
105
106
107
108
109
# File 'lib/soap/rpc/router.rb', line 100

def add_rpc_operation(receiver, qname, soapaction, name, param_def, opt = {})
  ensure_styleuse_option(opt, :rpc, :encoded)
  opt[:request_qname] = qname
  op = ApplicationScopeOperation.new(soapaction, receiver, name, param_def,
    opt)
  if opt[:request_style] != :rpc
    raise RPCRoutingError.new("illegal request_style given")
  end
  assign_operation(soapaction, qname, op)
end

#add_rpc_request_operation(factory, qname, soapaction, name, param_def, opt = {}) ⇒ Object


113
114
115
116
117
118
119
120
121
# File 'lib/soap/rpc/router.rb', line 113

def add_rpc_request_operation(factory, qname, soapaction, name, param_def, opt = {})
  ensure_styleuse_option(opt, :rpc, :encoded)
  opt[:request_qname] = qname
  op = RequestScopeOperation.new(soapaction, factory, name, param_def, opt)
  if opt[:request_style] != :rpc
    raise RPCRoutingError.new("illegal request_style given")
  end
  assign_operation(soapaction, qname, op)
end

#add_rpc_request_servant(factory, namespace) ⇒ Object

servant definition interface


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/soap/rpc/router.rb', line 66

def add_rpc_request_servant(factory, namespace)
  unless factory.respond_to?(:create)
    raise TypeError.new("factory must respond to 'create'")
  end
  obj = factory.create        # a dummy instance for introspection
  ::SOAP::RPC.defined_methods(obj).each do |name|
    begin
      qname = XSD::QName.new(namespace, name)
      param_def = ::SOAP::RPC::SOAPMethod.derive_rpc_param_def(obj, name)
      opt = create_styleuse_option(:rpc, :encoded)
      add_rpc_request_operation(factory, qname, nil, name, param_def, opt)
    rescue SOAP::RPC::MethodDefinitionError => e
      p e if $DEBUG
    end
  end
end

#add_rpc_servant(obj, namespace) ⇒ Object Also known as: add_servant


83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/soap/rpc/router.rb', line 83

def add_rpc_servant(obj, namespace)
  ::SOAP::RPC.defined_methods(obj).each do |name|
    begin
      qname = XSD::QName.new(namespace, name)
      param_def = ::SOAP::RPC::SOAPMethod.derive_rpc_param_def(obj, name)
      opt = create_styleuse_option(:rpc, :encoded)
      add_rpc_operation(obj, qname, nil, name, param_def, opt)
    rescue SOAP::RPC::MethodDefinitionError => e
      p e if $DEBUG
    end
  end
end

#create_fault_response(e) ⇒ Object

Create fault response string.


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/soap/rpc/router.rb', line 198

def create_fault_response(e)
  env = SOAPEnvelope.new(SOAPHeader.new, SOAPBody.new(fault(e, nil), true))
  opt = {}
  opt[:external_content] = nil
  @filterchain.reverse_each do |filter|
    env = filter.on_outbound(env, opt)
    break unless env
  end
  response_string = Processor.marshal(env, opt)
  conn_data = StreamHandler::ConnectionData.new(response_string)
  conn_data.is_fault = true
  if ext = opt[:external_content]
    mimeize(conn_data, ext)
  end
  conn_data
end

#route(conn_data) ⇒ Object


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/soap/rpc/router.rb', line 157

def route(conn_data)
  # we cannot set request_default_encodingsyle before parsing the content.
  env = unmarshal(conn_data)
  if env.nil?
    raise ArgumentError.new("illegal SOAP marshal format")
  end
  op = lookup_operation(conn_data.soapaction, env.body)
  headerhandler = @headerhandler.dup
  @headerhandlerfactory.each do |f|
    headerhandler.add(f.create)
  end
  soap_response = default_encodingstyle = nil
  begin
    receive_headers(headerhandler, env.header)
    soap_response =
      op.call(env.body, @mapping_registry, @literal_mapping_registry,
        create_mapping_opt)
    conn_data.is_fault = true if soap_response.is_a?(SOAPFault)
    default_encodingstyle = op.response_default_encodingstyle
  rescue Exception => e
    # If a wsdl fault was raised by service, the fault declaration details
    # is kept in wsdl_fault. Otherwise (exception is a program fault)
    # wsdl_fault is nil
    wsdl_fault_details = op.faults && op.faults[e.class.name]
    soap_response = fault(e, wsdl_fault_details)
    conn_data.is_fault = true
    default_encodingstyle = nil
  end
  header = call_headers(headerhandler)
  if op.response_use.nil?
    conn_data.send_string = ''
    conn_data.is_nocontent = true
    conn_data
  else
    body = SOAPBody.new(soap_response, conn_data.is_fault)
    env = SOAPEnvelope.new(header, body)
    marshal(conn_data, env, default_encodingstyle)
  end
end