Welcome to the "trac"-ing site of soap4r!
[soap4r] [httpclient] [openpgp4u] [pkcs1] [logger] [csv] [vtr]

root/branches/1_5/RELEASE_en.html

Revision 1984, 115.9 kB (checked in by nahi, 10 months ago)
  • update documents for 1.5.8-GA.
  • Property svn:eol-style set to native
  • Property svn:keywords set to author date id revision
Line 
1 <?xml version="1.0"?>
2 <!DOCTYPE html
3     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
4     "DTD/xhtml1-strict.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 <meta http-equiv="Content-Style-Type" content="text/css" />
9 <link rev="MADE" href="mailto:nahi@ruby-lang.org" />
10 <link rel="StyleSheet" href="rubyStyle.css" type="text/css" media="screen" />
11 <title>Release Notes - SOAP4R</title>
12 </head>
13 <body>
14
15 <div class="header">
16 <h1>
17 Release Notes - SOAP4R
18 </h1>
19
20 <p class="status">
21 Last modified: Sep 24, 2007<br />
22 Created: July 17, 2000
23 </p>
24 </div>
25
26 <hr />
27
28 <div class="main">
29 <h2><span class="content">0. In this document...</span></h2>
30
31 <p>
32 This is Release Notes of SOAP4R.
33 </p>
34
35 <p>
36 Target SOAP4R version: SOAP4R/1.5.8
37 </p>
38
39 <ol>
40 <li><a href="#changes">Changes</a></li>
41 <li><a href="#install">Install</a></li>
42 <li><a href="#uninstall">Uninstall</a></li>
43 <li><a href="#whats">What is SOAP4R?</a></li>
44 <li><a href="#dependencies">Dependencies</a></li>
45 <li><a href="#samples">Samples</a></li>
46 <li><a href="#resources">Resources</a></li>
47 <li><a href="#history">History</a></li>
48 <li><a href="#author">Author</a></li>
49 <li><a href="#copyright">Copyright</a></li>
50 </ol>
51
52 <h2 id="changes" name="changes"><span class="content">1. Changes</span></h2>
53
54 <p>
55 Version 1.5.8 has improved its XML Schema support, such as
56 class generation of XML Schema anonymous complexType,
57 full built-in datatypes support of XML Schema Datatypes, and more.
58 Here are changes in 1.5.8 from 1.5.7.
59 </p>
60
61 <ul><li>XML Schema
62 <ul><li>added classes for the last of built-in datatypes of XML Schema Datatypes (NMTOKEN, NMTOKENS, Name, NCName, ID, IDREF, IDREFS, ENTITY, and ENTITIES). lexical scope is not checked for these datatypes yet. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/340" title="Complete implementation of data types (xsd, soap) (closed)">#340</a>)
63 </li><li>added anonymous type support. wsdl2ruby.rb/xsd2ruby.rb maps anonymous type to inner class. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/355" title="let wsdl2ruby.rb support stub class generation of XML anonymous type (closed)">#355</a>)
64 </li><li>added support of all XML Schema facets for restriction. No validation implemented yet. do you want to validate XML messages by soap4r? (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/364" title="minInclusive/maxInclusive of simpleRestriction (closed)">#364</a>)
65 </li><li>added &lt;xsd:attributeGroup&gt; support. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/389" title="attributeGroup support (closed)">#389</a>)
66
67 </li><li>added &lt;xsd:anyAttribute&gt; support. just ignore anyAttribute because wsdll2ruby.rb now generates xmlattr method. use it for adding any attribute. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/390" title="anyAttribute support (closed)">#390</a>)
68 </li><li>added &lt;xsd:group&gt; support. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/391" title="group support (closed)">#391</a>)
69 </li><li>[BUG] XSD::XSDDuration should allow durations lower than a day. Thanks to an anonymous user for taking the time to file the ticket. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/401" title="XSDDuration doesn't support durations lower than a day (closed)">#401</a>)
70 </li><li>[BUG] choice handling bug fixed according to a patch from KR, Vesa Varimo. If there was choice element in complex type, soap4r didn't process all elements if the first element was an empty array. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/382" title="Choice definition in XSD (closed)">#382</a>)
71
72 </li><li>[BUG] some WSDL caused cyclic schema inclusion. &lt;xsd:import&gt; supported cyclic include but &lt;xsd:include&gt; did not. extract common implementation as importHandler.rb. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/385" title="cyclic schema include (closed)">#385</a>)
73 </li><li>[BUG] added supports of &lt;xsd:complexType&gt; definition inheritance. earlier soap4r supported only element definition inheritance. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/394" title="Abstract classes not being included in output - wsdsl2ruby, netsuite wsdl (closed)">#394</a>)
74 </li><li>[BUG] support &lt;xsd:choice maxOccurs="unbounded"/&gt;: treat it &lt;xsd:all/&gt; for now. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/400" title="choice + maxOccurs=&#34;unbounded&#34; (closed)">#400</a>)
75
76 </li><li>[BUG] allow &lt;xsd:any&gt; appear twice or more. with the current implementation, soap4r ignores &lt;xsd:any&gt; element definition such as namespace and processContent. just allow any element appear. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/402" title="&lt;any&gt; can appear twice (closed)">#402</a>)
77 </li><li>[BUG] Type simpleType and simpleContent was unmarshalled as a String, not as an instance of the subclass which is generated by wsdl2ruby.rb. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/412" title="Type simpleType and simpleContent is unmarshalled as a String, not as an  ... (closed)">#412</a>)
78 </li><li>[BUG] ignore xsd:element definition when the same qname is also defined as a xsd:complexType. it's a workaround for this version. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/413" title="what if the same name would be used in one XML namespace for an element  ... (closed)">#413</a>)
79 </li><li>[BUG] wsdl2ruby.rb generated inconsistent class definition when the base class was :TYPE_ARRAY and the derived class was a :TYPE_STRUCT. let the derived class be a standalone (not a derived) class. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/424" title="wsdl2ruby.rb generates inconsistent class definition which derives an  ... (closed)">#424</a>)
80
81 </li><li>[BUG] wsdl2ruby.rb generates incomplete encoded Array mapping registry for base64Binary[]. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/428" title="wsdl2rb produces incomplete mapping (closed)">#428</a>)
82 </li><li>[BUG] LiteralMappingRegistryCreator did not generate an entry for the element which type is mapped to an Array. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/432" title="LiteralMappingRegistryCreator does not generate an entry for the element  ... (closed)">#432</a>)
83 </li></ul></li></ul><ul><li>SOAP
84 <ul><li>add :default_ns_tag option to configure a pre-defined Namespace tag. :default_ns is for configuring namespace definitions at SOAPEnvelope. :default_ns_tag is for configuring pre-defined namespace tag. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/383" title="let SOAP message use pre-defined namespace tag (closed)">#383</a>)
85 </li><li>login.live.com returns SOAPFault as a direct child of SOAPEnvelope. support it even though it's not spec compliant. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/384" title="login.live.com returns SOAPFault as a direct child of SOAPEnvelope (closed)">#384</a>)
86 </li><li>allow to remove mustUnderstand attribute from a SOAP Header. I heard that there's an implementation which cannot handle mustUnderstand existence. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/429" title="Removing env:mustUnderstand from header? (closed)">#429</a>)
87
88 </li><li>add the Generator option for using default namespace in SOAP message. it's for interoperability with non XML Namespace comformant implementation. false by default (same behavior as before.) you can turn it on with Driver#use_default_namespace = true or Server#use_default_namespace = true. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/430" title="add an option for forcing Generator use default namespace (closed)">#430</a>)
89 </li><li>[BUG] send xsi:nil=true element when literal + maxOccurs != 0 + nillable="true", not empty element. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/395" title="literal + nil + maxOccurs != 0 + nillable=&#34;true&#34; (closed)">#395</a>)
90 </li><li>[BUG] do not crash when parsing an incomplete multi-dimensional array. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/397" title="`traverse_data': undefined method `[]' for nil:NilClass (NoMethodError) (closed)">#397</a>)
91 </li><li>[BUG] do not dump xsi:type for non-polymorphic type of literal service. there's an implementation which only allows xsd:type for polymorphic type hint. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/405" title="should send xsd:type for document/literal service only if needed (closed)">#405</a>)
92 </li><li>[BUG] a content of the stub class which is generated as a subclass of String by wsdl2ruby.rb was not properly encoded. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/415" title="A content of the stub class which is generated as a subclass of String by  ... (closed)">#415</a>)
93 </li><li>[BUG] a value of XML attribute was not properly encoded. users who did XML-encode a value in SOAPElement#extraattr should care about this change (not needed from now.) (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/416" title="a value of XML attribute is not properly encoded (closed)">#416</a>)
94
95 </li><li>[BUG] XML encoding does not work properly depending on CES. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/417" title="XML encoding does not work properly depending on KCODE (closed)">#417</a>)
96 </li><li>[BUG] soap4r's XML namespace handler did not handle xmlns="" correctly. it means 'no default namespace'. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/421" title="xmlns=&#34;&#34; means 'no default namespace' (closed)">#421</a>)
97 </li><li>[BUG] multi-refed basetype value was not be able to decode with generated EncodedRegistry. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/423" title="cannot decode multi-refed basetype value with generated MappingRegistry (closed)">#423</a>)
98 </li><li>[BUG] unqualified element 'Envelope', 'Header', 'Body' and 'Fault' caused an error while parsing. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/431" title="unqualified element 'Envelope', 'Header', 'Body' and 'Fault' causes an  ... (closed)">#431</a>)
99 </li><li>[BUG] illegal marshaling a request for rpc/literal + parameter is a built-in basetype of XML Schema + message is defined as "type" (not "element"). fixed. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/434" title="illegal marshaling a request for rpc/literal + parameter is a built-in  ... (closed)">#434</a>)
100 </li></ul></li></ul><ul><li>SOAP/Ruby mapping
101 <ul><li>let MappingError be a NestedException and show original cause of MappingError. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/404" title="nested SOAP::Mapping::MappingError does not reported correctly (closed)">#404</a>)
102
103 </li><li>check illegal constant name before const_defined? call to avoid warnings. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/386" title="too many warnings about 'wrong constant name' from mapping.rb (closed)">#386</a>)
104 </li><li>added a header handler which utilize a mapping registry. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/425" title="HeaderHandler which utilize a mapping registry (closed)">#425</a>)
105 </li><li>[BUG] avoid NoMethodError when passing SOAPArray to LiteralRegistry. It's caused when a servant raised an exception in literal service. Thanks to Emil for contributing test case for it. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/393" title="NoMethodError when parsing the soap fault with the stack trace on the  ... (closed)">#393</a>)
106 </li><li>[BUG] allow the Fixnum which have an instance variable to be marshalled. For Fixnum, ivars are not marshalled but allowed to be marshalled in Ruby's marshal. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/406" title="Fixnum + instance variable causes MappingError (closed)">#406</a>)
107
108 </li><li>[BUG] a Driver generated by a WSDLDriverFactory did not handle nested sequence/choice correctly. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/409" title="WSDLDriverFactory does not handle nested sequence/choice correctly (closed)">#409</a>)
109 </li><li>[BUG] a Driver generated by a WSDLDriverFactory ignored 'xmlattr_*' value in a Hash parameter. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/414" title="a Driver generated by WSDLDriverFactory does not accept XML attributes in  ... (closed)">#414</a>)
110 </li><li>[BUG] let it be distinguishable &lt;ele attr=""&gt; from &lt;ele&gt; (no attribute in the element). now the former returns "" and the latter returns nil. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/418" title="cannot distinguish '' and nil as a value of XML attribute (closed)">#418</a>)
111 </li></ul></li></ul><ul><li>misc
112 <ul><li>added SOAP::WSDLDriverFactory#dump_method_signatures. it returns a formatted text which describes method signatures. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/141" title="SOAP::RPC::Driver#defined_webservice?   ... (closed)">#141</a>)
113
114 </li><li>added servletStubCreator. wsdl2ruby.rb with --servlet_stub creates servlet stub for WEBrick. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/290" title="wsdl2ruby.rb to auto-generate code for use with Webrick (closed)">#290</a>)
115 </li><li>wsdl2ruby.rb generated too much 'XSD::QName.new(...)' parts. let wsdl2ruby.rb/xsd2ruby.rb extract common namespace definitions as constants. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/381" title="wsdl2ruby.rb generates too much 'XSD::QName.new(...)'s in a file (closed)">#381</a>)
116 </li><li>let wsdl2ruby.rb/xsd2ruby.rb generate member types as a comment for each class in classdef file. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/384" title="login.live.com returns SOAPFault as a direct child of SOAPEnvelope (closed)">#384</a>)
117 </li><li>do not raise warning when there's a simpleType definition which have non-enumeration restriction. Generated mapping registry wrongly contained references to undefined classes. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/399" title="many warnings: cannot find mapped class (closed)">#399</a>)
118 </li><li>[BUG] as a workaround of class name crash problem between generated class and generated driver, add --drivername_postfix option to wsdl2ruby.rb. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/372" title="name crashes between types(classdef names) and services(driver names) in  ... (closed)">#372</a>)
119 </li><li>[BUG] soap4r without httpclient caused NameError. forgot to add required dependency in the previous release. (<a class="closed ticket" href="http://dev.ctor.org/soap4r/ticket/403" title="wsdl2ruby without httpclient causes NameError  ... (closed)">#403</a>)
120 </li></ul></li></ul>
121
122 <p>
123 Thanks to all of soap4r-ml members and soap4r users for their support.
124 And special thanks to following contributors;
125 </p>
126 <pre>
127 'Aaron Pfeifer' for contributing a patch for safemethodname.
128 'Andi Wundsam' for contributing a patch for net/http + no_proxy.
129 'anonymous contributor from Wall St.' for contributing a MSSOAP + Excel sample.
130 'Emil Marceta' for contributing a patch for one-way service support and many test cases that points a bug of soap4r.
131 'Ernie' for contributing a helloworld WSDL sample and WSDL service feature of HTTPServer.
132 'Felipe Contreras' for contributing an union + memberType sample, patches for missing 'require', and a patch to allow to customize default ns definition of SOAP Envelope.
133 'Greg Lappen' for contributing an eBaySvc sample.
134 'Ger Apeldoorn' for contributing a sample of complex type + MIME attachment.
135 'Jamie Herre' for contributing a SwA implementation.
136 'John Anderson' for contributing a patch for handling gzipped HTTP content.
137 'Junichi Uekawa' for contributing a HTTP redirection patch for net/http.
138 'Kent Sibilev' for contributing a patch for correct extraattr handling of SOAPHeaderItem.
139 'KR, Vesa Varimo' for contributing a patch for correct handling of XML Schema's choice element.
140 'Leoš Bitto' for contributing a patch for XML pretty print.
141 'Michael Neumann' for contributing an original implementation of standaloneServer.
142 'Oliver M. Bolzer' for contributing a patch for net/http + SSL.
143 'Owen Fraser-Green' for contributing a patch for MIME CRLF handling.
144 'Patrick Chanezon' for contributing a patch for wsdl2ruby classdef name option.
145 'Peter Gardfjäll' for contributing a patch for wsdl:fault handling.
146 'Sandi Metz' for contributing a patch for SwA in document/literal service.
147 'SHINAGAWA, Norihide' for contributing a patch for emx platform.
148 'Tadayoshi Funaba' for contributing a patch for date/time XMLSchema datatypes.
149 'UENO Katsuhiro' for xmlscan implementation.
150 'Walter Korman' for contributing soap4r.gemspec and a workaround patch for gem's require problem.
151 'wrex' for contributing a patch for soap4r to work with SalesForce service.
152 </pre>
153
154 <h2 id="install" name="install"><span class="content">2. Install</span></h2>
155
156 <p>
157 At first, see <a href="#dependencies">Dependencies</a> section.
158 You may need to install some extra packages.
159 Next, get the archived file of SOAP4R and extract it, then simply try;
160 </p>
161 <pre class="path">
162 $ ruby install.rb
163 </pre>
164
165 <p>
166 Necessary files will be installed to suitable directory.
167 </p>
168
169 <p>
170 Files and directories in lib directory are SOAP4R library program itself.
171 </p>
172
173 <dl>
174 <dt class="path">lib/</dt>
175 <dd>Libraries.</dd>
176
177 <dt class="path">sample/</dt>
178 <dd>SOAP4R samples.
179 See <a href="#samples">Samples</a> section.</dd>
180
181 <dt class="path">test/</dt>
182 <dd>Tests.  It also contains useful sample scripts for servers and clients.
183 <br/>
184 test/interopR2/ directory includes Clients/Server for
185 <a href="http://www.xmethods.net/ilab/">`SOAPBuilders Interoperability Lab.'</a>
186 Followings are advanced examples to use complex type transmit,
187 sending base64 encoded string, multi-dimensional array, and so on.
188 <ul>
189 <li>test/interopR2/server.rb is a RPC Server side implementation.</li>
190 <li>test/interopR2/client.rb is a RPC Client side implementation.</li>
191 <li>test/interopR2/base.rb includes common definitions for client/server.</li>
192 </ul>
193 </dd>
194 </dl>
195
196 <h2 id="uninstall" name="uninstall"><span class="content">3. Uninstall</span></h2>
197
198 <p>
199 Simply delete installed files.
200 </p>
201
202 <h2 id="whats" name="whats"><span class="content">4. What is SOAP4R?</span></h2>
203
204 <p>
205 'SOAP4R' is an implementation of
206 <a href="http://www.w3.org/TR/SOAP/">SOAP 1.1 (W3C Note)</a>.
207 </p>
208
209 <p>
210 Comments, information such as interoperability between SOAP4R and another implementation are welcomed.
211 Feel free sending mail to
212 <a href="mailto:nahi@ruby-lang.org" class="path">nahi@ruby-lang.org</a>.
213 </p>
214
215 <h2 id="dependencies" name="dependencies"><span class="content">5. Dependencies</span></h2>
216
217 <p>
218 SOAP4R is written in <a href="http://www.ruby-lang.org">Ruby</a> and aims to use with Ruby application.
219 You have to install ruby itself.  Tested against the following ruby versions.
220 </p>
221
222 <ul>
223   <li>ruby-1.8.5</li>
224   <li>ruby-1.8.5 patchlevel 52</li>
225   <li>ruby-1.8.6</li>
226   <li>ruby-1.8.6 patchlevel 36</li>
227 </ul>
228
229 <p>
230 SOAP4R depends on following Ruby modules in
231 <a href="http://raa.ruby-lang.org">RAA</a>.
232 You also have to install these modules to use SOAP4R.
233 </p>
234
235 <dl>
236 <dt class="path"><a href="http://raa.ruby-lang.org/project/httpclient/">[RAA:httpclient]</a> (2.1.0 or later) (required)</dt>
237 <dd>Yet another HTTP client implementation by NaHi.
238 httpclient is formerly known as http-access2.</dd>
239
240 <dt class="path"><a href="http://raa.ruby-lang.org/project/uconv/">[RAA:uconv]</a> (0.4.10) (not required but needed if your Ruby doesn't have iconv module and you need UTF-8 encoded Japanese chars)</dt>
241 <dd>by Yoshida Masato.
242 It is requred when you want automatic CES conversion between
243 SJIS &lt;-&gt; UTF8 and EUC &lt;-&gt; UTF8.
244 Note: SJIS &lt;-&gt; EUC uses NKF module which is in standard distribution.
245 </dd>
246
247 </dl>
248
249 <h2 id="samples" name="samples"><span class="content">6. Samples</span></h2>
250
251 <p>
252 Samples are in sample/ directory of distribution.
253 Some samples try to connect to public servers.
254 Set environment variable HTTP_PROXY if you are in a firewall and you have
255 http proxy to the internet like;
256 </p>
257 <pre class="path">
258 $ export HTTP_PROXY=http://myproxyserver:8080
259   or
260 $ setenv HTTP_PROXY http://myproxyserver:8080
261 </pre>
262
263 <h3><span class="content">basic/ ... basic samples</span></h3>
264
265     <dl>
266       <dt class="path">babelfish.rb</dt>
267       <dd>a SOAP client sample to connect to a babelfish server.</dd>
268       <dt class="path">whois.rb</dt>
269       <dd>a SOAP client sample to connect to a whois server.</dd>
270       <dt class="path">flickr.rb</dt>
271       <dd>a SOAP client sample to connect to the flickr SOAP server and extract data from XML response.</dd>
272       <dt class="path">yahooNewsSearch.rb</dt>
273       <dd>a HTTP client sample to connect to the Yahoo news search REST service and extract data from XML response.</dd>
274
275       <dt class="path">helloworld/</dt>
276       <dd>a SOAP server and client sample of 'Hello World'.
277           To run the server;
278 <pre class="path">
279 $ ./server.rb
280 </pre>
281           And to connect to the server, run the client;
282 <pre class="path">
283 $ ./client.rb
284 </pre>
285       </dd>
286
287       <dt class="path">calc/</dt>
288       <dd>Calc service contains 2 servers and 2 clients.
289         calc.rb is hosted by server.rb, calc2.rb is hosted by server2.rb.
290         client.rb is for server.rb, client2.rb is for server2.rb.
291         <dl>
292           <dt>calc.rb</dt>
293           <dd>Calc server definition using module and module methods.
294             This module responds 'add', 'sub', 'multi' and 'div'.
295           </dd>
296           <dt>server.rb</dt>
297           <dd>Standalone server.
298             It requires calc.rb and serve module methods of this module.
299             To run this server;
300 <pre class="path">
301 $ ./server.rb
302 </pre>
303           </dd>
304           <dt>server.cgi</dt>
305           <dd>CGI version.
306             To run this server, copy server.cgi and calc.rb to suitable
307             directory of your WWW server.
308           </dd>
309           <dt>client.rb</dt>
310           <dd>It connects to server.rb or server.cgi,
311             and hit methods served by calc.rb.
312             To run the client;
313 <pre class="path">
314 $ ./client.rb
315 </pre>
316             Is it stacked?  Did you run the server.rb?<br/>
317             Turn logger and wireDumpDev in its source on to see logs and wire
318             dumps of SOAP transport.
319           </dd>
320           <dt>calc2.rb</dt>
321           <dd>Calc server definition using class and instance methods.
322             An instance of this class holds its value.  Methods 'set' and 'get'
323             is to set/get the value.
324             It also responds to '+', '-', '*', and '/'.
325           </dd>
326           <dt>server2.rb</dt>
327           <dd>It requires calc2.rb and creates an instance of CalcService2
328             that responds all SOAP requests.
329             Since '+', '-' and so on of calc2.rb are not valid name as an
330             element in XML instance, this sample register the method '+' as
331             'add', '-' as 'sub', and so on.
332           </dd>
333           <dt>server2.cgi</dt>
334           <dd>CGI version.
335             To run this server, copy server2.cgi and calc2.rb to suitable
336             directory of your WWW server.
337           </dd>
338           <dt>client2.rb</dt>
339           <dd>It connects to server2.rb or server2.cgi.
340             Set a value at first and call methods like 'puts objAtServer + 2'.
341           </dd>
342         </dl>
343       </dd>
344
345       <dt class="path">exchange/</dt>
346       <dd>A sample to retrieve the currency rate from public SOAP service.
347         <dl>
348           <dt>iExchange.rb</dt>
349           <dd>It includes common definitions for client and server of
350             Exchange service.  Including only a definition of namespace URI of
351             this service.</dd>
352           <dt>exchange.rb</dt>
353           <dd>Definition of servant class ExchangeService which returns the
354             currency rate after connecting to another site by SOAP to get the
355             real rate.
356             So that this class is the SOAP server for local client and
357             is also a SOAP client for public server.
358             An instance of this class is hosted by server.rb.
359             The instance responds to only 'getRate' which receives two country
360             code such as 'USA' and 'Japan'.</dd>
361           <dt>server.rb</dt>
362           <dd>It requires exchange.rb and creates an instance of
363             ExchangeService that responds all SOAP requests.
364             To run this server;
365 <pre class="path">
366 $ ./server.rb
367 </pre>
368           </dd>
369           <dt>server.cgi</dt>
370           <dd>CGI version.  To run this server, copy server.cgi and exchange.rb
371             to suitable directory of your WWW server.</dd>
372           <dt>client.rb</dt>
373           <dd>It connects to server.rb.  Turn logger and wireDumpDev in its
374             source on to see logs and wire dumps of SOAP transport.
375             To run the client;
376 <pre class="path">
377 $ ./client.rb
378 </pre>
379           </dd>
380         </dl>
381       </dd>
382
383       <dt class="path">sampleStruct/</dt>
384       <dd>A sample to transmit complex structured object which has recursive
385         object reference.
386         <dl>
387           <dt>iSampleStruct.rb</dt>
388           <dd>It includes common definitions for client and server of
389             SampleStruct service.  Definition of SampleStruct class and
390             namespace URI of this service.</dd>
391           <dt>sampleStruct.rb</dt>
392           <dd>Definition of servant class SampleStructService.
393             An instance of this class is hosted by server.rb.
394             The instance responds to only 'hi' which receives a SampleStruct
395             and wraps it in the new instance of SampleStruct to return .</dd>
396           <dt>server.rb</dt>
397           <dd>It requires sampleStruct.rb and creates an instance of
398             SampleStructService that responds all SOAP requests.
399             To run this server;
400 <pre class="path">
401 $ ./server.rb
402 </pre>
403           </dd>
404           <dt>server.cgi</dt>
405           <dd>CGI version.  To run this server, copy server.cgi and
406             sampleStruct.rb to suitable directory of your WWW server.</dd>
407           <dt>client.rb</dt>
408           <dd>It connects to server.rb.  Turn logger and wireDumpDev in its
409             source on to see logs and wire dumps of SOAP transport.
410             To run the client;
411 <pre class="path">
412 $ ./client.rb
413 </pre>
414           </dd>
415         </dl>
416       </dd>
417
418       <dt class="path">wsdl_helloworld/</dt>
419       <dd>A sample 'Hello World' SOAP client and server which utilize WSDL.
420       See wsdl_helloworld/README for more detail</dd>
421     </dl>
422
423 <h3><span class="content">payload/ ... various payload configuration</span></h3>
424
425     <dl>
426       <dt class="path">basicauth/</dt>
427       <dd>BasicAuth server and client sample.</dd>
428
429       <dt class="path">cookies/</dt>
430       <dd>HTTP-Cookies server and client sample.</dd>
431
432       <dt class="path">ssl/</dt>
433       <dd>SSL SOAP server and client samples.
434         <dl>
435           <dt class="path">sslserver.rb</dt>
436           <dd>SSL server sample which hosts "hello world" service.
437             This server uses SSL server certificate in files/ directory
438             (SSL client should check this certificate for SSL server
439             authentication).</dd>
440           <dt class="path">sslserver_noauth.rb</dt>
441           <dd>This server generates SSL server certificate
442             at runtime.  No security.</dd>
443           <dt class="path">sslserver_require_clientauth.rb</dt>
444           <dd>This server users SSL server certificate in files/ directory
445             and requires SSL client authentication (clients must
446             have SSL client certificate and send it to the server).</dd>
447           <dt class="path">sslclient.rb</dt>
448           <dd>SSL client sample which calls "hello world" service via HTTPS.
449             This client checks SSL server certificate sent from SSL server.</dd>
450           <dt class="path">sslclient_require_noserverauth.rb</dt>
451           <dd>This client does not check SSL server certificate.
452             No security.</dd>
453           <dt class="path">sslclient_with_clientauth.rb</dt>
454           <dd>This client sends SSL client certificate in files/ directory
455             and checks SSL server certificate.</dd>
456         </dl>
457       </dd>
458
459       <dt class="path">gzipped/</dt>
460       <dd>gzipped content negotiation server and client sample.</dd>
461     </dl>
462
463 <h3><span class="content">soapheader/ ... SOAPHeader configuration</span></h3>
464
465     <dl>
466       <dt class="path">authheader/</dt>
467       <dd>It contains a sample to utilize SOAP Header handler.  Send
468         userid/passwd and receive sessionid via SOAP Header</dd>
469
470       <dt class="path">soapext_basicauth/</dt>
471       <dd>It contains a sample to do BasicAuth in SOAPHeader.  (http://soap-authentication.org/basic/2001/10/)</dd>
472     </dl>
473
474 <h3><span class="content">attachment/ ... SOAP with Attachment (SwA)</span></h3>
475
476     <dl>
477       <dt class="path">swa/</dt>
478       <dd>SOAP server and client sample of SwA (SOAP with Attachments).</dd>
479
480       <dt class="path">complexmime/</dt>
481       <dd>SOAP server and client sample of Complex Type + SwA</dd>
482     </dl>
483
484 <h3><span class="content">howto/ ... various other configuration</span></h3>
485
486     <dl>
487       <dt class="path">as_xml/</dt>
488       <dd>Sample client to send a request with XML, and receive a response as XML.</dd>
489
490       <dt class="path">base64/</dt>
491       <dd>Sample client to send/receive base64 data.</dd>
492
493       <dt class="path">documentliteral/</dt>
494       <dd>Sample client and server of document/literal service.  See README.txt in this directory to run this sample.</dd>
495
496       <dt class="path">filter/</dt>
497       <dd>Sample client and server of filtering request/response before sending/receiving.</dd>
498
499       <dt class="path">scopesample/</dt>
500       <dd>SOAP server sample which shows a different behavior of SOAP server scope settings; Request scope vs Application scope.
501         sample/soap/scopesample/servant.rb is a servant which holds push-ed
502         object that can be pop-ed afterward.
503         See sample/soap/scopesample/server.rb how to define a servant as
504         a Request scope servant or an Application scope servant.
505         Application scope servant works as we expected because the servant
506         object is living from beginning to the time server terminated.
507         In contrast, request scope servant(s) does not work because a servant
508         object is created for each request.
509       </dd>
510
511       <dt class="path">styleuse/</dt>
512       <dd>Sample client and server of SOAP style and use combination, especially rpc/literal and document/encoded.</dd>
513
514       <dt class="path">wsdl_fault/</dt>
515       <dd>Sample client and server of handling SOAP fault specified in a WSDL.  See wsdl_fault/README.txt for more detail.</dd>
516
517       <dt class="path">wsdl_hash/</dt>
518       <dd>Sample client and server of sending/receiving Hash struct defined in a WSDL.</dd>
519     </dl>
520
521 <h3><span class="content">marshal/ ... object &lt;-&gt; XML marshalling</span></h3>
522
523     <dl>
524       <dt class="path">digraph.rb</dt>
525       <dd>A sample of SOAP marshalling/unmarshalling.
526         It creates a digraph that contains multi-ref-ed nodes at first
527         and marshals this object to get serialized XML instance.
528         Then reads and unmarshals this XML instance to recover a object
529         which has the same links among nodes in the digraph.
530       </dd>
531
532       <dt class="path">customfactory.rb</dt>
533       <dd>Sample program for customizing mapping registry.</dd>
534
535       <dt class="path">enum/</dt>
536       <dd>Sample program to demonstrate how xsd2ruby.rb works.</dd>
537     </dl>
538
539 <h3><span class="content">showcase/ ... showcase sample to demonstrate</span></h3>
540
541     <dl>
542       <dt class="path">raa2.4/</dt>
543       <dd>sample/soap/raa2.4/sample.rb is a sample client to retrieve project
544         information on RAA.  It uses raaDriver.rb which is generated by
545         wsdl2ruby.rb from WSDL at
546         <a href="http://www.ruby-lang.org/xmlns/soap/interface/RAA/0.0.4/">http://www.ruby-lang.org/xmlns/soap/interface/RAA/0.0.4/</a>.
547         You'll find wsdlDriver.rb in sample/wsdl/raa2.4/wsdlDriver.rb which
548         loads the WSDL at runtime to connect.</dd>
549
550       <dt class="path">icd/</dt>