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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
|
<%
// Java Plug-in Framework (JPF)
// Copyright (C) 2004 - 2007 Dmitry Olshansky
// $Id: tools.jxp,v 1.5 2007/04/30 11:51:25 ddimon Exp $
%>
<%
include("/functions.ijxp");
printHeader("Tools");
printMenu("tools");
%>
<div class="content">
<h1>JPF Tools Reference</h1>
<p>
Most JPF tools are implemented as special purpose Java classes and wrapped as Ant tasks for ease of use. To make JPF specific tasks available in your build file insert following declaration in the beginning of Ant build script:<br />
<code><typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /></code><br />
Note that jpf-tool.jar library should be available in classpath (you may use nested <code><classpath></code> element in <code><typedef></code> tag).
</p>
<p>
<a href="#integrityChecking">Integrity Check Tool</a><br />
<a href="#pluginDocumenting">Documentation Tool</a><br />
<a href="#pluginArchiving">Plug-in Archive Tool</a><br />
<a href="#singleFilePlugin">Single File Plug-in Tool</a><br />
<a href="#manifestInfo">Manifest Info Tool</a><br />
<a href="#versionUpdate">Version Update Tool</a><br />
<a href="#path">Classpath Tool</a><br />
<a href="#sort">Sorting Tool</a><br />
</p>
<h3><a name="integrityChecking">Integrity Check Tool</a></h3>
<p>
The tool is implemented as Ant task (<strong>jpf-check</strong>) and allows to check integrity of plug-ins collection.
</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">usepathresolver</td>
<td valign="top">If "true", JPF will try to resolve URL's specified in manifests to check existence of plug-in resources. Default is "false".</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be checked.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-check" task to check plug-ins integrity -->
<jpf-check
basedir="${basedir}/plugins"
includes="*/plugin.xml,*/plugin-fragment.xml"
verbose="true"
usepathresolver="true"/></pre>
<h3><a name="pluginDocumenting">Documentation Tool</a></h3>
<p>The javadoc-like tool to generate documentation for plug-ins. The tool implemented as special <a href="api/org/java/plugin/tools/docgen/DocGenerator.html">utility class</a> and wrapped with Ant task (<strong>jpf-doc</strong>) for ease of use.</p>
<p><strong>Note:</strong> documentation design looks not very good now, but this is just design problem, not the documentation engine! Good HTML design contributions are <a href="http://sourceforge.net/forum/forum.php?forum_id=378299">welcome</a>!</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">destdir</td>
<td valign="top">Base directory for generated documentation files.</td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top">overview</td>
<td valign="top">Documentation overview HTML file.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">encoding</td>
<td valign="top">Source files encoding name (templates, overview etc.) Default is system encoding.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">docencoding</td>
<td valign="top">Output files encoding name. Default is UTF-8.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">stylesheetfile</td>
<td valign="top">CSS style sheet to use. Predefined style will be used if no file specified.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">templates</td>
<td valign="top">path to template files (should be available in classpath). Predefined templates set will be used if not specified.</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files, documentation should be generated for.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-doc" task to generate plug-ins documentation -->
<jpf-doc
basedir="${basedir}/plugins"
includes="*/plugin.xml,*/plugin-fragment.xml"
destdir="${build.home}/docs"/></pre>
<h3><a name="pluginArchiving">Plug-in Archive Tool</a></h3>
<p>Tool implemented as special <a href="api/org/java/plugin/tools/configuration/PluginArchiver.html">utility class</a> and wrapped with Ant tasks (<strong>jpf-pack</strong> and <strong>jpf-unpack</strong>) for ease of use. Plug-in archive is specially prepared ZIP format file that holds all packed plug-ins and special descriptor for quick extracting plug-ins meta-data without need of unpacking the whole archive file.</p>
<h5>Plug-ins archiving task (jpf-pack).</h5>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">destfile</td>
<td valign="top">Target archive file.</td>
<td valign="top">Yes</td>
</tr>
</table>
<h5>Plug-ins un-archiving task (jpf-unpack).</h5>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">srcfile</td>
<td valign="top">Archive file to be unpacked.</td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top">destdir</td>
<td valign="top">Folder where to extract archived plug-ins.</td>
<td valign="top">Yes</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files, documentation should be generated for.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-pack" task to pack plug-ins into archive -->
<jpf-pack
basedir="${basedir}/plugins"
includes="*/plugin.xml,*/plugin-fragment.xml"
destfile="${build.home}/all-plugins.zip"/>
<!-- Call "jpf-unpack" task to extract plug-ins from archive -->
<jpf-unpack
srcfile="${build.home}/all-plugins.zip"
destdir="${build.home}/all-plugins-extracted"/></pre>
<h3><a name="singleFilePlugin">Single File Plug-in Tool</a></h3>
<p>
The tool is implemented as Ant task (<strong>jpf-zip</strong>) and allows to process plug-ins collection packaging every plug-in and plug-in fragment into single ZIP file. ZIP file names compozed according to the following scheme: <code><plugin-ID>-<plugin-version>.zip</code>
</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">destdir</td>
<td valign="top">Directory to store generated ZIP files.</td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">usepathresolver</td>
<td valign="top">If "true", JPF will try to resolve URL's specified in manifests to check existence of plug-in resources. Default is "false".</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-zip" task to process plug-ins packaging every plug-in as
single ZIP file -->
<jpf-zip
basedir="${build.home}/plugins"
includes="*/*.xml"
destdir="${build.home}/plugins"/></pre>
<h3><a name="manifestInfo">Manifest Info Tool</a></h3>
<p>Simple (but quite useful :) task (<strong>jpf-info</strong>) to read some data from plug-in manifest into project properties. This task is modeled after similar purpose <a href="api/org/java/plugin/registry/PluginRegistry.html#readManifestInfo(java.net.URL)">method in plug-in resgistry</a> and covers the same properties as corresponding <a href="api/org/java/plugin/registry/PluginRegistry.ManifestInfo.html">manifest info interface</a></p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">manifest</td>
<td valign="top">Plug-in or plug-in fragment file to read data from.</td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top">propertyid</td>
<td valign="top">Name of the property where to put plug-in or plug-in fragment ID.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">propertyversion</td>
<td valign="top">Name of the property where to put plug-in or plug-in fragment version. If no version specified in manifest, the empty string will be used.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">propertyvendor</td>
<td valign="top">Name of the property where to put plug-in or plug-in fragment vendor.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">propertypluginid</td>
<td valign="top">Name of the property where to put plug-in ID (applicable for plug-in fragment manifest only).</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">propertypluginversion</td>
<td valign="top">Name of the property where to put plug-in version (applicable for plug-in fragment manifest only). If no version specified in manifest, the empty string will be used.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">propertymatchingrule</td>
<td valign="top">Name of the property where to put plug-in fragment matchin rule (applicable for plug-in fragment manifest only).</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-info" task to read plug-in ID into "plugin.id" property
and plug-in version into "plugin.version" property -->
<jpf-info
manifest="${basedir}/plugin.xml"
propertyid="plugin.id"
propertyversion="plugin.version"/></pre>
<h3><a name="versionUpdate">Version Update Tool</a></h3>
<p>Task (<strong>jpf-version</strong>) to automatically updade plug-in versions and version references. This task upgrades vesions build number and optionally version name (see <a href="api/org/java/plugin/registry/Version.html">Version class documentation</a>) if plug-in has modified since previous task run. Actual version numbers and timestamps are stored in simple text file in Java properties format.</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>. The folder should contain non-ziped plain folders with plug-ins and plug-in fragments. Note that this task will modify manifests in this folder (leaving manifest file timestamps unchanged).</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">versionsfile</td>
<td valign="top">File where to store versions related data. If not exist, will be created automatically.</td>
<td valign="top">Yes</td>
</tr>
<tr>
<td valign="top">alterreferences</td>
<td valign="top">If "true", version references should be upgraded also. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">timestampversion</td>
<td valign="top">If "true", the plug-in timestamp will be included into version name field. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-version" task to update versions of modified plug-ins -->
<jpf-version
basedir="${build.home}/plugins"
includes="*/plugin.xml,*/plugin-fragment.xml"
versionsfile="${basedir}/plugins/versions.properties"
timestampversion="true"/></pre>
<h3><a name="path">Classpath Tool</a></h3>
<p>Task (<strong>jpf-path</strong>) to compose plug-in(s) classpath according to manifest data (libraries and dependencies declarations).</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">pathid</td>
<td valign="top">Composed path-like structure ID.</td>
<td valign="middle" rowspan="2">One of two attriutes should be set.</td>
</tr>
<tr>
<td valign="top">pathidref</td>
<td valign="top">Path-like structure ID reference.</td>
</tr>
<tr>
<td valign="top">pluginid</td>
<td valign="top">Plug-in ID to compose classpath for.</td>
<td valign="middle" rowspan="2">At least one of two attriutes should be set.</td>
</tr>
<tr>
<td valign="top">pluginids</td>
<td valign="top">Comma separated list of plug-in ID's to compose classpath for.</td>
</tr>
<tr>
<td valign="top">followexports</td>
<td valign="top">If "true", libraries export rules will be taken into account. Default is "true".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-path" task to compose classpath for plug-in "my.plugin" and
put result in path-like structure with ID "plugin.classpath". -->
<jpf-path
basedir="${build.home}/plugins"
includes="*/plugin.xml,*/plugin-fragment.xml"
pathid="plugin.classpath"
pluginid="my.plugin"/></pre>
<h3><a name="sort">Sorting Tool</a></h3>
<p>Task (<strong>jpf-sort</strong>) to sort plug-in(s) in correct build order. Places result into output path-like structure.</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th valign="top">Attribute</th>
<th valign="top">Description</th>
<th valign="top">Required</th>
</tr>
<tr>
<td valign="top">basedir</td>
<td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">pathid</td>
<td valign="top">Composed path-like structure ID.</td>
<td valign="middle" rowspan="2">One of two attriutes should be set.</td>
</tr>
<tr>
<td valign="top">pathidref</td>
<td valign="top">Path-like structure ID reference.</td>
</tr>
<tr>
<td valign="top">pathmode</td>
<td valign="top">
Regulates what to place into output path. Possible values are:
<dl>
<dt>DIR</dt>
<dd>put plug-in directory into output path</dd>
<dt>BUILD</dt>
<dd>put plug-in's <code>build.xml</code> file into output path</dd>
<dt>MANIFEST</dt>
<dd>put original plug-in manifest file into output path</dd>
</dl>
Default value is MANIFEST.
</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">reverse</td>
<td valign="top">If "true", result entries will be placed into output path in reversed order. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">Indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">whitelist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
<td valign="top">No</td>
</tr>
<tr>
<td valign="top">blacklist</td>
<td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
<td valign="top">No</td>
</tr>
</table>
<h5>Parameters specified as nested elements</h5>
<dl>
<dt>fileset</dt>
<dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
</dl>
<h5>Example</h5>
<pre><!-- Define custom JPF specific Ant tasks -->
<typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" />
<!-- Call "jpf-sort" task to sort all plug-ins in correct build order and
put their folders in path-like structure with ID "plugins". -->
<jpf-sort
basedir="${build.home}/plugins"
includes="*/plugin.xml,*/plugin-fragment.xml"
pathid="plugins"
pathmode="DIR"/></pre>
<p>Look at the source code of <a href="http://sourceforge.net/project/showfiles.php?group_id=110394">JPF-Demo application</a> to get working example of tools usage.</p>
</div>
<%
printFooter();
%>
|
