1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
|
<HTML lang=en dir=ltr xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<HEAD>
<TITLE>Calling a Web Service from Tcl</TITLE>
<link rel="stylesheet" href="style.css" type="text/css" media="screen">
</HEAD>
<BODY>
<H1 class=firstHeading>Calling a Web Service from Tcl</H1>
<HR>
<TABLE class=toc id=toc>
<TR>
<TD>
<H2>Contents</H2></DIV>
<UL>
<LI class=toclevel-1><A href="#Overview"><SPAN class=tocnumber>1</SPAN> <SPAN class=toctext>Overview</SPAN></A>
<LI class=toclevel-1><A href="#Loading_the_Webservices_Client_Package"><SPAN
class=tocnumber>2</SPAN> <SPAN class=toctext>Loading the Webservices
Client Package</SPAN></A>
<LI class=toclevel-1><A href="#Quering_a_remote_Web_Services_Server_for_its_WSDL_and_parsing_it"><SPAN
class=tocnumber>3</SPAN> <SPAN class=toctext>Quering a remote Web
Services Server for its WSDL and parsing it</SPAN></A>
<LI class=toclevel-1><A href="#Parsing_a_saved_WSDL"><SPAN
class=tocnumber>4</SPAN> <SPAN class=toctext>Parsing a saved
WSDL</SPAN></A>
<LI class=toclevel-1><A href="#Loading_a_pre-parsed_WSDL"><SPAN
class=tocnumber>5</SPAN> <SPAN class=toctext>Loading a pre-parsed
WSDL</SPAN></A>
<LI class=toclevel-1><A href="#Defining_a_REST_service"><SPAN
class=tocnumber>6</SPAN>
<SPAN class=toctext>Defining a REST based service by hand</SPAN></A>
<LI class=toclevel-1><A href="#Transforms"><SPAN
class=tocnumber>7</SPAN>
<SPAN class=toctext>Defining Transforms</SPAN></A>
<LI class=toclevel-1><A href="#Synchronous_Call_returning_a_dictionary_object"><SPAN
class=tocnumber>8</SPAN> <SPAN class=toctext>Synchronous Call returning
a dictionary object</SPAN></A>
<LI class=toclevel-1><A href="#Asynchronous_Call_with_separate_success_and_error_callbacks"><SPAN
class=tocnumber>9</SPAN> <SPAN class=toctext>Asynchronous Call with
separate success and error callbacks</SPAN></A>
<LI class=toclevel-1><A href="#Creation_of_stub_Tcl_procedures_to_make_synchronous_calls"><SPAN
class=tocnumber>10</SPAN> <SPAN class=toctext>Creation of stub Tcl
procedures to make synchronous calls</SPAN></A>
<LI class=toclevel-1><A href="#Synchronous_Call_returning_the_raw_XML"><SPAN
class=tocnumber>11</SPAN> <SPAN class=toctext>Synchronous Call returning
the raw XML</SPAN></A> </li>
<li class="toclevel-1"><a href="#Config"><span class="tocnumber">12</span>
<span class="toctext">Configuring Services</span></a> </LI>
<li class="toclevel-1"><a href="#TypeCasting"><span class="tocnumber">13</span>
<span class="toctext">Dealing With Casting Abstract Types to Concrete Types</span></a> </LI>
</UL></TD></TR></TBODY></TABLE>
<P>
</P>
<A name=Overview></A>
<H2>Overview </H2>
<P>The Webservices Client package provides a several ways to define what
operations a remote Web Services Server provides and how to call those
operations. It also includes several ways to call an operation. </P>
<P>The following ways are provided to define remote operations: </P>
<UL>
<LI>Loading a pre-parsed WSDL
</li><li>Quering a remote Web Services Server for its WSDL and parsing it
</li><li>Parsing a saved WSDL </li></ul>
<ul><li>Defining a REST based service by hand </li></ul>
<P>The parsed format is much more compact than the XML of a WSDL. </P>
<P>The following ways are provided to directly call an operation of a Web
Service Server: </P>
<UL>
<LI>Synchronous Call returning a dictionary object
<LI>Synchronous Call returning the raw XML
<LI>Asynchronous Call with separate success and error callbacks
<LI>Creation of stub Tcl procedures to make synchronous calls </LI></UL>
<p>This package makes use of the <b>log</b> package from <b>TclLib</b>. In particular the following levels are used:
</p><ul>
<li>error/warning -- errors encountered when parsing a WSDL. Actual level depends on options that are set in the <b>::WS::Utils</b> package.
</li><li>info -- HTTP calls, including the XML, made to invoke operations and the replies received. <i>Introduced in 2.2.8.</i>
</li><li>debug -- detailed internal information. This should only be used if you want to code dive into the TclWs package internals.
</li></ul>
<A name=Loading_the_Webservices_Client_Package></A>
<H2>Loading the Webservices Client Package </H2>
<P>To load the webservices server package, do: </P><PRE> package require WS::Client
</PRE>
<P>This command will only load the utilities the first time it is used, so it
causes no ill effects to put this in each file using the utilties. </P>
<HR>
<A name=Quering_a_remote_Web_Services_Server_for_its_WSDL_and_parsing_it></A>
<H2>Quering a remote Web Services Server for its WSDL and parsing it </H2>
<P><B>Procedure Name : <I>::WS::Client::GetAndParseWsdl</I></B> </P>
<P><B>Description : Fetch the WSDL file from the given URL, aprse it and create the service.</B> </P>
<P><B>Arguments :</B> </P><PRE>
<I>url</I> - The url of the WSDL
<I>headers</I> - Extra headers to add to the HTTP request. This
<I></I> is a key value list argument. It must be a list with
<I></I> an even number of elements that alternate between
<I></I> keys and values. The keys become header field names.
<I></I> Newlines are stripped from the values so the header
<I></I> cannot be corrupted.
<I></I> This is an optional argument and defaults to {}.
<I>serviceAlias</I> - Alias (unique) name for service.
<I></I> This is an optional argument and defaults to the name of the
<I></I> service in serviceInfo.
<I>serviceNumber</I> - Number of service within the WSDL to assign the
<I></I> serviceAlias to. Only recognized with a serviceAlias.
<I></I> First service (default) is addressed by value "1".
</PRE>
<p>The following example WSDL snipped defines two services:</p>
<pre>
>definitions ...<
>service name="service1"<
...
>/service<
>service name="service1"<
...
>/service<
>/definitions<
</pre>
<p>Using an empty or no <I>serviceAlias</I> would result in the creation of the services "service1" and "service2".</p>
<p>Using <i>serviceAlias</i>="SE" and <i>serviceNumber</i>=2 would result in the creation of the service "SE" containing the "service2" of the WSDL.</p>
<P><B>Returns : The parsed service definition</B> </P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions : None</B> </P>
<P><B>Pre-requisite Conditions : None</B> </P>
<HR>
<A name=Parsing_a_saved_WSDL></A>
<H2>Parsing a saved WSDL </H2>
<P><B>Procedure Name : <I>::WS::Client::ParseWsdl</I></B> </P>
<P><B>Description : Parse a WSDL and create the service. Create also the stubs if specified.</B> </P>
<P><B>Arguments :</B> </P><PRE> <I>wsdlXML</I> - XML of the WSDL
</PRE>
<P><B>Optional Arguments:</B> </P>
<PRE>
<i>-createStubs</i> 0|1 - create stub routines for the service
<i>-headers</i> - Extra headers to add to the HTTP request. This
<i></i> is a key value list argument. It must be a list with
<i></i> an even number of elements that alternate between
<i></i> keys and values. The keys become header field names.
<i></i> Newlines are stripped from the values so the header
<i></i> cannot be corrupted.
<i></i> This is an optional argument and defaults to {}.
<i>-serviceAlias</i> - Alias (unique) name for service.
<i></i> This is an optional argument and defaults to the name of the
<i></i> service in serviceInfo.
<I>serviceNumber</I> - Number of service within the WSDL to assign the
<I></I> serviceAlias to. Only recognized with a serviceAlias.
<I></I> First service (default) is addressed by value "1".
</PRE>
<p>The arguments are position independent.</p>
<p>For an example use of <i>serviceAlias</i> and <i>serviceNumber</i>, see <a href="#Quering_a_remote_Web_Services_Server_for_its_WSDL_and_parsing_it">the chapter above</a>.</p>
<P><B>Returns : The parsed service definition</B> </P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions :None</B> </P>
<P><B>Pre-requisite Conditions : None</B> </P>
<HR>
<A name=Loading_a_pre-parsed_WSDL></A>
<H2>Loading a pre-parsed WSDL </H2>
<P><B>Procedure Name : <I>::WS::Client::LoadParsedWsdl</I></B> </P>
<P><B>Description : Load a saved service definition in</B> </P>
<P><B>Arguments :</B> </P><PRE> <I>serviceInfo</I> - parsed service definition, as returned from
<I>::WS::Client::ParseWsdl</I> or <I>::WS::Client::GetAndParseWsdl</I>
<I>headers</I> - Extra headers to add to the HTTP request. This
is a key value list argument. It must be a list with
an even number of elements that alternate between
keys and values. The keys become header field names.
Newlines are stripped from the values so the header
cannot be corrupted.
This is an optional argument and defaults to {}.
<I>serviceAlias</I> - Alias (unique) name for service.
This is an optional argument and defaults to the name of the
service in serviceInfo.
</PRE>
<P><B>Returns : The name of the service loaded</B> </P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions : None</B> </P>
<P><B>Pre-requisite Conditions : None</B> </P>
<HR>
<A name=Defining_a_REST_service></A>
<H2>Defining a REST based service by hand </H2>
<BR>
<H3>Service Definition</H3>
<P><B>Procedure Name : <I>::WS::Client::CreateService</I></B> </P>
<P><B>Description : Define a REST service</B> </P>
<P><B>Arguments :</B> </P><PRE>
<I>serviceName</I> - Service name to add namespace to
<I>type</I> - The type of service, currently only <B>REST</B> is supported.
<I>url</I> - URL of namespace.
<I>args</I> - Optional arguments:
This is an optional argument and defaults to the name of the
<I>-header</I> httpHeaderList.
</PRE>
<P><B>Returns : The local alias (tns)</B> </P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions : None</B> </P>
<P><B>Pre-requisite Conditions : None</B> </P>
<H3>Method Definition</H3>
<P><B>Procedure Name : <I>::WS::Client::DefineRestMethod</I></B> </P>
<P><B>Description : Define a method on a REST service</B> </P>
<P><B>Arguments :</B> </P><PRE>
<I>serviceName</I> - Service name to add namespace to
<I>methodName</I> - The name of the method to add.
<I>returnType</I> - The type, if any returned by the procedure. Format is:
xmlTag <I>typeInfo</I>.
<i>inputArgs</i> - List of input argument definitions where each argument
definition is of the format: name typeInfo.
where, <I>typeInfo</I> is of the format <B>{</B>type typeName comment commentString<B>}</B>
</PRE>
<P><B>Returns : The current service definition </B> </P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions : None</B> </P>
<P><B>Pre-requisite Conditions : None</B> </P>
<HR>
<A name=Transforms></A>
<H2>Defining Transforms </H2>
<P><B>Procedure Name : <I>::WS::Client::SetServiceTransforms</I></B> </P>
<P><B>Description : Define a service's transforms</B>
<PRE>
Transform signature is:
cmd serviceName operationName <I>transformType</I> xml {url {}} {argList {}}
where <I>transformType</I> is <B>REQUEST</B> or <B>REPLY</B>
and url and argList will only be present for <I>transformType</I> == <B>REQUEST</B>
</PRE> </P>
<P><B>Arguments :</B> </P><PRE>
<I>serviceName</I> - The name of the Webservice
<I>inTransform</I> - Input transform <I>cmd</I>, defaults to {}.
The inTransform is the proc which allows to transform the SOAP output message, which will be input in the server.
<I>outTransform</I> - Output transform<I>cmd</I>, defaults to {}.
The outTransform is the proc which allows to transform the SOAP input message, which is the answer of the server.
</PRE>
<P><B>Returns : None</B></P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions : None</B> </P>
<P><B>Pre-requisite Conditions : Service must have been defined.</B> </P>
<HR>
<A name=Synchronous_Call_returning_a_dictionary_object></A>
<H2>Synchronous Call returning a dictionary object </H2>
<P><B>Procedure Name : <I>::WS::Client::DoCall</I></B> </P>
<P><B>Description : Call an operation of a web service</B> </P>
<P><B>Arguments :</B> </P><PRE> <I>serviceName</I> - The name of the Webservice
<I>operationName</I> - The name of the Operation to call
<I>argList</I> - The arguements to the operation as a dictionary object
This is for both the Soap Header and Body messages.
<I>headers</I> - Extra headers to add to the HTTP request. This
is a key value list argument. It must be a list with
an even number of elements that alternate between
keys and values. The keys become header field names.
Newlines are stripped from the values so the header
cannot be corrupted.
This is an optional argument and defaults to {}.
</PRE>
<P><B>Returns :</B> </P>
<PRE> The return value of the operation as a dictionary object.
This includes both the return result and any return headers.
</PRE>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions :</B> </P><PRE> <B>WSCLIENT HTTPERROR</B> - if an HTTP error occured
others - as raised by called Operation
</PRE>
<P><B>Pre-requisite Conditions : Service must have been defined.</B> </P>
<HR>
<A name=Asynchronous_Call_with_separate_success_and_error_callbacks></A>
<H2>Asynchronous Call with separate success and error callbacks </H2>
<P><B>Procedure Name : <I>::WS::Client::DoAsyncCall</I></B> </P>
<P><B>Description : Call an operation of a web service asynchronously</B>
</P>
<P><B>Arguments :</B> </P><PRE> <I>serviceName</I> - The name of the Webservice
<I>operationName</I> - The name of the Operation to call
<I>argList</I> - The arguements to the operation as a dictionary object
This is for both the Soap Header and Body messages.
<I>succesCmd</I> - A command prefix to be called if the operations
does not raise an error. The results, as a dictionary
object are concatinated to the prefix. This includes
both the return result and any return headers. Leave
empty to not call any function.
<I>errorCmd</I> - A command prefix to be called if the operations
raises an error. The error code, stack trace and
error message are concatinated to the prefix. Leave
empty to not call any function.
<I>headers</I> - Extra headers to add to the HTTP request. This
is a key value list argument. It must be a list with
an even number of elements that alternate between
keys and values. The keys become header field names.
Newlines are stripped from the values so the header
cannot be corrupted.
This is an optional argument and defaults to {}.
</PRE>
<P><B>Returns : Nothing.</B> </P>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions :</B> </P><PRE> WSCLIENT HTTPERROR - if an HTTP error occured
others - as raised by called Operation
</PRE>
<P><B>Pre-requisite Conditions : Service must have been defined.</B> </P>
<HR>
<A name=Creation_of_stub_Tcl_procedures_to_make_synchronous_calls></A>
<H2>Creation of stub Tcl procedures to make synchronous calls </H2>
<P><B>Procedure Name : <I>::WS::Client::CreateStubs</I></B> </P>
<P><B>Description : Create stubs routines to make calls to Webservice
Operations.</B> </P><PRE> All routines will be create in a namespace that is the same
as the service name. The procedure name will be the same
as the operation name.
</PRE><PRE> <B>NOTE</B> -- Webservice arguments are position independent, thus
the proc arguments will be defined in alphabetical order.
</PRE>
<P><B>Arguments :</B> </P><PRE> <I>serviceName</I> - The service to create stubs for
</PRE>
<P><B>Returns : A string describing the created procedures.</B> </P>
<P><B>Side-Effects : Existing namespace is deleted.</B> </P>
<P><B>Exception Conditions : None</B> </P>
<P><B>Pre-requisite Conditions : Service must have been defined.</B> </P>
<HR />
<A name=Synchronous_Call_returning_the_raw_XML></A>
<H2>Synchronous Call returning the raw XML </H2>
<P><B>Procedure Name : <I>::WS::Client::DoRawCall</I></B> </P>
<P><B>Description : Call an operation of a web service</B> </P>
<P><B>Arguments :</B> </P><PRE> <I>serviceName</I> - The name of the Webservice
<I>operationName</I> - The name of the Operation to call
<I>argList</I> - The arguements to the operation as a dictionary object
This is for both the Soap Header and Body messages.
<I>headers</I> - Extra headers to add to the HTTP request. This
is a key value list argument. It must be a list with
an even number of elements that alternate between
keys and values. The keys become header field names.
Newlines are stripped from the values so the header
cannot be corrupted.
This is an optional argument and defaults to {}.
</PRE>
<P><B>Returns :</B> </P><PRE> The XML of the operation.
</PRE>
<P><B>Side-Effects : None</B> </P>
<P><B>Exception Conditions :</B> </P><PRE> <B>WSCLIENT HTTPERROR</B> - if an HTTP error occured
</PRE>
<P><B>Pre-requisite Conditions : Service must have been defined.</B> </P>
<HR />
<p><a name="Template"></a>
</p><h2>Generating a Template Dictionary</h2>
<p><b>Procedure Name : <i>::WS::Utils::GenerateTemplateDict</i></b> </p>
<p><b>Description : Generate a template dictionary object for a given type.</b> </p>
<p><b>Arguments :</b> </p>
<pre>
<i>mode</i> - The mode, <b>Client</b> or <b>Server</b>
<i>serviceName</i> - The name of the Webservice
<i>type</i> - The name of the type
<i>arraySize</i> - Number of elements to generate in an array. Default is 2
<ul>
</pre>
<p><b>Returns :</b> </p><pre>A dictionary object for a given type. If any circular references exist, they will have the value of <** Circular Reference **>
<p><b>Side-Effects : None</b> </p>
<p><b>Exception Conditions : None</b> </p>
<p><b>Pre-requisite Conditions : Service must have been defined.</b> </p></pre><p></p>
<HR />
<p><a name="Config"></a>
</p><h2>Configuring a Service </h2>
There are two procedures to configure a service:
<ul>
<li>::WS::Client::SetOption</li>
<li>::WS::Client::Config</li>
</ul>
<p>The first procedure contains the default options of the package.
The default options are used on service creation and are then copied to the service.</p>
<p>The second procedure contains the options of each service.
They are copied on service creation from the default options.</p>
<p>Most option items may be accessed by both functions.
Some options are only used on service creation phase, which do not exist as service option.
Other options do not exist as default option, as they are initialized from the WSDL file.</p>
<p>In the following, first the two access routines are described.
Then, a list of options for both functions are given, with remarks, if they are only valid for one of the two procedures.</p>
<p><b>Procedure Name : <i>::WS::Client::SetOption</i></b> </p>
<p><b>Description : Get or set the default options of the package</b> </p>
<p><b>Arguments :</b> </p>
<pre>
<i>-globalonly</i> - Return a list of global-only options and their values.
<i></i> Global-only options are not copied to the service.
<i>-defaultonly</i> - Return a list of default-only options and their values.
<i></i> default-only options are copied to the service.
<i>--</i> - End of options
<i>item</i> - The option item to get or configure.
<i></i> Return a list of all item/value pairs if ommitted.
<i>value</i> - The value to set the option item to.
<i></i> Return current value if omitted.
</pre>
<p><b>Procedure Name : <i>::WS::Client::Config</i></b> </p>
<p><b>Description : Get or set the options local to a service definition</b> </p>
<p><b>Arguments :</b> </p>
<pre>
<i>serviceName</i> - The name of the Webservice.
<i></i> Return a list of default items/values paires if not given.
<i>item</i> - The option item to get or configure.
<i></i> Return a list of all item/value pairs, if not given.
<i>value</i> - The value to set the option item to.
<i></i> Return current value if omitted.
</pre>
<p><b>Option List:</b> </p>
<ul>
<li><pre>allowOperOverloading</pre>
<p>An overloaded operation is an operation with the same name but different may exist with different input parameter sets.</p>
<p>This option throws an error, if a WSDL is parsed with an overloaded operation.</p>
Default: 1</li>
<li><pre>contentType</pre>
The http content type of the http request sent to call the web service.<br />
Default: "text/xml;charset=utf-8"</li>
<li><pre>errorOnRedefine</pre>
<p>Throw an error, if a service is created (CreateService etc) for an already existing service.</p>
<p>Default value: 0</p>
<p>This item may not be used with <i>::WS::Client::Config</i>.</p>
</li>
<li><pre>genOutAttr</pre>
generate attributes on outbound tags, see <A HREF="Using_Options.html#genOutAttr">here</A> for details</li>
<li><pre>inlineElementNS</pre>
<p>Namespace prefixes for types may be defined within the WSDL root element.</p>
<p>This item may not be used with <i>::WS::Client::Config</i>.</p>
<p>Activate this option, to also search namespace prefixes in the type definition.
As those are seen as global prefixes, there might be a double-used prefix which will cause a processing error, if different URI's are assigned.</p>
<p>The error would be caused by a WSDL as follows</p>
<pre>
<wsdl:definitions targetNamespace="http://www.webserviceX.NET/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/
xmlns:q1="myURI1"
...>
...
<xs:element xmlns:q1="myURI2" type="q1:MessageQ1"/>
</pre>
</li>
<li><pre>location</pre>
<p>The URL of the service. This is initialized on the value in the WSDL file, when the WSDL file is parsed. The value may be overwritten setting this option.</p>
<p>This item may not be used with <i>::WS::Client::SetOption</i>.</p>
</li>
<li><pre>noTargetNs</pre>
The target namespace URI is normally included twice in the envelope of the webservice call:<br />
<pre>
<SOAP-ENV:Envelope
...
xmlns="http://targeturi.org/"
xmlns:tns1="http://targeturi.org/"
...>
</pre>
Setting this option to 1 suppresses the line with "xmlns=".
<br />This option was set to call a service published by SAP.
<br />Default value: 0</li>
<li><pre>nsOnChangeOnly</pre>
only put namespace prefix when namespaces change</li>
<li><pre>parseInAttr</pre>
parse attributes on inbound tags, see <A HREF="Using_Options.html#parseInAttr">here</A> for details</li>
<li><pre>queryTimeout</pre>
Timeout to any network query in ms. Default value: 60000 (1 minuite).
The <A HREF="Using_Options.html#queryTimeout">utility package</a> has an option with the same functionality, which is used, when there is no call option context.
</li>
<li><pre>skipHeaderLevel</pre>
boolean indicating the first level of the XML in a request header <i><b>shall be</b></i> skipped. Derived from options. Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
<li><pre>skipLevelOnReply</pre>
boolean indicating the first level of the XML in a reply <i><b>may be</b></i> skipped. Derived from options. Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
<li><pre>skipLevelWhenActionPresent</pre>
boolean indicating if the first level of the XML is to be skipped. Derived from options. Default is 0 (do not skip).</li>
<li><pre>suppressNS (default: empty string)</pre>
do not put a particular namespace prefix</li>
<li><pre>suppressTargetNS</pre>
<p>Do not add the Target Namespace URI prefix "tns1" to all parameters in the webservice call XML.</p>
<p>As an example, the XML is modified from (option not set):
<pre>
<SOAP-ENV:Envelope ...
xmlns:tns1="http://targeturi.org/"
... >
<SOAP-ENV:Body>
<tns1:CalledMethod>
<tns1:Parameter1>Value;/tns1:Parameter1>
</tns1:CalledMethod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>
to (option set)
<pre>
<SOAP-ENV:Envelope ...
xmlns:tns1="http://targeturi.org/"
... >
<SOAP-ENV:Envelope ...
<SOAP-ENV:Body>
<tns1:CalledMethod>
<Parameter1>Value;/Parameter1>
</tns1:CalledMethod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>
</p>
Derived from options.
<br />Internally, this option sets the option "suppressNS" to "tns1".
<br />This option was set to call a service published by SAP.
<br />This option made a call to a certain MS Web Service fail with the error message: "Input parameter 'Parameter1' can not be NULL or Empty.".
<br />Default is 0 (do not suppress).
</li>
<li><pre>targetNamespace (default: empty string)</pre>
<p>the target namespace of the service, derived from the WSDL.</p>
<p>This item may not be used with <i>::WS::Client::SetOption</i>.</p>
</li>
<li><pre>UseNS (default: empty string)</pre>
See <A HREF="Using_Options.html#UseNS">here</A>
</li>
<li><pre>useTypeNS (default: empty string)</pre>
use type's namespace prefix as prefix of elements</li>
<li><pre>valueAttrCompatiblityMode (default: 1)</pre>
If this and genOutAttr/parseInAttr are set, then values are specified in the dictionary as {}. Otherwise if genOutAttr/parseInAttr is set this is not set, then the values are specified in the dictionary as ::value.</li>
</ul>
<pre>
<i>value</i> - Optional, the new value.
</pre>
<p><b>Returns :</b> </p><pre> The value of the item.
<p><b>Side-Effects : None</b> </p>
<p><b>Exception Conditions : None</b> </p>
<p><b>Pre-requisite Conditions : Service must have been defined.</b> </p></pre><p></p>
<p><a name="TypeCasting"></a>
</p><h2>Dealing With Casting Abstract Types to Concrete Types </h2>
<p>
If you turn on <i>parseInAttr</i> and <i>genOutAttr</i>, the system will
semi-automatically deal with casting of elements declared as a being of a
type that is an abstract type to/from the concrete type actually to be used
in a message. On an element that is decleared to be a type which is an
abstract type, the value of the <b>::type</b> key in the dictionary will
specify the concrete type to be actually used (or for a reply message the
concrete type that was actually used).
</p>
<p>
<B>NOTE:</B> While in the WSDL the concreate type must be an extention
of the abstract type, the package does not enforce this restriction, so
caution must be taken.
</p>
</div>
</BODY>
</HTML>
|
