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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Fri Aug 22 03:44:10 EDT 2003 -->
<TITLE>
Action (Apache Struts API Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.struts.action.Action,Action class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="Action (Apache Struts API Documentation)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Action.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../org/apache/struts/action/ActionError.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Action.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.struts.action</FONT>
<BR>
Class Action</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.struts.action.Action</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/tiles/actions/DefinitionDispatcherAction.html">DefinitionDispatcherAction</A>, <A HREF="../../../../org/apache/struts/actions/DispatchAction.html">DispatchAction</A>, <A HREF="../../../../org/apache/struts/actions/ForwardAction.html">ForwardAction</A>, <A HREF="../../../../org/apache/struts/actions/IncludeAction.html">IncludeAction</A>, <A HREF="../../../../org/apache/struts/tiles/actions/NoOpAction.html">NoOpAction</A>, <A HREF="../../../../org/apache/struts/tiles/actions/ReloadDefinitionsAction.html">ReloadDefinitionsAction</A>, <A HREF="../../../../org/apache/struts/actions/SwitchAction.html">SwitchAction</A>, <A HREF="../../../../org/apache/struts/tiles/actions/TilesAction.html">TilesAction</A>, <A HREF="../../../../org/apache/struts/tiles/actions/ViewDefinitionsAction.html">ViewDefinitionsAction</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>Action</B><DT>extends java.lang.Object</DL>
<P>
An <strong>Action</strong> is an adapter between the contents of an incoming
HTTP request and the corresponding business logic that should be executed to
process this request. The controller (ActionServlet) will select an
appropriate Action for each request, create an instance (if necessary),
and call the <code>perform</code> method.</p>
<p>Actions must be programmed in a thread-safe manner, because the
controller will share the same instance for multiple simultaneous
requests. This means you should design with the following items in mind:
</p>
<ul>
<li>Instance and static variables MUST NOT be used to store information
related to the state of a particular request. They MAY be used to
share global resources across requests for the same action.</li>
<li>Access to other resources (JavaBeans, session variables, etc.) MUST
be synchronized if those resources require protection. (Generally,
however, resource classes should be designed to provide their own
protection where necessary.</li>
</ul>
<p>When an <code>Action</code> instance is first created, the controller
servlet will call <code>setServlet()</code> with a non-null argument to
identify the controller servlet instance to which this Action is attached.
When the controller servlet is to be shut down (or restarted), the
<code>setServlet()</code> method will be called with a <code>null</code>
argument, which can be used to clean up any allocated resources in use
by this Action.</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.1 $ $Date: 2003-08-22 09:14:33 +0100 (Fri, 22 Aug 2003) $</DD>
<DT><B>Author:</B></DT>
<DD>Craig R. McClanahan, David Graham</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#ACTION_SERVLET_KEY">ACTION_SERVLET_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Use Globals.ACTION_SERVLET_KEY instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#APPLICATION_KEY">APPLICATION_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#MODULE_KEY"><CODE>Globals.MODULE_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#DATA_SOURCE_KEY">DATA_SOURCE_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#DATA_SOURCE_KEY"><CODE>Globals.DATA_SOURCE_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static java.util.Locale</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#defaultLocale">defaultLocale</A></B></CODE>
<BR>
The system default Locale.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#ERROR_KEY">ERROR_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#ERROR_KEY"><CODE>Globals.ERROR_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#EXCEPTION_KEY">EXCEPTION_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#EXCEPTION_KEY"><CODE>Globals.EXCEPTION_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#FORM_BEANS_KEY">FORM_BEANS_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by collection in ModuleConfig</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#FORWARDS_KEY">FORWARDS_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by collection in ModuleConfig.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#LOCALE_KEY">LOCALE_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#LOCALE_KEY"><CODE>Globals.LOCALE_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MAPPING_KEY">MAPPING_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#MAPPING_KEY"><CODE>Globals.MAPPING_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MAPPINGS_KEY">MAPPINGS_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by collection in ModuleConfig</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MESSAGE_KEY">MESSAGE_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#MESSAGE_KEY"><CODE>Globals.MESSAGE_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MESSAGES_KEY">MESSAGES_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Use Globals.MESSAGES_KEY instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MULTIPART_KEY">MULTIPART_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Use Globals.MULTIPART_KEY instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#PLUG_INS_KEY">PLUG_INS_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#PLUG_INS_KEY"><CODE>Globals.PLUG_INS_KEY</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#REQUEST_PROCESSOR_KEY">REQUEST_PROCESSOR_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Use Globals.REQUEST_PROCESSOR_KEY instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#servlet">servlet</A></B></CODE>
<BR>
The controller servlet to which we are attached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#SERVLET_KEY">SERVLET_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Use Globals.SERVLET_KEY instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static <A HREF="../../../../org/apache/struts/util/TokenProcessor.html">TokenProcessor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#token">token</A></B></CODE>
<BR>
An instance of TokenProcessor to use for token functionality.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#TRANSACTION_TOKEN_KEY">TRANSACTION_TOKEN_KEY</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>Use Globals.TRANSACTION_TOKEN_KEY instead.</I></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#Action()">Action</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">execute</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)</CODE>
<BR>
Process the specified HTTP request, and create the corresponding HTTP
response (or forward to another web component that will create it),
with provision for handling exceptions thrown by the business logic.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">execute</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)</CODE>
<BR>
Process the specified non-HTTP request, and create the
corresponding non-HTTP response (or forward to another web
component that will create it), with provision for handling
exceptions thrown by the business logic.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#generateToken(javax.servlet.http.HttpServletRequest)">generateToken</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Generate a new transaction token, to be used for enforcing a single
request for a particular transaction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected javax.sql.DataSource</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getDataSource(javax.servlet.http.HttpServletRequest)">getDataSource</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Return the default data source for the current module.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected javax.sql.DataSource</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getDataSource(javax.servlet.http.HttpServletRequest, java.lang.String)">getDataSource</A></B>(javax.servlet.http.HttpServletRequest request,
java.lang.String key)</CODE>
<BR>
Return the specified data source for the current module.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.util.Locale</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getLocale(javax.servlet.http.HttpServletRequest)">getLocale</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Return the user's currently selected Locale.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getResources()">getResources</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>This method can only return the resources for the default
module. Use getResources(HttpServletRequest) to get the
resources for the current module.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getResources(javax.servlet.http.HttpServletRequest)">getResources</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Return the default message resources for the current module.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getResources(javax.servlet.http.HttpServletRequest, java.lang.String)">getResources</A></B>(javax.servlet.http.HttpServletRequest request,
java.lang.String key)</CODE>
<BR>
Return the specified message resources for the current module.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getServlet()">getServlet</A></B>()</CODE>
<BR>
Return the controller servlet instance to which we are attached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#isCancelled(javax.servlet.http.HttpServletRequest)">isCancelled</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Returns <code>true</code> if the current form's cancel button was
pressed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#isTokenValid(javax.servlet.http.HttpServletRequest)">isTokenValid</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Return <code>true</code> if there is a transaction token stored in
the user's current session, and the value submitted as a request
parameter with this action matches it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#isTokenValid(javax.servlet.http.HttpServletRequest, boolean)">isTokenValid</A></B>(javax.servlet.http.HttpServletRequest request,
boolean reset)</CODE>
<BR>
Return <code>true</code> if there is a transaction token stored in
the user's current session, and the value submitted as a request
parameter with this action matches it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#perform(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">perform</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)</CODE>
<BR>
<B>Deprecated.</B> <I>Use the <code>execute()</code> method instead</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#perform(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">perform</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)</CODE>
<BR>
<B>Deprecated.</B> <I>Use the <code>execute()</code> method instead</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#resetToken(javax.servlet.http.HttpServletRequest)">resetToken</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Reset the saved transaction token in the user's session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#saveErrors(javax.servlet.http.HttpServletRequest, org.apache.struts.action.ActionErrors)">saveErrors</A></B>(javax.servlet.http.HttpServletRequest request,
<A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> errors)</CODE>
<BR>
Save the specified error messages keys into the appropriate request
attribute for use by the <html:errors> tag, if any messages
are required.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#saveMessages(javax.servlet.http.HttpServletRequest, org.apache.struts.action.ActionMessages)">saveMessages</A></B>(javax.servlet.http.HttpServletRequest request,
<A HREF="../../../../org/apache/struts/action/ActionMessages.html">ActionMessages</A> messages)</CODE>
<BR>
Save the specified messages keys into the appropriate request
attribute for use by the <html:messages> tag (if
messages="true" is set), if any messages are required.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#saveToken(javax.servlet.http.HttpServletRequest)">saveToken</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
<BR>
Save a new transaction token in the user's current session, creating
a new session if necessary.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#setLocale(javax.servlet.http.HttpServletRequest, java.util.Locale)">setLocale</A></B>(javax.servlet.http.HttpServletRequest request,
java.util.Locale locale)</CODE>
<BR>
Set the user's currently selected Locale.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</CODE>
<BR>
Set the controller servlet instance to which we are attached (if
<code>servlet</code> is non-null), or release any allocated resources
(if <code>servlet</code> is null).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#toHex(byte[])">toHex</A></B>(byte[] buffer)</CODE>
<BR>
<B>Deprecated.</B> <I>This method will be removed in a release after Struts 1.1.</I></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="ACTION_SERVLET_KEY"><!-- --></A><H3>
ACTION_SERVLET_KEY</H3>
<PRE>
public static final java.lang.String <B>ACTION_SERVLET_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use Globals.ACTION_SERVLET_KEY instead.</I>
<P>
<DD>The context attributes key under which our <code>ActionServlet</code>
instance will be stored.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.ACTION_SERVLET_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="APPLICATION_KEY"><!-- --></A><H3>
APPLICATION_KEY</H3>
<PRE>
public static final java.lang.String <B>APPLICATION_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#MODULE_KEY"><CODE>Globals.MODULE_KEY</CODE></A></I>
<P>
<DD><p>The base of the context attributes key under which our
<code>ModuleConfig</code> data structure will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<p>For each request processed by the controller servlet, the
<code>ModuleConfig</code> object for the module selected by
the request URI currently being processed will also be exposed under
this key as a request attribute.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.APPLICATION_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DATA_SOURCE_KEY"><!-- --></A><H3>
DATA_SOURCE_KEY</H3>
<PRE>
public static final java.lang.String <B>DATA_SOURCE_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#DATA_SOURCE_KEY"><CODE>Globals.DATA_SOURCE_KEY</CODE></A></I>
<P>
<DD>The context attributes key under which our <strong>default</strong>
configured data source (which must implement
<code>javax.sql.DataSource</code>) is stored,
if one is configured for this module.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.DATA_SOURCE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ERROR_KEY"><!-- --></A><H3>
ERROR_KEY</H3>
<PRE>
public static final java.lang.String <B>ERROR_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#ERROR_KEY"><CODE>Globals.ERROR_KEY</CODE></A></I>
<P>
<DD>The request attributes key under which your action should store an
<code>org.apache.struts.action.ActionErrors</code> object, if you
are using the corresponding custom tag library elements.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.ERROR_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EXCEPTION_KEY"><!-- --></A><H3>
EXCEPTION_KEY</H3>
<PRE>
public static final java.lang.String <B>EXCEPTION_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#EXCEPTION_KEY"><CODE>Globals.EXCEPTION_KEY</CODE></A></I>
<P>
<DD>The request attributes key under which Struts custom tags might store a
<code>Throwable</code> that caused them to report a JspException at
runtime. This value can be used on an error page to provide more
detailed information about what really went wrong.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.EXCEPTION_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FORM_BEANS_KEY"><!-- --></A><H3>
FORM_BEANS_KEY</H3>
<PRE>
public static final java.lang.String <B>FORM_BEANS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by collection in ModuleConfig</I>
<P>
<DD>The context attributes key under which our
<code>org.apache.struts.action.ActionFormBeans</code> collection
is normally stored, unless overridden when initializing our
ActionServlet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.FORM_BEANS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FORWARDS_KEY"><!-- --></A><H3>
FORWARDS_KEY</H3>
<PRE>
public static final java.lang.String <B>FORWARDS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by collection in ModuleConfig.</I>
<P>
<DD>The context attributes key under which our
<code>org.apache.struts.action.ActionForwards</code> collection
is normally stored, unless overridden when initializing our
ActionServlet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.FORWARDS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOCALE_KEY"><!-- --></A><H3>
LOCALE_KEY</H3>
<PRE>
public static final java.lang.String <B>LOCALE_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#LOCALE_KEY"><CODE>Globals.LOCALE_KEY</CODE></A></I>
<P>
<DD>The session attributes key under which the user's selected
<code>java.util.Locale</code> is stored, if any. If no such
attribute is found, the system default locale
will be used when retrieving internationalized messages. If used, this
attribute is typically set during user login processing.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.LOCALE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MAPPING_KEY"><!-- --></A><H3>
MAPPING_KEY</H3>
<PRE>
public static final java.lang.String <B>MAPPING_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#MAPPING_KEY"><CODE>Globals.MAPPING_KEY</CODE></A></I>
<P>
<DD>The request attributes key under which our
<code>org.apache.struts.ActionMapping</code> instance
is passed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.MAPPING_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MAPPINGS_KEY"><!-- --></A><H3>
MAPPINGS_KEY</H3>
<PRE>
public static final java.lang.String <B>MAPPINGS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by collection in ModuleConfig</I>
<P>
<DD>The context attributes key under which our
<code>org.apache.struts.action.ActionMappings</code> collection
is normally stored, unless overridden when initializing our
ActionServlet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.MAPPINGS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MESSAGE_KEY"><!-- --></A><H3>
MESSAGE_KEY</H3>
<PRE>
public static final java.lang.String <B>MESSAGE_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#MESSAGE_KEY"><CODE>Globals.MESSAGE_KEY</CODE></A></I>
<P>
<DD>The request attributes key under which your action should store an
<code>org.apache.struts.action.ActionMessages</code> object, if you
are using the corresponding custom tag library elements.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.MESSAGE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MESSAGES_KEY"><!-- --></A><H3>
MESSAGES_KEY</H3>
<PRE>
public static final java.lang.String <B>MESSAGES_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use Globals.MESSAGES_KEY instead.</I>
<P>
<DD><p>The base of the context attributes key under which our
module <code>MessageResources</code> will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual resources key.</p>
<p>For each request processed by the controller servlet, the
<code>MessageResources</code> object for the module selected by
the request URI currently being processed will also be exposed under
this key as a request attribute.</p>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.MESSAGES_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MULTIPART_KEY"><!-- --></A><H3>
MULTIPART_KEY</H3>
<PRE>
public static final java.lang.String <B>MULTIPART_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use Globals.MULTIPART_KEY instead.</I>
<P>
<DD>The request attributes key under which our multipart class is stored.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.MULTIPART_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PLUG_INS_KEY"><!-- --></A><H3>
PLUG_INS_KEY</H3>
<PRE>
public static final java.lang.String <B>PLUG_INS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../org/apache/struts/Globals.html#PLUG_INS_KEY"><CODE>Globals.PLUG_INS_KEY</CODE></A></I>
<P>
<DD><p>The base of the context attributes key under which an array of
<code>PlugIn</code> instances will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.PLUG_INS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="REQUEST_PROCESSOR_KEY"><!-- --></A><H3>
REQUEST_PROCESSOR_KEY</H3>
<PRE>
public static final java.lang.String <B>REQUEST_PROCESSOR_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use Globals.REQUEST_PROCESSOR_KEY instead.</I>
<P>
<DD><p>The base of the context attributes key under which our
<code>RequestProcessor</code> instance will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.REQUEST_PROCESSOR_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SERVLET_KEY"><!-- --></A><H3>
SERVLET_KEY</H3>
<PRE>
public static final java.lang.String <B>SERVLET_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use Globals.SERVLET_KEY instead.</I>
<P>
<DD>The context attributes key under which we store the mapping defined
for our controller serlet, which will be either a path-mapped pattern
(<code>/action/*</code>) or an extension mapped pattern
(<code>*.do</code>).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.SERVLET_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TRANSACTION_TOKEN_KEY"><!-- --></A><H3>
TRANSACTION_TOKEN_KEY</H3>
<PRE>
public static final java.lang.String <B>TRANSACTION_TOKEN_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use Globals.TRANSACTION_TOKEN_KEY instead.</I>
<P>
<DD>The session attributes key under which our transaction token is
stored, if it is used.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.action.Action.TRANSACTION_TOKEN_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="token"><!-- --></A><H3>
token</H3>
<PRE>
private static <A HREF="../../../../org/apache/struts/util/TokenProcessor.html">TokenProcessor</A> <B>token</B></PRE>
<DL>
<DD>An instance of TokenProcessor to use for token functionality.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="defaultLocale"><!-- --></A><H3>
defaultLocale</H3>
<PRE>
protected static java.util.Locale <B>defaultLocale</B></PRE>
<DL>
<DD>The system default Locale.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="servlet"><!-- --></A><H3>
servlet</H3>
<PRE>
protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>servlet</B></PRE>
<DL>
<DD>The controller servlet to which we are attached.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="Action()"><!-- --></A><H3>
Action</H3>
<PRE>
public <B>Action</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getServlet()"><!-- --></A><H3>
getServlet</H3>
<PRE>
public <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>getServlet</B>()</PRE>
<DL>
<DD>Return the controller servlet instance to which we are attached.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setServlet(org.apache.struts.action.ActionServlet)"><!-- --></A><H3>
setServlet</H3>
<PRE>
public void <B>setServlet</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</PRE>
<DL>
<DD>Set the controller servlet instance to which we are attached (if
<code>servlet</code> is non-null), or release any allocated resources
(if <code>servlet</code> is null).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servlet</CODE> - The new controller servlet, if any</DL>
</DD>
</DL>
<HR>
<A NAME="execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3>
execute</H3>
<PRE>
public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>execute</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
throws java.lang.Exception</PRE>
<DL>
<DD>Process the specified non-HTTP request, and create the
corresponding non-HTTP response (or forward to another web
component that will create it), with provision for handling
exceptions thrown by the business logic.
Return an <A HREF="../../../../org/apache/struts/action/ActionForward.html"><CODE>ActionForward</CODE></A> instance describing where and how
control should be forwarded, or <code>null</code> if the response has
already been completed.
<p>
The default implementation attempts to forward to the HTTP
version of this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>form</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The non-HTTP request we are processing<DD><CODE>response</CODE> - The non-HTTP response we are creating
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if the application business logic throws
an exception<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
execute</H3>
<PRE>
public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>execute</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception</PRE>
<DL>
<DD>Process the specified HTTP request, and create the corresponding HTTP
response (or forward to another web component that will create it),
with provision for handling exceptions thrown by the business logic.
Return an <A HREF="../../../../org/apache/struts/action/ActionForward.html"><CODE>ActionForward</CODE></A> instance describing where and how
control should be forwarded, or <code>null</code> if the response
has already been completed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>form</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The HTTP request we are processing<DD><CODE>response</CODE> - The HTTP response we are creating
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if the application business logic throws
an exception<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="perform(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3>
perform</H3>
<PRE>
public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>perform</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
throws java.io.IOException,
javax.servlet.ServletException</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use the <code>execute()</code> method instead</I>
<P>
<DD>Process the specified non-HTTP request, and create the corresponding
non-HTTP response (or forward to another web component that will create
it). Return an <code>ActionForward</code> instance describing where
and how control should be forwarded, or <code>null</code> if the
response has already been completed.
<p>
The default implementation attempts to forward to the HTTP version of
this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>form</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The non-HTTP request we are processing<DD><CODE>response</CODE> - The non-HTTP response we are creating
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an input/output error occurs
<DD><CODE>javax.servlet.ServletException</CODE> - if a servlet exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="perform(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
perform</H3>
<PRE>
public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>perform</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.io.IOException,
javax.servlet.ServletException</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use the <code>execute()</code> method instead</I>
<P>
<DD>Process the specified HTTP request, and create the corresponding HTTP
response (or forward to another web component that will create it).
Return an <code>ActionForward</code> instance describing where and how
control should be forwarded, or <code>null</code> if the response has
already been completed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>form</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The HTTP request we are processing<DD><CODE>response</CODE> - The HTTP response we are creating
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an input/output error occurs
<DD><CODE>javax.servlet.ServletException</CODE> - if a servlet exception occurs</DL>
</DD>
</DL>
<HR>
<A NAME="generateToken(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
generateToken</H3>
<PRE>
protected java.lang.String <B>generateToken</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Generate a new transaction token, to be used for enforcing a single
request for a particular transaction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing</DL>
</DD>
</DL>
<HR>
<A NAME="getDataSource(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getDataSource</H3>
<PRE>
protected javax.sql.DataSource <B>getDataSource</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Return the default data source for the current module.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDataSource(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
getDataSource</H3>
<PRE>
protected javax.sql.DataSource <B>getDataSource</B>(javax.servlet.http.HttpServletRequest request,
java.lang.String key)</PRE>
<DL>
<DD>Return the specified data source for the current module.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>key</CODE> - The key specified in the
<code><message-resources></code> element for the
requested bundle<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLocale(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getLocale</H3>
<PRE>
protected java.util.Locale <B>getLocale</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Return the user's currently selected Locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing</DL>
</DD>
</DL>
<HR>
<A NAME="getResources()"><!-- --></A><H3>
getResources</H3>
<PRE>
protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>getResources</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>This method can only return the resources for the default
module. Use getResources(HttpServletRequest) to get the
resources for the current module.</I>
<P>
<DD>Return the message resources for the default module.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getResources(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getResources</H3>
<PRE>
protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>getResources</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Return the default message resources for the current module.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getResources(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
getResources</H3>
<PRE>
protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>getResources</B>(javax.servlet.http.HttpServletRequest request,
java.lang.String key)</PRE>
<DL>
<DD>Return the specified message resources for the current module.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>key</CODE> - The key specified in the
<code><message-resources></code> element for the
requested bundle<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isCancelled(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
isCancelled</H3>
<PRE>
protected boolean <B>isCancelled</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD><p>Returns <code>true</code> if the current form's cancel button was
pressed. This method will check if the <code>Globals.CANCEL_KEY</code>
request attribute has been set, which normally occurs if the cancel
button generated by <strong>CancelTag</strong> was pressed by the user
in the current request. If <code>true</code>, validation performed
by an <strong>ActionForm</strong>'s <code>validate()</code> method
will have been skipped by the controller servlet.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/struts/taglib/html/CancelTag.html"><CODE>CancelTag</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isTokenValid(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
isTokenValid</H3>
<PRE>
protected boolean <B>isTokenValid</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Return <code>true</code> if there is a transaction token stored in
the user's current session, and the value submitted as a request
parameter with this action matches it. Returns <code>false</code>
under any of the following circumstances:
<ul>
<li>No session associated with this request</li>
<li>No transaction token saved in the session</li>
<li>No transaction token included as a request parameter</li>
<li>The included transaction token value does not match the
transaction token in the user's session</li>
</ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>
</DD>
</DL>
<HR>
<A NAME="isTokenValid(javax.servlet.http.HttpServletRequest, boolean)"><!-- --></A><H3>
isTokenValid</H3>
<PRE>
protected boolean <B>isTokenValid</B>(javax.servlet.http.HttpServletRequest request,
boolean reset)</PRE>
<DL>
<DD>Return <code>true</code> if there is a transaction token stored in
the user's current session, and the value submitted as a request
parameter with this action matches it. Returns <code>false</code>
<ul>
<li>No session associated with this request</li>
<li>No transaction token saved in the session</li>
<li>No transaction token included as a request parameter</li>
<li>The included transaction token value does not match the
transaction token in the user's session</li>
</ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>reset</CODE> - Should we reset the token after checking it?</DL>
</DD>
</DL>
<HR>
<A NAME="resetToken(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
resetToken</H3>
<PRE>
protected void <B>resetToken</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Reset the saved transaction token in the user's session. This
indicates that transactional token checking will not be needed
on the next request that is submitted.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>
</DD>
</DL>
<HR>
<A NAME="saveErrors(javax.servlet.http.HttpServletRequest, org.apache.struts.action.ActionErrors)"><!-- --></A><H3>
saveErrors</H3>
<PRE>
protected void <B>saveErrors</B>(javax.servlet.http.HttpServletRequest request,
<A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> errors)</PRE>
<DL>
<DD>Save the specified error messages keys into the appropriate request
attribute for use by the <html:errors> tag, if any messages
are required. Otherwise, ensure that the request attribute is not
created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>errors</CODE> - Error messages object</DL>
</DD>
</DL>
<HR>
<A NAME="saveMessages(javax.servlet.http.HttpServletRequest, org.apache.struts.action.ActionMessages)"><!-- --></A><H3>
saveMessages</H3>
<PRE>
protected void <B>saveMessages</B>(javax.servlet.http.HttpServletRequest request,
<A HREF="../../../../org/apache/struts/action/ActionMessages.html">ActionMessages</A> messages)</PRE>
<DL>
<DD>Save the specified messages keys into the appropriate request
attribute for use by the <html:messages> tag (if
messages="true" is set), if any messages are required. Otherwise,
ensure that the request attribute is not created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>messages</CODE> - Messages object<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="saveToken(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
saveToken</H3>
<PRE>
protected void <B>saveToken</B>(javax.servlet.http.HttpServletRequest request)</PRE>
<DL>
<DD>Save a new transaction token in the user's current session, creating
a new session if necessary.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>
</DD>
</DL>
<HR>
<A NAME="setLocale(javax.servlet.http.HttpServletRequest, java.util.Locale)"><!-- --></A><H3>
setLocale</H3>
<PRE>
protected void <B>setLocale</B>(javax.servlet.http.HttpServletRequest request,
java.util.Locale locale)</PRE>
<DL>
<DD>Set the user's currently selected Locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing<DD><CODE>locale</CODE> - The user's selected Locale to be set, or null
to select the server's default Locale</DL>
</DD>
</DL>
<HR>
<A NAME="toHex(byte[])"><!-- --></A><H3>
toHex</H3>
<PRE>
protected java.lang.String <B>toHex</B>(byte[] buffer)</PRE>
<DL>
<DD><B>Deprecated.</B> <I>This method will be removed in a release after Struts 1.1.</I>
<P>
<DD>Convert a byte array to a String of hexadecimal digits and return it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The byte array to be converted</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Action.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../org/apache/struts/action/ActionError.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Action.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright 2000-2003 - Apache Software Foundation
</BODY>
</HTML>
|
