This repository has been archived by the owner on Nov 10, 2017. It is now read-only.
forked from VaclavDedik/jboss-seam
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Components.xml
executable file
·1620 lines (1572 loc) · 72.1 KB
/
Components.xml
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
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<chapter id="components">
<title>Built-in Seam components</title>
<para>
This chapter describes Seam's built-in components, and their
configuration properties. The built-in components will be created even if they
are not listed in your <literal>components.xml</literal> file, but if you need to
override default properties or specify more than one component of a certain type,
<literal>components.xml</literal> is used.
</para>
<para>
Note that you can replace any of the built in components with
your own implementations simply by specifying the name of one
of the built in components on your own class using
<literal>@Name</literal>.
</para>
<section>
<title>Context injection components</title>
<para>
The first set of built in components exist purely to support
injection of various contextual objects. For example, the
following component instance variable would have the Seam
session context object injected:
</para>
<programlisting role="JAVA"><![CDATA[@In private Context sessionContext;]]></programlisting>
<variablelist >
<varlistentry>
<term><literal>org.jboss.seam.core.contexts</literal></term>
<listitem>
<para>
Component that provides access to Seam Context objects, for
example <literal>org.jboss.seam.core.contexts.sessionContext['user']</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.faces.facesContext</literal></term>
<listitem>
<para>
Manager component for the <literal>FacesContext</literal> context
object (not a true Seam context)
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
All of these components are always installed.
</para>
</section>
<section>
<title>JSF-related components</title>
<para>
The following set of components are provided to supplement JSF.
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.faces.dateConverter</literal></term>
<listitem>
<para>
Provides a default JSF converter for properties of type
<literal>java.util.Date</literal>.
</para>
<para>
This converter is automatically registered with JSF. It
is provided to save a developer from having to specify
a DateTimeConverter on an input field or page
parameter. By default, it assumes the type to be a date
(as opposed to a time or date plus time) and uses the
short input style adjusted to the Locale of the user.
For Locale.US, the input pattern is mm/DD/yy. However,
to comply with Y2K, the year is changed from two digits
to four (e.g., mm/DD/yyyy).
</para>
<para>
It's possible to override the input pattern globally
using component configuration. Consult the JavaDoc for
this class to see examples.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.faces.facesMessages</literal></term>
<listitem>
<para>
Allows faces success messages to propagate across a browser redirect.
</para>
<itemizedlist>
<listitem>
<para>
<literal>add(FacesMessage facesMessage)</literal> — add
a faces message, which will be displayed during the next render
response phase that occurs in the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>add(String messageTemplate)</literal> — add
a faces message, rendered from the given message template
which may contain EL expressions.
</para>
</listitem>
<listitem>
<para>
<literal>add(Severity severity, String messageTemplate)</literal> —
add a faces message, rendered from the given message template
which may contain EL expressions.
</para>
</listitem>
<listitem>
<para>
<literal>addFromResourceBundle(String key)</literal> —
add a faces message, rendered from a message template defined
in the Seam resource bundle which may contain EL expressions.
</para>
</listitem>
<listitem>
<para>
<literal>addFromResourceBundle(Severity severity, String key)</literal> —
add a faces message, rendered from a message template defined
in the Seam resource bundle which may contain EL expressions.
</para>
</listitem>
<listitem>
<para>
<literal>clear()</literal> — clear all messages.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.faces.redirect</literal></term>
<listitem>
<para>
A convenient API for performing redirects with parameters (this
is especially useful for bookmarkable search results screens).
</para>
<itemizedlist>
<listitem>
<para>
<literal>redirect.viewId</literal> — the JSF view id
to redirect to.
</para>
</listitem>
<listitem>
<para>
<literal>redirect.conversationPropagationEnabled</literal> —
determines whether the conversation will propagate across the
redirect.
</para>
</listitem>
<listitem>
<para>
<literal>redirect.parameters</literal> — a map of
request parameter name to value, to be passed in the redirect
request.
</para>
</listitem>
<listitem>
<para>
<literal>execute()</literal> — perform the redirect
immediately.
</para>
</listitem>
<listitem>
<para>
<literal>captureCurrentRequest()</literal> — stores
the view id and request parameters of the current GET
request (in the conversation context), for later use
by calling <literal>execute()</literal>.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.faces.httpError</literal></term>
<listitem>
<para>
A convenient API for sending HTTP errors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.ui.renderStampStore</literal></term>
<listitem>
<para>
A component (session-scoped by default) responsible for maintaining a
collection of render stamps. A render stamp is an indicator as to whether a
form which was rendered has been submitted. This store is useful when the
client-side state saving method of JSF is being used because it puts the
determination of whether a form has been posted in the control of the server
rather than in the component tree which is maintained on the client.
</para>
<para>
To unbind this check from the session (which is one of the main design goals
of client-side state saving) an implementation must be provided that stores
the render stamps in the application (valid as long as the application is
running) or the database (valid across server restarts).
</para>
<itemizedlist>
<listitem>
<para>
<literal>maxSize</literal> — The maximum number of stamps
to be kept in the store. Default: 100
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
<para>
These components are installed when the class <literal>javax.faces.context.FacesContext</literal>
is available on the classpath.
</para>
</section>
<section>
<title>Utility components</title>
<para>
These components are merely useful.
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.core.events</literal></term>
<listitem>
<para>
An API for raising events that can be observed via
<literal>@Observer</literal> methods, or method
bindings in <literal>components.xml</literal>.
</para>
<itemizedlist>
<listitem>
<para>
<literal>raiseEvent(String type)</literal> — raise
an event of a particular type and distribute to all
observers.
</para>
</listitem>
<listitem>
<para>
<literal>raiseAsynchronousEvent(String type)</literal> —
raise an event to be processed asynchronously by the EJB3
timer service.
</para>
</listitem>
<listitem>
<para>
<literal>raiseTimedEvent(String type, ....)</literal> —
schedule an event to be processed asynchronously by the EJB3
timer service.
</para>
</listitem>
<listitem>
<para>
<literal>addListener(String type, String methodBinding)</literal>
— add an observer for a particular event type.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.interpolator</literal></term>
<listitem>
<para>
An API for interpolating the values of JSF EL expressions in
Strings.
</para>
<itemizedlist>
<listitem>
<para>
<literal>interpolate(String template)</literal> — scan
the template for JSF EL expressions of the form <literal>#{...}</literal>
and replace them with their evaluated values.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.expressions</literal></term>
<listitem>
<para>
An API for creating value and method bindings.
</para>
<itemizedlist>
<listitem>
<para>
<literal>createValueBinding(String expression)</literal> — create
a value binding object.
</para>
</listitem>
<listitem>
<para>
<literal>createMethodBinding(String expression)</literal> — create
a method binding object.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.pojoCache</literal></term>
<listitem>
<para>
Manager component for a JBoss Cache <literal>PojoCache</literal>
instance.
</para>
<itemizedlist>
<listitem>
<para>
<literal>pojoCache.cfgResourceName</literal> — the name of
the configuration file. Default to <literal>treecache.xml</literal>.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
<para>
All of these components are always installed.
</para>
</section>
<section>
<title>Components for internationalization and themes</title>
<para>
The next group of components make it easy to build internationalized user interfaces
using Seam.
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.core.locale</literal></term>
<listitem>
<para>
The Seam locale.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.international.timezone</literal></term>
<listitem>
<para>
The Seam timezone. The timezone is session scoped.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.resourceBundle</literal></term>
<listitem>
<para>
The Seam resource bundle. The resource bundle is stateless. The Seam
resource bundle performs a depth-first search for keys in a list of Java
resource bundles.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.resourceLoader</literal></term>
<listitem>
<para>
The resource loader provides access to application resources and resource bundles.
</para>
<itemizedlist>
<listitem>
<para>
<literal>resourceLoader.bundleNames</literal> — the names of
the Java resource bundles to search when the Seam resource bundle is
used. Default to <literal>messages</literal>.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.international.localeSelector</literal></term>
<listitem>
<para>
Supports selection of the locale either at configuration time,
or by the user at runtime.
</para>
<itemizedlist>
<listitem>
<para>
<literal>select()</literal> — select the specified locale.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.locale</literal> — the actual
<literal>java.util.Locale</literal>.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.localeString</literal> — the
stringified representation of the locale.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.language</literal> — the language for
the specified locale.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.country</literal> — the country for
the specified locale.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.variant</literal> — the variant for
the specified locale.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.supportedLocales</literal> — a list
of <literal>SelectItem</literal>s representing the supported locales
listed in <literal>jsf-config.xml</literal>.
</para>
</listitem>
<listitem>
<para>
<literal>localeSelector.cookieEnabled</literal> — specifies
that the locale selection should be persisted via a cookie.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.international.timezoneSelector</literal></term>
<listitem>
<para>
Supports selection of the timezone either at configuration time,
or by the user at runtime.
</para>
<itemizedlist>
<listitem>
<para>
<literal>select()</literal> — select the specified locale.
</para>
</listitem>
<listitem>
<para>
<literal>timezoneSelector.timezone</literal> — the actual
<literal>java.util.TimeZone</literal>.
</para>
</listitem>
<listitem>
<para>
<literal>timezoneSelector.timeZoneId</literal> — the
stringified representation of the timezone.
</para>
</listitem>
<listitem>
<para>
<literal>timezoneSelector.cookieEnabled</literal> — specifies
that the timezone selection should be persisted via a cookie.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.international.messages</literal></term>
<listitem>
<para>
A map containing internationalized messages rendered from message
templates defined in the Seam resource bundle.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.theme.themeSelector</literal></term>
<listitem>
<para>
Supports selection of the theme either at configuration time,
or by the user at runtime.
</para>
<itemizedlist>
<listitem>
<para>
<literal>select()</literal> — select the specified theme.
</para>
</listitem>
<listitem>
<para>
<literal>theme.availableThemes</literal> — the list of
defined themes.
</para>
</listitem>
<listitem>
<para>
<literal>themeSelector.theme</literal> — the selected
theme.
</para>
</listitem>
<listitem>
<para>
<literal>themeSelector.themes</literal> — a list
of <literal>SelectItem</literal>s representing the defined
themes.
</para>
</listitem>
<listitem>
<para>
<literal>themeSelector.cookieEnabled</literal> — specifies
that the theme selection should be persisted via a cookie.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.theme.theme</literal></term>
<listitem>
<para>
A map containing theme entries.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
All of these components are always installed.
</para>
</section>
<section>
<title>Components for controlling conversations</title>
<para>
The next group of components allow control of conversations by the application or
user interface.
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.core.conversation</literal></term>
<listitem>
<para>
API for application control of attributes of the current Seam conversation.
</para>
<itemizedlist>
<listitem>
<para>
<literal>getId()</literal> — returns the current conversation id
</para>
</listitem>
<listitem>
<para>
<literal>isNested()</literal> — is the current conversation a
nested conversation?
</para>
</listitem>
<listitem>
<para>
<literal>isLongRunning()</literal> — is the current conversation a
long-running conversation?
</para>
</listitem>
<listitem>
<para>
<literal>getId()</literal> — returns the current conversation id
</para>
</listitem>
<listitem>
<para>
<literal>getParentId()</literal> — returns the conversation id
of the parent conversation
</para>
</listitem>
<listitem>
<para>
<literal>getRootId()</literal> — returns the conversation id
of the root conversation
</para>
</listitem>
<listitem>
<para>
<literal>setTimeout(int timeout)</literal> — sets the timeout
for the current conversation
</para>
</listitem>
<listitem>
<para>
<literal>setViewId(String outcome)</literal> — sets the view id
to be used when switching back to the current conversation from the
conversation switcher, conversation list, or breadcrumbs.
</para>
</listitem>
<listitem>
<para>
<literal>setDescription(String description)</literal> — sets the
description of the current conversation to be displayed in the
conversation switcher, conversation list, or breadcrumbs.
</para>
</listitem>
<listitem>
<para>
<literal>redirect()</literal> — redirect to the last well-defined
view id for this conversation (useful after login challenges).
</para>
</listitem>
<listitem>
<para>
<literal>leave()</literal> — exit the scope of this conversation,
without actually ending the conversation.
</para>
</listitem>
<listitem>
<para>
<literal>begin()</literal> — begin a long-running conversation
(equivalent to <literal>@Begin</literal>).
</para>
</listitem>
<listitem>
<para>
<literal>beginPageflow(String pageflowName)</literal> — begin a
long-running conversation with a pageflow (equivalent to
<literal>@Begin(pageflow="...")</literal>).
</para>
</listitem>
<listitem>
<para>
<literal>end()</literal> — end a long-running conversation
(equivalent to <literal>@End</literal>).
</para>
</listitem>
<listitem>
<para>
<literal>pop()</literal> — pop the conversation stack, returning
to the parent conversation.
</para>
</listitem>
<listitem>
<para>
<literal>root()</literal> — return to the root conversation of
the conversation stack.
</para>
</listitem>
<listitem>
<para>
<literal>changeFlushMode(FlushModeType flushMode)</literal> — change
the flush mode of the conversation.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.conversationList</literal></term>
<listitem>
<para>
Manager component for the conversation list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.core.conversationStack</literal></term>
<listitem>
<para>
Manager component for the conversation stack (breadcrumbs).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.faces.switcher</literal></term>
<listitem>
<para>
The conversation switcher.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
All of these components are always installed.
</para>
</section>
<section>
<title>jBPM-related components</title>
<para>
These components are for use with jBPM.
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.pageflow.pageflow</literal></term>
<listitem>
<para>
API control of Seam pageflows.
</para>
<itemizedlist>
<listitem>
<para>
<literal>isInProcess()</literal> — returns <literal>true</literal>
if there is currently a pageflow in process
</para>
</listitem>
<listitem>
<para>
<literal>getProcessInstance()</literal> — returns jBPM
<literal>ProcessInstance</literal> for the current pageflow
</para>
</listitem>
<listitem>
<para>
<literal>begin(String pageflowName)</literal> — begin a pageflow
in the context of the current conversation
</para>
</listitem>
<listitem>
<para>
<literal>reposition(String nodeName)</literal> — reposition the
current pageflow to a particular node
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.actor</literal></term>
<listitem>
<para>
API for application control of attributes of the jBPM actor associated
with the current session.
</para>
<itemizedlist>
<listitem>
<para>
<literal>setId(String actorId)</literal> — sets the jBPM
actor id of the current user.
</para>
</listitem>
<listitem>
<para>
<literal>getGroupActorIds()</literal> — returns a
<literal>Set</literal> to which jBPM actor ids for the
current users groups may be added.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.transition</literal></term>
<listitem>
<para>
API for application control of the jBPM transition for the current
task.
</para>
<itemizedlist>
<listitem>
<para>
<literal>setName(String transitionName)</literal> — sets the
jBPM transition name to be used when the current task is ended
via <literal>@EndTask</literal>.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.businessProcess</literal></term>
<listitem>
<para>
API for programmatic control of the association between the
conversation and business process.
</para>
<itemizedlist>
<listitem>
<para>
<literal>businessProcess.taskId</literal> — the id of the task
associated with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>businessProcess.processId</literal> — the id of the process
associated with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>businessProcess.hasCurrentTask()</literal> — is a task
instance associated with the current conversation?
</para>
</listitem>
<listitem>
<para>
<literal>businessProcess.hasCurrentProcess()</literal> — is a process
instance associated with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>createProcess(String name)</literal> — create an
instance of the named process definition and associate it with
the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>startTask()</literal> — start the task
associated with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>endTask(String transitionName)</literal> — end the task
associated with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>resumeTask(Long id)</literal> — associate the task with
the given id with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>resumeProcess(Long id)</literal> — associate the process
with the given id with the current conversation.
</para>
</listitem>
<listitem>
<para>
<literal>transition(String transitionName)</literal> — trigger
the transition.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.taskInstance</literal></term>
<listitem>
<para>
Manager component for the jBPM <literal>TaskInstance</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.processInstance</literal></term>
<listitem>
<para>
Manager component for the jBPM <literal>ProcessInstance</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.jbpmContext</literal></term>
<listitem>
<para>
Manager component for an event-scoped <literal>JbpmContext</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.taskInstanceList</literal></term>
<listitem>
<para>
Manager component for the jBPM task list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.pooledTaskInstanceList</literal></term>
<listitem>
<para>
Manager component for the jBPM pooled task list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.taskInstanceListForType</literal></term>
<listitem>
<para>
Manager component for the jBPM task lists.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.pooledTask</literal></term>
<listitem>
<para>
Action handler for pooled task assignment.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.processInstanceFinder</literal></term>
<listitem>
<para>
Manager for the process instance task list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.bpm.processInstanceList</literal></term>
<listitem>
<para>
The process instance task list.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
All of these components are installed whenever the component
<literal>org.jboss.seam.bpm.jbpm</literal> is installed.
</para>
</section>
<section>
<title>Security-related components</title>
<para>
These components relate to web-tier security.
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.web.userPrincipal</literal></term>
<listitem>
<para>
Manager component for the current user <literal>Principal</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.web.isUserInRole</literal></term>
<listitem>
<para>
Allows JSF pages to choose to render a control, depending upon
the roles available to the current principal.
<literal><h:commandButton value="edit" rendered="#{isUserInRole['admin']}"/></literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>JMS-related components</title>
<para>
These components are for use with managed <literal>TopicPublisher</literal>s
and <literal>QueueSender</literal>s (see below).
</para>
<variablelist>
<varlistentry>
<term><literal>org.jboss.seam.jms.queueSession</literal></term>
<listitem>
<para>
Manager component for a JMS <literal>QueueSession</literal> .
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>org.jboss.seam.jms.topicSession</literal></term>
<listitem>
<para>
Manager component for a JMS <literal>TopicSession</literal> .
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="components.mail">
<title>Mail-related components</title>
<para>
These components are for use with Seam's Email support
</para>
<variablelist>