How can I populate header values in SOAP document?

ruby-talk
1

Hi all,

Got a question about the Ruby SOAP library. I've generated a proxy
using the SOAP::WSDLDriverFactory as follows:

ws =
SOAP::WSDLDriverFactory.new('http://foo.com/foo.wsdl').create_rpc_driver

I can see that this generates methods for each defined operation, and I
use them thusly:

ws.WSGetResults(:maxRecords => 1, ...)

The method and parameters are translated to the appropriate XML in the
SOAP message body. However, some operations require a 'User' and
'Password' to be in the message _header_. I've looked through the
documentation and mailing lists with no luck. How can one achieve this?

My code is listed below.

Thanks!

Brian Hartin

---- soaptest.rb ----
require 'soap/wsdlDriver'
require 'date'

ws =
SOAP::WSDLDriverFactory.new('http://foo.com/foo.wsdl').create_rpc_driver
ws.generate_explicit_type = true
r = ws.WSHeartbeat({}) # Works because it doesn't require authentication
r = g.WSGetXmlResults(:recordId => 123, :recordLimit => 200) # Doesn't
work

---- Example SOAP request, according to vendor ----
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <!-- I don't know how to populate the header -->
    <WSAuthHeader xmlns="http://foo.com/WSFooSvc">
      <User>string</User>
      <Password>string</Password>
    </WSAuthHeader>
  </soap:Header>
  <soap:Body>
    <WSGetXmlResults xmlns="http://foo.com/WSFooSvc">
      <recordId>int</recordId>
      <recordLimit>int</recordLimit>
    </WSGetXmlResults>
  </soap:Body>
</soap:Envelope>

···

****************************************************************************
This email may contain confidential material.
If you were not an intended recipient,
Please notify the sender and delete all copies.
We may monitor email to and from our network.
****************************************************************************

2

I'm not sure if it can be done dynamically, but you can create a
ClientSimpleHeader which hooks into the inbound and outbound stream.
I've only hooked into the outbound and it looked something like the code
below.

The code is untested and extrapolated from my case to yours, so take the
general idea and see where it gets you.

And if you didn't know, driver.wiredump_dev is your friend.

Good Luck.

enjoy,

-jeremy

----- customer_header.rb -----
require 'soap/header/simplehandler'
require 'stringio'

class CustomSimpleHeader < SOAP::Header::SimpleHandler
    # encapsulate outbound only headers, this is set once and never
    # touched again.

···

#
    def initialize(itemname,namespace,childdata)
        super(XSD::QName.new(namespace,name))

        case childdate
        # other classes if you want
        # Or do something with XML::Mappging
        when Hash
            xml = StringIO.new
            childdata.each_pair do |key,value|
                xml.puts("<#{key}>#{value}</#{key}>")
            end
            @item = xml.string
        else
            @item = childdata.to_s
        end
    end

    def on_simple_outbound
        @item if @item
    end

    def on_simple_inbound
    end
end

---- possible soaptest.rb -----
require 'customer_header'

# assuming this works with a dynamic proxy

ws = SOAP::WSDLDriverFactor.new("http://foo.com/foo.wsdl&quot;\).create_rpc_driver
ws.wiredump_dev = STDERR
ws.generate_explicit_type = true
user = "my user"
password = "my password"
ws.headerhandler << CustomSimpleHeader.new("WSAuthHeader",
                                           { "User" => user,
                                             "Password" => password })

-----

--

Jeremy Hinegardner jeremy@hinegardner.org

On Fri, Oct 27, 2006 at 04:52:54AM +0900, Hartin, Brian wrote:

Hi all,

Got a question about the Ruby SOAP library. I've generated a proxy
using the SOAP::WSDLDriverFactory as follows:

ws =
SOAP::WSDLDriverFactory.new('http://foo.com/foo.wsdl&#39;\).create_rpc_driver

I can see that this generates methods for each defined operation, and I
use them thusly:

ws.WSGetResults(:maxRecords => 1, ...)

The method and parameters are translated to the appropriate XML in the
SOAP message body. However, some operations require a 'User' and
'Password' to be in the message _header_. I've looked through the
documentation and mailing lists with no luck. How can one achieve this?

My code is listed below.

Thanks!

Brian Hartin

---- soaptest.rb ----
require 'soap/wsdlDriver'
require 'date'

ws =
SOAP::WSDLDriverFactory.new('http://foo.com/foo.wsdl&#39;\).create_rpc_driver
ws.generate_explicit_type = true
r = ws.WSHeartbeat({}) # Works because it doesn't require authentication
r = g.WSGetXmlResults(:recordId => 123, :recordLimit => 200) # Doesn't
work

---- Example SOAP request, according to vendor ----
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance&quot;
xmlns:xsd="http://www.w3.org/2001/XMLSchema&quot;
xmlns:soap="Error;
  <soap:Header>
    <!-- I don't know how to populate the header -->
    <WSAuthHeader xmlns="http://foo.com/WSFooSvc&quot;&gt;
      <User>string</User>
      <Password>string</Password>
    </WSAuthHeader>
  </soap:Header>
  <soap:Body>
    <WSGetXmlResults xmlns="http://foo.com/WSFooSvc&quot;&gt;
      <recordId>int</recordId>
      <recordLimit>int</recordLimit>
    </WSGetXmlResults>
  </soap:Body>
</soap:Envelope>
****************************************************************************
This email may contain confidential material.
If you were not an intended recipient,
Please notify the sender and delete all copies.
We may monitor email to and from our network.
****************************************************************************

3

<snip code help>

jeremy: it's nice to see you're not programming python for a living anymore!

:wink:

-a

···

On Fri, 27 Oct 2006, Jeremy Hinegardner wrote:

--
my religion is very simple. my religion is kindness. -- the dalai lama