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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Bind on Load</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>Bind on Load</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>
<span class="menu-selection">Binding on Load</span>
</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="fromcode/index.html">Start from Code</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen.html">BindGen</a>
</small>
<div>
<small>
<a href="fromcode/bindgen-examples.html">Example Code</a>
</small>
<div>
<small>
<a href="fromcode/bindgen-example1.html">Example 1</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen-example2.html">Example 2</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen-example3.html">Example 3</a>
</small>
</div>
<div>
<small>
<a href="fromcode/bindgen-example4.html">Example 4</a>
</small>
</div>
</div>
<div>
<small>
<a href="fromcode/bindgen-customs.html">Customizations Reference</a>
</small>
</div>
</div>
<div>
<small>
<a href="fromcode/schemagen.html">SchemaGen</a>
</small>
</div>
<div>
<small>
<a href="fromcode/jibx2wsdl.html">Jibx2Wsdl</a>
</small>
<div>
<small>
<a href="fromcode/jibx2wsdl-examples.html">Examples</a>
</small>
</div>
<div>
<small>
<a href="fromcode/jibx2wsdl-customs.html">Customizations</a>
</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="onload">Binding classes at runtime</a></h3>
<p>JiBX also supports limited runtime binding of
class files. This adds runtime overhead as compared to using the binding
compiler directly during the build process, but can be convenient when you're
experimenting with different binding definitions or going through repeated
build-test cycles. At present, runtime binding only works with classes that are
present in the classpath as individual class files (not in jars). It's also not
designed for use in controlled environment such as servlet engines or application
servers.</p>
<p>To use the runtime binding support, you need to execute the
<code>org.jibx.binding.Run</code> class (from <i>/lib/jibx-bind.jar</i>) as the
main class when starting the JVM, in place of whatever main class you'd normally
give as the target. You can pass one or more binding definition files as command
line arguments to this class, along with the name of your application main class
and any command line arguments expected by your program. For example, if you
normally run your application using the command line:</p>
<div id="source"><pre>java -cp . com.myco.package.App arg1 arg2</pre></div>
<p>and your JiBX installation is at <i>/home/dennis/jibx</i>, you'd run the
application using runtime binding as follows (in a single line, shown
split here only for formatting):</p>
<div id="source"><pre>java -cp .:/home/dennis/jibx/lib/jibx-bind.jar org.jibx.binding.Run
-b binding.xml com.myco.package.App arg1 arg2</pre></div>
<p>This tells the JVM to start execution with the <code>org.jibx.binding.Run</code>
class, which will then use its own classloader to load your application classes,
after first modifying the classes read from disk to reflect the <i>binding.xml</i>
binding definition. Once the binding has been processed, JiBX will transfer
control to your application main class (in this case,
<code>com.myco.package.App</code>), passing the command line arguments just as
if your application were executed directly from the command line. Note that
this is the Unix/Linux version of the command line; if you're running
Windows you'll need to reverse the slashs and use ';' instead of ':' as a path
separator character.</p>
</div>
<div class="h3">
<h3><a name="loaddefs">Specifying the binding definitions</a></h3>
<p>The runtime binding code supports several different ways of specifying the
binding definition file or files to be used for your application. The first, and most
direct, approach is to supply one or more <i>-b file-path</i> argument pairs
before your application main class name on the command line. This is the
approach used in the above example, with a single binding definition. To use
multiple binding definitions this way, you need to give the <i>-b</i> argument
before each individual file path.</p>
<p>The second approach is to give the path to a simple text file (not an XML
file) that gives a list of binding definition file paths, with one binding file
per line. This uses the <i>-l</i> argument as a flag, so if the binding file
list is in a file named <i>bindings.txt</i> you could use the following command
line to run your application with the named bindings (on Unix/Linux; if you're
using Windows or MS-DOS you'll need to reverse the slashs and use ';' instead of
':' as a path separator character):</p>
<div id="source"><pre>java -cp .:/home/dennis/jibx/lib/jibx-bind.jar org.jibx.binding.Run
-l bindings.txt com.myco.package.App arg1 arg2</pre></div>
<p>The third way is to give the binding definition(s) as resources loaded from
the classpath, rather than as actual file paths. The advantage of doing things
this way is that the binding definition(s) can be kept with your actual class
files (or with the source files, and copied during build to the same directory
as your class files). This uses the <i>-r</i> argument as a flag for each
binding definition to be loaded as a resource, followed by the actual resource
path. For example, if your binding file is kept with your main class you could
use a command line of this form to run it:</p>
<div id="source"><pre>java -cp .:/home/dennis/jibx/lib/jibx-bind.jar org.jibx.binding.Run
-r /com/myco/package/binding.xml com.myco.package.App arg1 arg2</pre></div>
<p>All three of the above techniques can be used in any combination on the
command line (though it's difficult to imagine actually needing to do so!).</p>
<p>Finally, you can instead use implicit binding definition resources. When
you do this you don't need any command line arguments for JiBX (though you still
need to specify the <code>org.jibx.binding.Run</code> as your main class) except
for the application main class name and any arguments to be passed to that
class:</p>
<div id="source"><pre>java -cp .:/home/dennis/jibx/lib/jibx-bind.jar org.jibx.binding.Run
com.myco.package.App arg1 arg2</pre></div>
<p>In this case JiBX goes through the following sequence of steps to find the
binding definition resource(s) to be applied:</p>
<ol>
<li>Look for a resource named <i>jibx_bindings.txt</i> that gives a list of
bindings (one per line) to be loaded as resources,</li>
<li>If not found, construct a resource path by using the package path for your
application main class and appending <i>_jibx_bindings.txt</i> to the main class
name. For the sample I've been using throughout this description the resulting
path would be <i>/com/myco/package/App_jibx_bindings.txt</i>. If this resource
is found, it's interpreted as a list of bindings (one per line) to be loaded as
resources,</li>
<li>If not found, look for a single binding definition file named
<i>jibx_binding.xml</i> and use that binding,</li>
<li>If not found, construct a resource path by using the package path for your
application main class and appending <i>_jibx_binding.xml</i> to the main class
name, and use that binding. For the sample application this path would
be <i>/com/myco/package/App_jibx_binding.xml</i>.</li>
</ol>
</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>
|
