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
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: Jibx2Wsdl Customizations</title>
<style type="text/css">
@import url("../style/tigris.css");
@import url("../style/maven.css");
.dtd-comment {
color: #993399;
font-weight: bold;
</style>
<script type="text/javascript">
if (document.layers) {
document.writeln('<link rel="stylesheet" type="text/css" href="../style/ns4_only.css" media="screen" /><link rel="stylesheet" type="text/css" href="../style/maven_ns4_only.css" media="screen" />')
}
</script>
<link rel="stylesheet" type="text/css" href="../style/print.css" media="print" />
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
</head>
<body class="composite">
<div id="banner">
<table border="0" cellspacing="0" cellpadding="8" width="100%">
<tbody>
<tr>
<td><h1>JiBX: Jibx2Wsdl Customizations</h1>
</td>
<td>
<div align="right" id="login"><a href="http://sourceforge.net/projects/jibx"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=69358&type=16" width="150" height="40" border="0" alt="Get JiBX - XML Data Binding for Java at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="breadcrumbs">
<table border="0" cellspacing="0" cellpadding="4" width="100%">
<tbody>
<tr>
<td>
<div align="right">
<a href="../index.html">Home Page</a> |
<a href="http://www.sourceforge.net/projects/jibx/">SourceForge Page</a> |
<a href="../mail-lists.html">Mailing Lists</a> |
<a href="../bugs.html">Bugs</a> |
<a href="http://sourceforge.net/project/showfiles.php?group_id=69358">Downloads</a>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<table border="0" cellspacing="0" cellpadding="8" width="100%" id="main">
<tbody>
<tr valign="top">
<td id="leftcol" width="20%">
<div id="navcolumn">
<div>
<strong>JiBX Basics</strong>
<div>
<small>
<a href="../index.html">Overview</a>
</small>
<div>
<small>
<a href="../getting-started.html">Getting Started</a>
</small>
</div>
<div>
<small>
<a href="../bindcomp.html">Binding Compiler</a>
</small>
</div>
<div>
<small>
<a href="../bindonload.html">Binding on Load</a>
</small>
</div>
<div>
<small>
<a href="../runtime.html">Runtime</a>
</small>
</div>
<div>
<small>
<a href="../extras.html">Extras</a>
</small>
</div>
<div>
<small>
<a href="../building.html">Building JiBX</a>
</small>
</div>
<div>
<small>
<a href=".././jibx-maven-plugin/index.html">Maven</a>
</small>
</div>
<div>
<small>
<a href="../contributing.html">Contributing</a>
</small>
</div>
<div>
<small>
<a href="../jibx-license.html">License</a>
</small>
</div>
</div>
<div>
<small>
<a href="../status.html">News and Status</a>
</small>
</div>
<div>
<small>
<a href="../support.html">Support</a>
</small>
<div>
<small>
<a href="../faq.html">FAQ</a>
</small>
</div>
<div>
<small>
<a href="../mail-lists.html">Mailing Lists</a>
</small>
</div>
<div>
<small>
<a href="../bugs.html">Bugs</a>
</small>
</div>
</div>
<div>
<small>
<a href="../comments.html">User Comments</a>
</small>
</div>
<div>
<small>
<a href="../sponsors.html">Sponsors</a>
</small>
</div>
</div>
<div>
<strong>Start from Code</strong>
<div>
<small>
<a href="index.html">Start from Code</a>
</small>
</div>
<div>
<small>
<a href="bindgen.html">BindGen</a>
</small>
<div>
<small>
<a href="bindgen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="bindgen-example1.html">Example 1</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example2.html">Example 2</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example3.html">Example 3</a>
</small>
</div>
<div>
<small>
<a href="bindgen-example4.html">Example 4</a>
</small>
</div>
</div>
<div>
<small>
<a href="bindgen-customs.html">Customizations Reference</a>
</small>
</div>
</div>
<div>
<small>
<a href="schemagen.html">SchemaGen</a>
</small>
</div>
<div>
<small>
<a href="jibx2wsdl.html">Jibx2Wsdl</a>
</small>
<div>
<small>
<a href="jibx2wsdl-examples.html">Examples</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">Customizations</span>
</small>
</div>
</div>
</div>
<div>
<strong>Start from Schema</strong>
<div>
<small>
<a href="../fromschema/index.html">Start from Schema</a>
</small>
</div>
<div>
<small>
<a href="../fromschema/codegen.html">CodeGen</a>
</small>
<div>
<small>
<a href="../fromschema/codegen-types.html">Schema Datatype Handling</a>
</small>
</div>
<div>
<small>
<a href="../fromschema/codegen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="../fromschema/example-default.html">Default Generation</a>
</small>
</div>
<div>
<small>
<a href="../fromschema/example-custom1.html">Simple Customizations</a>
</small>
</div>
<div>
<small>
<a href="../fromschema/example-custom2.html">More Customizations</a>
</small>
</div>
<div>
<small>
<a href="../fromschema/example-modular.html">Modular Generation</a>
</small>
</div>
</div>
<div>
<small>
<a href="../fromschema/codegen-customs.html">Customizations Reference</a>
</small>
<div>
<small>
<a href="../fromschema/codegen-extends.html">Extensions Reference</a>
</small>
</div>
</div>
</div>
</div>
<div>
<strong>Binding Definition</strong>
<div>
<small>
<a href="../binding/tutorial/binding-tutorial.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="../binding/tutorial/binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-extras.html">Binding extras</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-collects.html">Collections and arrays</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-mappings.html">Using mappings</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="../binding/tutorial/binding-custom.html">Custom code</a>
</small>
</div>
</div>
<div>
<small>
<a href="../binding/precompiled.html">Precompiled Bindings</a>
</small>
</div>
<div>
<small>
<a href="../binding/binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="../binding/contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="../binding/conversions.html">Conversions</a>
</small>
<div>
<small>
<a href="../binding/date-time.html">Date/time conversions</a>
</small>
</div>
</div>
<div>
<small>
<a href="../binding/xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="../binding/binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="../binding/binding-attributes.html">Attribute groups</a>
</small>
</div>
</div>
</div>
<div>
<strong>Usage API</strong>
<div>
<small>
<a href=".././api/index.html">Runtime JavaDocs</a>
</small>
</div>
</div>
<div>
<strong>Subprojects</strong>
<div>
<small>
<a href="../eclipse/index.html">Eclipse Plug-in</a>
</small>
<div>
<small>
<a href="../eclipse/index.html">Introduction</a>
</small>
</div>
<div>
<small>
<a href="../eclipse/install.html">Install</a>
</small>
</div>
<div>
<small>
<a href="../eclipse/usage.html">Usage</a>
</small>
</div>
</div>
<div>
<small>
<a href="../jibxws/index.html">JiBX/WS</a>
</small>
</div>
<div>
<small>
<a href="../axis2/index.html">Axis2 Usage</a>
</small>
</div>
<div>
<small>
<a href="../jibxota/index.html">JiBX/OTA</a>
</small>
</div>
<div>
<small>
<a href=".././schema-library/index.html">Schema Library</a>
</small>
</div>
</div>
</div>
</td>
<td>
<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="intro"></a>Extending BindGen customizations</h3>
<p>Jibx2Wsdl customizations are based on the <a href="bindgen-customs.html">BindGen customizations</a>.
In addition to the customizations defined for use with BindGen, Jibx2Wsdl also defines some
extension elements which can be added to the customizations information for controlling how
service classes are translated into WSDL definitions.</p>
<p>The Jibx2Wsdl extension elements are <wsdl>, <service>, <operation>, <parameter>,
and <return>. The <wsdl> element, if present, must always be a direct child
of the <custom> element at the root of the customization document. It can contain any
number of child <service> elements, which can in turn contain <operation> elements.
<operation> elements can contain child <parameter> and <return>
elements (in that order, with at most one <return> element).</p>
</div>
<div class="h3">
<h3><a name="attrs"></a><wsdl> and <service> attributes</h3>
<p>The <wsdl> and <service> elements are based on BindGen customizations, and support
the BindGen <a href="bindgen-customs.html#nesting-attributes">Nesting customization attributes</a>,
along with several additional attributes. The following attributes are supported by both
<wsdl> and <service> elements:</p>
<h4>Common customization attributes</h4>
<table border="1" width="100%">
<tr class="b">
<td><p><a name="service-base"></a>service-base</p></td>
<td><p>Sets the base address used for the service endpoint address specified in the WSDL.
The default is <code>http://localhost:8080/axis2/services</code> at the <wsdl> level,
which will be modified by appending the service name on the end.</p></td>
</tr>
<tr class="a">
<td><p><a name="set-actions"></a>set-actions</p></td>
<td><p>Determines whether the generated WSDL should specify soapAction values as part of
the operation definitions. Some frameworks require these action values to be present. The
default is "true", meaning the action values will be defined.</p></td>
</tr>
<tr class="b">
<td><p><a name="use-nillable"></a>use-nillable</p></td>
<td><p>Determines whether <code>nillable="true"</code> will be specified in the schema
definition for optional values used as method parameters. The default is "false", meaning
<code>minOccurs="0"</code> will be used rather than nillable.</p></td>
</tr>
<tr class="a">
<td><p><a name="wrapped"></a>wrapped</p></td>
<td><p>Controls whether "wrapped" document/literal style is used for the generated WSDL,
rather than plain document/literal. The wrapped style preserves the structure of parameters
passed to methods in the corresponding web service operations. The default is "true",
meaning the wrapped style will be used.</p></td>
</tr>
<tr class="b">
<td><p><a name="wsdl-namespace"></a>wsdl-namespace</p></td>
<td><p>Sets the namespace used for WSDL definitions. By default the namespace is generated
from the package of the supplied service definition class.</p></td>
</tr>
</table>
<p>The <service> element also defines additional attributes:</p>
<h4><service> customization attributes</h4>
<table border="1" width="100%">
<tr class="b">
<td><p><a name="binding-name"></a>binding-name</p></td>
<td><p>Name to be used for the <wsdl:binding> definition. If not specified, it is
derived by appending "Binding" to the service name.</p></td>
</tr>
<tr class="a">
<td><p><a name="class"></a>class</p></td>
<td><p>Gives the fully-qualified class name of the service definition class. This is the
only required attribute for the <service> element.</p></td>
</tr>
<tr class="a">
<td><p><a name="excludes"></a>excludes</p></td>
<td><p>List of method names to be excluded from service definition. Names in the list
are separated by whitespace characters. If neither this attribute nor the <code>includes</code>
attribute is given, all non-static methods will be exposed as operations in the service
definition. If both attributes are given, only the methods listed in the <code>includes</code>
value are used (it's an error if a method is in both lists).</p></td>
</tr>
<tr class="b">
<td><p><a name="includes"></a>includes</p></td>
<td><p>List of method names to be included in the service definition. Names in the list
are separated by whitespace characters. If neither this attribute nor the <code>excludes</code>
attribute is given, all non-static methods will be exposed as operations in the service
definition. If both attributes are given, only the methods listed in the <code>includes</code>
value are used (it's an error if a method is in both lists).</p></td>
</tr>
<tr class="a">
<td><p><a name="port-name"></a>port-name</p></td>
<td><p>Name to be used for the <wsdl:port> definition. If not specified, it is
derived by appending "Port" to the service name.</p></td>
</tr>
<tr class="b">
<td><p><a name="port-type-name"></a>port-type-name</p></td>
<td><p>Name to be used for the <wsdl:portType> definition. If not specified, it is
derived by appending "PortType" to the service name.</p></td>
</tr>
<tr class="a">
<td><p><a name="service-address"></a>service-address</p></td>
<td><p>Sets the service endpoint address to be specified in the WSDL. The default is
derived from the <a href="#service-base"><code>service-base</code></a> value by appending
the service name on the end.</p></td>
</tr>
<tr class="b">
<td><p><a name="service-name"></a>service-name</p></td>
<td><p>Name to be used for the service. The default is the simple class name of the service
definition class.</p></td>
</tr>
</table>
</div>
<div class="h3">
<h3><a name="opattrs"></a><operation> attributes</h3>
<p><operation> elements support the following customization attributes:</p>
<h4><operation> customization attributes</h4>
<table border="1" width="100%">
<tr class="b">
<td><p><a name="method-name"></a>method-name</p></td>
<td><p>This required attribute gives the name of the service definition class method to
be customized by the element.</p></td>
</tr>
<tr class="a">
<td><p><a name="operation-name"></a>operation-name</p></td>
<td><p>Sets the operation name to be used in the WSDL service description. If this attribute
is not specified, the operation name is the same as the method name.</p></td>
</tr>
<tr class="b">
<td><p><a name="optionals"></a>optionals</p></td>
<td><p>List of parameter names to be treated as optional in the schema representation of
the input message for this operation. Names are separated by whitespace in the list. If
neither this attribute nor the <code>requireds</code> attribute is supplied all object
reference parameters are treated as optional and all primitive parameters are treated as
required.</p></td>
</tr>
<tr class="a">
<td><p><a name="request-message"></a>request-message</p></td>
<td><p>Name to be used for the input message to this operation. If this
attribute is not specified, the input message element name is constructed by appending
"Message" to the operation name.</p></td>
</tr>
<tr class="b">
<td><p><a name="request-wrapper"></a>request-wrapper</p></td>
<td><p>Element name to be used for the input message to this operation. If this
attribute is not specified, the input message element name is just the operation name.</p></td>
</tr>
<tr class="a">
<td><p><a name="requireds"></a>requireds</p></td>
<td><p>List of parameter names to be treated as required in the schema representation of
the input message for this operation. Names are separated by whitespace in the list. If
neither this attribute nor the <code>optionals</code> attribute is supplied all object
reference parameters are treated as optional and all primitive parameters are treated as
required.</p></td>
</tr>
<tr class="b">
<td><p><a name="response-message"></a>response-message</p></td>
<td><p>Name to be used for the output message from this operation. If this
attribute is not specified, the output message element name is constructed by appending
"ResponseMessage" to the operation name.</p></td>
</tr>
<tr class="a">
<td><p><a name="response-wrapper"></a>response-wrapper</p></td>
<td><p>Element name to be used for the output message from this operation. If this
attribute is not specified, the output message element name is constructed by appending
"Response" to the operation name.</p></td>
</tr>
<tr class="b">
<td><p><a name="soap-action"></a>soap-action</p></td>
<td><p>URI to be used as the soapAction identifier for this operation. If this attribute is
not specified, the soapAction identifier is generated by prefixing the operation name with
"urn:".</p></td>
</tr>
</table>
</div>
<div class="h3">
<h3><a name="parmret"></a><parameter> and <return> attributes</h3>
<p><parameter> and <return> elements are used within an <operation> definition
to customize the handling of values passed to or returned from the service method associated
with the <operation>. These elements are based on BindGen customizations, and support
the BindGen <a href="bindgen-customs.html#value">Value customization attributes</a>, along with
the following added attribute:</p>
<h4><parameter> and <return> customization attributes</h4>
<table border="1" width="100%">
<tr class="b">
<td><p><a name="element"></a>element</p></td>
<td><p>This attribute gives the element name to be used for the parameter or return
value in the XML representation.</p></td>
</tr>
<p>In addition, the <parameter> element has an additional required attribute:</p>
<h4><parameter> customization attributes</h4>
<table border="1" width="100%">
<tr class="b">
<td><p><a name="name"></a>name</p></td>
<td><p>This required attribute gives the name of the parameter being customized.</p></td>
</tr>
</table>
</div>
<div class="h3">
<h3><a name="command"></a>Command line customizations</h3>
<p>You can also pass global customizations (corresponding to attributes of the <wsdl>
elements) to Jibx2Wsdl as command-line parameters, without the need to create a customizations
file, by using "--" as a special prefix to the customization attribute value. So to set the
service base address to "http://www.jibx.org/ws", for instance, you'd use the command line parameter
<code>--service-base=http://www.jibx.org/ws</code>. You can also pass global customizations for
BindGen in the Jibx2Wsdl command line.</p>
</div>
</div>
</div>
</td>
</tr>
</tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
<tbody>
<tr>
<td> © 2003-2011, Dennis M. Sosnoski (<a href="http://www.sosnoski.co.nz">Sosnoski Software Associates Ltd</a>).
Licensed to the JiBX Project for free distribution and use. </td>
</tr>
</tbody>
</table>
</div>
<br>
</body>
</html>
|
