1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
5
<!-- Generated by javadoc on Fri Jun 15 16:53:35 PDT 2001 -->
7
Apache Struts API Documentation: Class ActionServlet
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
11
<BODY BGCOLOR="white">
13
<!-- ========== START OF NAVBAR ========== -->
14
<A NAME="navbar_top"><!-- --></A>
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
18
<A NAME="navbar_top_firstrow"><!-- --></A>
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
20
<TR ALIGN="center" VALIGN="top">
21
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
22
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
23
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
24
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
25
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
26
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
27
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
31
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
37
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
38
<A HREF="../../../../org/apache/struts/action/ActionMappings.html"><B>PREV CLASS</B></A>
39
<A HREF="../../../../org/apache/struts/action/AddDataSourceRule.html"><B>NEXT CLASS</B></A></FONT></TD>
40
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
41
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
42
<A HREF="ActionServlet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
45
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
46
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
47
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
48
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
51
<!-- =========== END OF NAVBAR =========== -->
54
<!-- ======== START OF CLASS DATA ======== -->
57
org.apache.struts.action</FONT>
59
Class ActionServlet</H2>
63
+--javax.servlet.GenericServlet
65
+--javax.servlet.http.HttpServlet
67
+--<B>org.apache.struts.action.ActionServlet</B>
70
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig</DD>
74
<DT>public class <B>ActionServlet</B><DT>extends javax.servlet.http.HttpServlet</DL>
77
<p><strong>ActionServlet</strong> represents the "controller" in the
78
Model-View-Controller (MVC) design pattern for web applications that is
79
commonly known as "Model 2". This nomenclature originated with a
80
description in the JavaServerPages Specification, version 0.92, and has
81
persisted ever since (in the absence of a better name).</p>
83
<p>Generally, a "Model 2" application is architected as follows:</p>
85
<li>The user interface will generally be created with JSP pages, which
86
will not themselves contain any business logic. These pages represent
87
the "view" component of an MVC architecture.</li>
88
<li>Forms and hyperlinks in the user interface that require business logic
89
to be executed will be submitted to a request URI that is mapped to the
90
controller servlet.</li>
91
<li>There will be one instance of this servlet class,
92
which receives and processes all requests that change the state of
93
a user's interaction with the application. This component represents
94
the "controller" component of an MVC architecture.</li>
95
<li>The controller servlet will select and invoke an action class to perform
96
the requested business logic.</li>
97
<li>The action classes will manipulate the state of the application's
98
interaction with the user, typically by creating or modifying JavaBeans
99
that are stored as request or session attributes (depending on how long
100
they need to be available). Such JavaBeans represent the "model"
101
component of an MVC architecture.</li>
102
<li>Instead of producing the next page of the user interface directly,
103
action classes will generally use the
104
<code>RequestDispatcher.forward()</code> facility of the servlet API
105
to pass control to an appropriate JSP page to produce the next page
106
of the user interface.</li>
109
<p>The standard version of <code>ActionServlet</code> implements the
110
following logic for each incoming HTTP request. You can override
111
some or all of this functionality by subclassing this servlet and
112
implementing your own version of the processing.</p>
114
<li>Identify, from the incoming request URI, the substring that will be
115
used to select an action procedure.</li>
116
<li>Use this substring to map to the Java class name of the corresponding
117
action class (an implementation of the <code>Action</code> interface).
119
<li>If this is the first request for a particular action class, instantiate
120
an instance of that class and cache it for future use.</li>
121
<li>Optionally populate the properties of an <code>ActionForm</code> bean
122
associated with this mapping.</li>
123
<li>Call the <code>perform()</code> method of this action class, passing
124
on a reference to the mapping that was used (thereby providing access
125
to the underlying ActionServlet and ServletContext, as well as any
126
specialized properties of the mapping itself), and the request and
127
response that were passed to the controller by the servlet container.
131
<p>The standard version of <code>ActionServlet</code> is configured based
132
on the following servlet initialization parameters, which you will specify
133
in the web application deployment descriptor (<code>/WEB-INF/web.xml</code>)
134
for your application. Subclasses that specialize this servlet are free to
135
define additional initialization parameters.</p>
137
<li><strong>application</strong> - Java class name of the application
138
resources bundle base class. [NONE]</li>
139
<li><strong>bufferSize</strong> - The size of the input buffer used when
140
processing file uploads. [4096]</li>
141
<li><strong>config</strong> - Context-relative path to the XML resource
142
containing our configuration information.
143
[/WEB-INF/struts-config.xml]</li>
144
<li><strong>content</strong> - Default content type and character encoding
145
to be set on each response; may be overridden by a forwarded-to
146
servlet or JSP page. [text/html]</li>
147
<li><strong>debug</strong> - The debugging detail level for this
148
servlet, which controls how much information is logged. [0]</li>
149
<li><strong>detail</strong> - The debugging detail level for the Digester
150
we utilize in <code>initMapping()</code>, which logs to System.out
151
instead of the servlet log. [0]</li>
152
<li><strong>factory</strong> - The Java class name of the
153
<code>MessageResourcesFactory</code> used to create the application
154
<code>MessageResources</code> object.</li>
155
<li><strong>formBean</strong> - The Java class name of the ActionFormBean
156
implementation to use [org.apache.struts.action.ActionFormBean].
157
<li><strong>forward</strong> - The Java class name of the ActionForward
158
implementation to use [org.apache.struts.action.ActionForward].
159
Two convenient classes you may wish to use are:
161
<li><em>org.apache.struts.action.ForwardingActionForward</em> -
162
Subclass of <code>org.apache.struts.action.ActionForward</code>
163
that defaults the <code>redirect</code> property to
164
<code>false</code> (same as the ActionForward default value).
165
<li><em>org.apache.struts.action.RedirectingActionForward</em> -
166
Subclass of <code>org.apache.struts.action.ActionForward</code>
167
that defaults the <code>redirect</code> property to
170
<li><strong>locale</strong> - If set to <code>true</code>, and there is a
171
user session, identify and store an appropriate
172
<code>java.util.Locale</code> object (under the standard key
173
identified by <code>Action.LOCALE_KEY</code>) in the user's session
174
if there is not a Locale object there already.</li>
175
<li><strong>mapping</strong> - The Java class name of the ActionMapping
176
implementation to use [org.apache.struts.action.ActionMapping].
177
Two convenient classes you may wish to use are:
179
<li><em>org.apache.struts.action.RequestActionMapping</em> - Subclass
180
of <code>org.apache.struts.action.ActionMapping</code> that
181
defaults the <code>scope</code> property to "request".
182
<li><em>org.apache.struts.action.SessionActionMapping</em> - Subclass
183
of <code>org.apache.struts.action.ActionMapping</code> that
184
defaults the <code>scope</code> property to "session". (Same
185
as the ActionMapping default value).
187
<li><strong>maxFileSize</strong> - The maximum size (in bytes) of a file
188
to be accepted as a file upload. Can be expressed as a number followed
189
by a "K" "M", or "G", which are interpreted to mean kilobytes,
190
megabytes, or gigabytes, respectively. [250M]</li>
191
<li><strong>multipartClass</strong> - The fully qualified name of the
192
MultiplartRequestHandler implementation class to be used for processing
193
file uploads. [org.apache.struts.upload.DiskMultipartRequestHandler]
195
<li><strong>nocache</strong> - If set to <code>true</code>, add HTTP headers
196
to every response intended to defeat browser caching of any response we
197
generate or forward to. [false]</li>
198
<li><strong>null</strong> - If set to <code>true</code>, set our application
199
resources to return <code>null</code> if an unknown message key is used.
200
Otherwise, an error message including the offending message key will
201
be returned. [true]</li>
202
<li><strong>tempDir</strong> - The temporary working directory to use when
203
processing file uploads. [The working directory provided to this web
204
application as a servlet context attribute]</li>
205
<li><strong>validate</strong> - Are we using the new configuration file
207
<li><strong>validating</strong> - Should we use a validating XML parse to
208
process the configuration file (strongly recommended)? [true]</li>
212
<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date: 2001/09/17 20:03:01 $</DD>
213
<DT><B>Author: </B><DD>Craig R. McClanahan</DD>
214
<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.struts.action.ActionServlet">Serialized Form</A></DL>
218
<!-- ======== INNER CLASS SUMMARY ======== -->
221
<!-- =========== FIELD SUMMARY =========== -->
223
<A NAME="field_summary"><!-- --></A>
224
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
225
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
226
<TD COLSPAN=2><FONT SIZE="+2">
227
<B>Field Summary</B></FONT></TD>
229
<TR BGCOLOR="white" CLASS="TableRowColor">
230
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231
<CODE>protected <A HREF="../../../../org/apache/struts/util/FastHashMap.html">FastHashMap</A></CODE></FONT></TD>
232
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#actions">actions</A></B></CODE>
235
The set of Action instances that have been created and initialized,
236
keyed by the fully qualified Java class name.</TD>
238
<TR BGCOLOR="white" CLASS="TableRowColor">
239
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240
<CODE>protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
241
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#application">application</A></B></CODE>
244
The resources object for our application resources (if any).</TD>
246
<TR BGCOLOR="white" CLASS="TableRowColor">
247
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248
<CODE>protected int</CODE></FONT></TD>
249
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#bufferSize">bufferSize</A></B></CODE>
252
The size in bytes of the buffer used to read files from a client upload</TD>
254
<TR BGCOLOR="white" CLASS="TableRowColor">
255
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256
<CODE>protected java.lang.String</CODE></FONT></TD>
257
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#config">config</A></B></CODE>
260
The context-relative path to our configuration resource.</TD>
262
<TR BGCOLOR="white" CLASS="TableRowColor">
263
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264
<CODE>protected java.lang.String</CODE></FONT></TD>
265
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#content">content</A></B></CODE>
268
The default content type and character encoding to be set on each
269
response (may be overridden by forwarded-to resources).</TD>
271
<TR BGCOLOR="white" CLASS="TableRowColor">
272
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273
<CODE>protected <A HREF="../../../../org/apache/struts/util/FastHashMap.html">FastHashMap</A></CODE></FONT></TD>
274
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#dataSources">dataSources</A></B></CODE>
277
The JDBC data sources that has been configured for this application,
278
if any, keyed by the servlet context attribute under which they are
281
<TR BGCOLOR="white" CLASS="TableRowColor">
282
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283
<CODE>protected int</CODE></FONT></TD>
284
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#debug">debug</A></B></CODE>
287
The debugging detail level for this servlet.</TD>
289
<TR BGCOLOR="white" CLASS="TableRowColor">
290
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291
<CODE>protected java.util.Locale</CODE></FONT></TD>
292
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#defaultLocale">defaultLocale</A></B></CODE>
295
The default Locale for this server.</TD>
297
<TR BGCOLOR="white" CLASS="TableRowColor">
298
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299
<CODE>protected java.lang.String</CODE></FONT></TD>
300
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#factoryClass">factoryClass</A></B></CODE>
303
The Java class name of the <code>MessageResourcesFactory</code>
304
class for the application message resources bundle.</TD>
306
<TR BGCOLOR="white" CLASS="TableRowColor">
307
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
308
<CODE>protected java.lang.String</CODE></FONT></TD>
309
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#formBeanClass">formBeanClass</A></B></CODE>
312
The Java class name of the ActionFormBean implementation class to use.</TD>
314
<TR BGCOLOR="white" CLASS="TableRowColor">
315
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
316
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionFormBeans.html">ActionFormBeans</A></CODE></FONT></TD>
317
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#formBeans">formBeans</A></B></CODE>
320
The global ActionFormBean collection for this controller.</TD>
322
<TR BGCOLOR="white" CLASS="TableRowColor">
323
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324
<CODE>protected java.lang.String</CODE></FONT></TD>
325
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#forwardClass">forwardClass</A></B></CODE>
328
The Java class name of the ActionForward implementation class to use.</TD>
330
<TR BGCOLOR="white" CLASS="TableRowColor">
331
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionForwards.html">ActionForwards</A></CODE></FONT></TD>
333
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#forwards">forwards</A></B></CODE>
336
The global ActionForward collection for this controller.</TD>
338
<TR BGCOLOR="white" CLASS="TableRowColor">
339
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
340
<CODE>protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
341
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#internal">internal</A></B></CODE>
344
The resources object for our internal resources.</TD>
346
<TR BGCOLOR="white" CLASS="TableRowColor">
347
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
348
<CODE>protected java.lang.String</CODE></FONT></TD>
349
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#internalName">internalName</A></B></CODE>
352
The Java base name of our internal resources.</TD>
354
<TR BGCOLOR="white" CLASS="TableRowColor">
355
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
356
<CODE>protected boolean</CODE></FONT></TD>
357
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#locale">locale</A></B></CODE>
360
Should we create a <code>java.util.Locale</code> for this user,
361
based on the HTTP headers of the request, if one is not present?</TD>
363
<TR BGCOLOR="white" CLASS="TableRowColor">
364
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
365
<CODE>protected java.lang.String</CODE></FONT></TD>
366
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#mappingClass">mappingClass</A></B></CODE>
369
The Java class name of our ActionMapping implementation class.</TD>
371
<TR BGCOLOR="white" CLASS="TableRowColor">
372
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A></CODE></FONT></TD>
374
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#mappings">mappings</A></B></CODE>
377
The configured mappings for this web application, keyed by path.</TD>
379
<TR BGCOLOR="white" CLASS="TableRowColor">
380
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381
<CODE>protected java.lang.String</CODE></FONT></TD>
382
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#maxFileSize">maxFileSize</A></B></CODE>
385
The maximum size allowed for a client upload.</TD>
387
<TR BGCOLOR="white" CLASS="TableRowColor">
388
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
389
<CODE>protected java.lang.String</CODE></FONT></TD>
390
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#multipartClass">multipartClass</A></B></CODE>
393
The MultipartRequestHandler class name used for handling
394
multipart form requests.</TD>
396
<TR BGCOLOR="white" CLASS="TableRowColor">
397
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
398
<CODE>protected boolean</CODE></FONT></TD>
399
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#nocache">nocache</A></B></CODE>
402
Include the no-caching headers in our response?</TD>
404
<TR BGCOLOR="white" CLASS="TableRowColor">
405
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
406
<CODE>protected java.lang.String[]</CODE></FONT></TD>
407
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#registrations">registrations</A></B></CODE>
410
The set of public identifiers, and corresponding resource names, for
411
the versions of the configuration file DTDs that we know about.</TD>
413
<TR BGCOLOR="white" CLASS="TableRowColor">
414
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
415
<CODE>protected java.lang.String</CODE></FONT></TD>
416
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#servletMapping">servletMapping</A></B></CODE>
419
The URL pattern to which we are mapped in our web application
420
deployment descriptor.</TD>
422
<TR BGCOLOR="white" CLASS="TableRowColor">
423
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
424
<CODE>protected java.lang.String</CODE></FONT></TD>
425
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#servletName">servletName</A></B></CODE>
428
The servlet name under which we are registered in our web application
429
deployment descriptor.</TD>
431
<TR BGCOLOR="white" CLASS="TableRowColor">
432
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
433
<CODE>protected java.lang.String</CODE></FONT></TD>
434
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#tempDir">tempDir</A></B></CODE>
437
The directory used to store temporary files for the DiskMultipartRequestHandler
438
multipart implementation</TD>
440
<TR BGCOLOR="white" CLASS="TableRowColor">
441
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
442
<CODE>protected boolean</CODE></FONT></TD>
443
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#validate">validate</A></B></CODE>
446
Are we using the new configuration file format?</TD>
448
<TR BGCOLOR="white" CLASS="TableRowColor">
449
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
450
<CODE>protected boolean</CODE></FONT></TD>
451
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#validating">validating</A></B></CODE>
454
Should we use a validating XML parser to read the configuration file?</TD>
457
<A NAME="fields_inherited_from_class_javax.servlet.http.HttpServlet"><!-- --></A>
458
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
459
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
460
<TD><B>Fields inherited from class javax.servlet.http.HttpServlet</B></TD>
462
<TR BGCOLOR="white" CLASS="TableRowColor">
463
<TD><CODE>HEADER_IFMODSINCE, HEADER_LASTMOD, LSTRING_FILE, lStrings, METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_OPTIONS, METHOD_POST, METHOD_PUT, METHOD_TRACE</CODE></TD>
467
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
469
<A NAME="constructor_summary"><!-- --></A>
470
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
471
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
472
<TD COLSPAN=2><FONT SIZE="+2">
473
<B>Constructor Summary</B></FONT></TD>
475
<TR BGCOLOR="white" CLASS="TableRowColor">
476
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#ActionServlet()">ActionServlet</A></B>()</CODE>
479
</TD>
483
<!-- ========== METHOD SUMMARY =========== -->
485
<A NAME="method_summary"><!-- --></A>
486
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
487
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
488
<TD COLSPAN=2><FONT SIZE="+2">
489
<B>Method Summary</B></FONT></TD>
491
<TR BGCOLOR="white" CLASS="TableRowColor">
492
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
493
<CODE> void</CODE></FONT></TD>
494
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#addDataSource(java.lang.String, javax.sql.DataSource)">addDataSource</A></B>(java.lang.String key,
495
javax.sql.DataSource dataSource)</CODE>
498
Add a data source object to be used by this application.</TD>
500
<TR BGCOLOR="white" CLASS="TableRowColor">
501
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
502
<CODE> void</CODE></FONT></TD>
503
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#addFormBean(org.apache.struts.action.ActionFormBean)">addFormBean</A></B>(<A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A> formBean)</CODE>
506
Register a form bean definition to the set configured for this servlet.</TD>
508
<TR BGCOLOR="white" CLASS="TableRowColor">
509
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
510
<CODE> void</CODE></FONT></TD>
511
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#addForward(org.apache.struts.action.ActionForward)">addForward</A></B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</CODE>
514
Register a logical forwarding to the set configured for this servlet.</TD>
516
<TR BGCOLOR="white" CLASS="TableRowColor">
517
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
518
<CODE> void</CODE></FONT></TD>
519
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#addMapping(org.apache.struts.action.ActionMapping)">addMapping</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</CODE>
522
Register a mapping to the set configured for this servlet.</TD>
524
<TR BGCOLOR="white" CLASS="TableRowColor">
525
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
526
<CODE> void</CODE></FONT></TD>
527
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#addServletMapping(java.lang.String, java.lang.String)">addServletMapping</A></B>(java.lang.String servletName,
528
java.lang.String urlPattern)</CODE>
531
Remember a servlet mapping from our web application deployment
532
descriptor, if it is for this servlet.</TD>
534
<TR BGCOLOR="white" CLASS="TableRowColor">
535
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
536
<CODE> void</CODE></FONT></TD>
537
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#destroy()">destroy</A></B>()</CODE>
540
Gracefully shut down this controller servlet, releasing any resources
541
that were allocated at initialization.</TD>
543
<TR BGCOLOR="white" CLASS="TableRowColor">
544
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
545
<CODE>protected void</CODE></FONT></TD>
546
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#destroyActions()">destroyActions</A></B>()</CODE>
549
Gracefully shut down any action instances we have created.</TD>
551
<TR BGCOLOR="white" CLASS="TableRowColor">
552
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
553
<CODE>protected void</CODE></FONT></TD>
554
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#destroyApplication()">destroyApplication</A></B>()</CODE>
557
Gracefully terminate use of the application MessageResources (if any).</TD>
559
<TR BGCOLOR="white" CLASS="TableRowColor">
560
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
561
<CODE>protected void</CODE></FONT></TD>
562
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#destroyDataSources()">destroyDataSources</A></B>()</CODE>
565
Gracefully terminate use of the data source associated with this
566
application (if any).</TD>
568
<TR BGCOLOR="white" CLASS="TableRowColor">
569
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
570
<CODE>protected void</CODE></FONT></TD>
571
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#destroyInternal()">destroyInternal</A></B>()</CODE>
574
Gracefully terminate use of the internal MessageResources.</TD>
576
<TR BGCOLOR="white" CLASS="TableRowColor">
577
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
578
<CODE> void</CODE></FONT></TD>
579
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doGet</A></B>(javax.servlet.http.HttpServletRequest request,
580
javax.servlet.http.HttpServletResponse response)</CODE>
583
Process an HTTP "GET" request.</TD>
585
<TR BGCOLOR="white" CLASS="TableRowColor">
586
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
587
<CODE> void</CODE></FONT></TD>
588
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doPost</A></B>(javax.servlet.http.HttpServletRequest request,
589
javax.servlet.http.HttpServletResponse response)</CODE>
592
Process an HTTP "POST" request.</TD>
594
<TR BGCOLOR="white" CLASS="TableRowColor">
595
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
596
<CODE> javax.sql.DataSource</CODE></FONT></TD>
597
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#findDataSource(java.lang.String)">findDataSource</A></B>(java.lang.String key)</CODE>
600
Return a JDBC data source associated with this application, if any.</TD>
602
<TR BGCOLOR="white" CLASS="TableRowColor">
603
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
604
<CODE> <A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A></CODE></FONT></TD>
605
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#findFormBean(java.lang.String)">findFormBean</A></B>(java.lang.String name)</CODE>
608
Return the form bean definition associated with the specified
609
logical name, if any; otherwise return <code>null</code>.</TD>
611
<TR BGCOLOR="white" CLASS="TableRowColor">
612
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
613
<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>
614
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#findForward(java.lang.String)">findForward</A></B>(java.lang.String name)</CODE>
617
Return the forwarding associated with the specified logical name,
618
if any; otherwise return <code>null</code>.</TD>
620
<TR BGCOLOR="white" CLASS="TableRowColor">
621
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
622
<CODE> <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A></CODE></FONT></TD>
623
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#findMapping(java.lang.String)">findMapping</A></B>(java.lang.String path)</CODE>
626
Return the mapping associated with the specified request path, if any;
627
otherwise return <code>null</code>.</TD>
629
<TR BGCOLOR="white" CLASS="TableRowColor">
630
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
631
<CODE> int</CODE></FONT></TD>
632
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getBufferSize()">getBufferSize</A></B>()</CODE>
635
Get the buffer size (how large of a chunk of data is
636
recieved by the input stream at once) used for file
639
<TR BGCOLOR="white" CLASS="TableRowColor">
640
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
641
<CODE> int</CODE></FONT></TD>
642
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getDebug()">getDebug</A></B>()</CODE>
645
Return the debugging detail level for this servlet.</TD>
647
<TR BGCOLOR="white" CLASS="TableRowColor">
648
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
649
<CODE> java.lang.String</CODE></FONT></TD>
650
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getFormBeanClass()">getFormBeanClass</A></B>()</CODE>
653
Return the Java class name of the class used to instantiate
654
<code>ActionFormBean</code> objects.</TD>
656
<TR BGCOLOR="white" CLASS="TableRowColor">
657
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
658
<CODE> java.lang.String</CODE></FONT></TD>
659
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getForwardClass()">getForwardClass</A></B>()</CODE>
662
Return the Java class name of the class used to instantiate
663
<code>ActionForward</code> objects.</TD>
665
<TR BGCOLOR="white" CLASS="TableRowColor">
666
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
667
<CODE> java.lang.String</CODE></FONT></TD>
668
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getMappingClass()">getMappingClass</A></B>()</CODE>
671
Return the Java class name of the class used to instantiate
672
<code>ActionMapping</code> objects.</TD>
674
<TR BGCOLOR="white" CLASS="TableRowColor">
675
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
676
<CODE> java.lang.String</CODE></FONT></TD>
677
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getMaxFileSize()">getMaxFileSize</A></B>()</CODE>
680
Get the maximum file size.</TD>
682
<TR BGCOLOR="white" CLASS="TableRowColor">
683
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
684
<CODE> java.lang.String</CODE></FONT></TD>
685
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getMultipartClass()">getMultipartClass</A></B>()</CODE>
688
Get the class name of the MultipartRequestHandler implementation</TD>
690
<TR BGCOLOR="white" CLASS="TableRowColor">
691
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
692
<CODE> <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
693
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getResources()">getResources</A></B>()</CODE>
696
Return the application resources for this web application, if any.</TD>
698
<TR BGCOLOR="white" CLASS="TableRowColor">
699
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
700
<CODE> java.lang.String</CODE></FONT></TD>
701
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#getTempDir()">getTempDir</A></B>()</CODE>
704
Get the directory used to temporarily store form files</TD>
706
<TR BGCOLOR="white" CLASS="TableRowColor">
707
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
708
<CODE> void</CODE></FONT></TD>
709
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#init()">init</A></B>()</CODE>
712
Initialize this servlet.</TD>
714
<TR BGCOLOR="white" CLASS="TableRowColor">
715
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
716
<CODE>protected void</CODE></FONT></TD>
717
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initActions()">initActions</A></B>()</CODE>
720
Initialize the collection of previously instantiated Action instances.</TD>
722
<TR BGCOLOR="white" CLASS="TableRowColor">
723
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
724
<CODE>protected void</CODE></FONT></TD>
725
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initApplication()">initApplication</A></B>()</CODE>
728
Initialize the MessageResources bundle for this application, if any.</TD>
730
<TR BGCOLOR="white" CLASS="TableRowColor">
731
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
732
<CODE>protected void</CODE></FONT></TD>
733
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initDataSources()">initDataSources</A></B>()</CODE>
736
Initialize use of the data sources associated with this
737
application (if any).</TD>
739
<TR BGCOLOR="white" CLASS="TableRowColor">
740
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
741
<CODE>protected void</CODE></FONT></TD>
742
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initDebug()">initDebug</A></B>()</CODE>
745
Initialize the debugging detail level for this application.</TD>
747
<TR BGCOLOR="white" CLASS="TableRowColor">
748
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
749
<CODE>protected <A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A></CODE></FONT></TD>
750
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initDigester(int)">initDigester</A></B>(int detail)</CODE>
753
Construct and return a digester that uses the new configuration
756
<TR BGCOLOR="white" CLASS="TableRowColor">
757
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
758
<CODE>protected <A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A></CODE></FONT></TD>
759
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initDigesterOld(int)">initDigesterOld</A></B>(int detail)</CODE>
762
Construct and return a digester that uses the old configuration
765
<TR BGCOLOR="white" CLASS="TableRowColor">
766
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
767
<CODE>protected void</CODE></FONT></TD>
768
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initInternal()">initInternal</A></B>()</CODE>
771
Initialize our internal MessageResources bundle.</TD>
773
<TR BGCOLOR="white" CLASS="TableRowColor">
774
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
775
<CODE>protected void</CODE></FONT></TD>
776
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initMapping()">initMapping</A></B>()</CODE>
779
Initialize the mapping information for this application.</TD>
781
<TR BGCOLOR="white" CLASS="TableRowColor">
782
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
783
<CODE>protected void</CODE></FONT></TD>
784
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initOther()">initOther</A></B>()</CODE>
787
Initialize other configuration parameters that have not yet
790
<TR BGCOLOR="white" CLASS="TableRowColor">
791
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
792
<CODE>protected void</CODE></FONT></TD>
793
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initServlet()">initServlet</A></B>()</CODE>
796
Initialize the servlet mapping under which our controller servlet
797
is being accessed.</TD>
799
<TR BGCOLOR="white" CLASS="TableRowColor">
800
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
801
<CODE>protected void</CODE></FONT></TD>
802
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#initUpload()">initUpload</A></B>()</CODE>
805
Initialize upload parameters and "bufferSize", "multipartClass",
806
"maxFileSize", "tempDir"</TD>
808
<TR BGCOLOR="white" CLASS="TableRowColor">
809
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
810
<CODE> void</CODE></FONT></TD>
811
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#log(java.lang.String, int)">log</A></B>(java.lang.String message,
812
int level)</CODE>
815
Log the specified message if the current debugging detail level for
816
this servlet has been set to an equal or higher value.</TD>
818
<TR BGCOLOR="white" CLASS="TableRowColor">
819
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
820
<CODE>protected void</CODE></FONT></TD>
821
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">process</A></B>(javax.servlet.http.HttpServletRequest request,
822
javax.servlet.http.HttpServletResponse response)</CODE>
825
Process an HTTP request.</TD>
827
<TR BGCOLOR="white" CLASS="TableRowColor">
828
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
829
<CODE>protected <A HREF="../../../../org/apache/struts/action/Action.html">Action</A></CODE></FONT></TD>
830
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processActionCreate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)">processActionCreate</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
831
javax.servlet.http.HttpServletRequest request)</CODE>
834
Create or retrieve the Action instance that will process this request,
835
or <code>null</code> if no such Action instance can be created.</TD>
837
<TR BGCOLOR="white" CLASS="TableRowColor">
838
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
839
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A></CODE></FONT></TD>
840
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processActionForm(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)">processActionForm</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
841
javax.servlet.http.HttpServletRequest request)</CODE>
844
Retrieve and return the <code>ActionForm</code> bean associated with
845
this mapping, creating and stashing one if necessary.</TD>
847
<TR BGCOLOR="white" CLASS="TableRowColor">
848
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
849
<CODE>protected void</CODE></FONT></TD>
850
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processActionForward(org.apache.struts.action.ActionForward, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processActionForward</A></B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward,
851
<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
852
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
853
javax.servlet.http.HttpServletRequest request,
854
javax.servlet.http.HttpServletResponse response)</CODE>
857
Forward to the specified destination, by the specified mechanism,
858
if an <code>ActionForward</code> instance was returned by the
859
<code>Action</code>.</TD>
861
<TR BGCOLOR="white" CLASS="TableRowColor">
862
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
863
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>
864
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processActionPerform(org.apache.struts.action.Action, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processActionPerform</A></B>(<A HREF="../../../../org/apache/struts/action/Action.html">Action</A> action,
865
<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
866
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
867
javax.servlet.http.HttpServletRequest request,
868
javax.servlet.http.HttpServletResponse response)</CODE>
871
Ask the specified Action instance to handle this request.</TD>
873
<TR BGCOLOR="white" CLASS="TableRowColor">
874
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
875
<CODE>protected void</CODE></FONT></TD>
876
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processContent(javax.servlet.http.HttpServletResponse)">processContent</A></B>(javax.servlet.http.HttpServletResponse response)</CODE>
879
Set the default content type (with optional character encoding) for
882
<TR BGCOLOR="white" CLASS="TableRowColor">
883
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
884
<CODE>protected boolean</CODE></FONT></TD>
885
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processForward(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processForward</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
886
javax.servlet.http.HttpServletRequest request,
887
javax.servlet.http.HttpServletResponse response)</CODE>
890
Process a forward requested by this mapping, if any.</TD>
892
<TR BGCOLOR="white" CLASS="TableRowColor">
893
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
894
<CODE>protected boolean</CODE></FONT></TD>
895
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processInclude(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processInclude</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
896
javax.servlet.http.HttpServletRequest request,
897
javax.servlet.http.HttpServletResponse response)</CODE>
900
Process an include requested by this mapping, if any.</TD>
902
<TR BGCOLOR="white" CLASS="TableRowColor">
903
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
904
<CODE>protected void</CODE></FONT></TD>
905
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processLocale(javax.servlet.http.HttpServletRequest)">processLocale</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
908
Automatically calculate an appropriate <code>java.util.Locale</code>
909
for this user, and store it in their session, if there is no such
910
Locale object present already.</TD>
912
<TR BGCOLOR="white" CLASS="TableRowColor">
913
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
914
<CODE>protected <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A></CODE></FONT></TD>
915
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processMapping(java.lang.String, javax.servlet.http.HttpServletRequest)">processMapping</A></B>(java.lang.String path,
916
javax.servlet.http.HttpServletRequest request)</CODE>
919
Identify and return an appropriate ActionMapping for the specified
922
<TR BGCOLOR="white" CLASS="TableRowColor">
923
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
924
<CODE>protected void</CODE></FONT></TD>
925
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processNoCache(javax.servlet.http.HttpServletResponse)">processNoCache</A></B>(javax.servlet.http.HttpServletResponse response)</CODE>
928
Render the HTTP headers to defeat browser caching if requested.</TD>
930
<TR BGCOLOR="white" CLASS="TableRowColor">
931
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
932
<CODE>protected java.lang.String</CODE></FONT></TD>
933
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processPath(javax.servlet.http.HttpServletRequest)">processPath</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>
936
Identify and return the path component (from the request URI) that
937
we will use to select an ActionMapping to dispatch with.</TD>
939
<TR BGCOLOR="white" CLASS="TableRowColor">
940
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
941
<CODE>protected void</CODE></FONT></TD>
942
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processPopulate(org.apache.struts.action.ActionForm, org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)">processPopulate</A></B>(<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
943
<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
944
javax.servlet.http.HttpServletRequest request)</CODE>
947
Populate the properties of the specified ActionForm from the request
948
parameters included with this request.</TD>
950
<TR BGCOLOR="white" CLASS="TableRowColor">
951
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
952
<CODE>protected boolean</CODE></FONT></TD>
953
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processPreprocess(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processPreprocess</A></B>(javax.servlet.http.HttpServletRequest request,
954
javax.servlet.http.HttpServletResponse response)</CODE>
957
General purpose preprocessing hook that can be overridden to support
958
application specific preprocessing activity.</TD>
960
<TR BGCOLOR="white" CLASS="TableRowColor">
961
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
962
<CODE>protected boolean</CODE></FONT></TD>
963
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#processValidate(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processValidate</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
964
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
965
javax.servlet.http.HttpServletRequest request,
966
javax.servlet.http.HttpServletResponse response)</CODE>
969
Call the <code>validate()</code> method of the specified ActionForm,
970
and forward back to the input form if there are any errors.</TD>
972
<TR BGCOLOR="white" CLASS="TableRowColor">
973
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
974
<CODE> void</CODE></FONT></TD>
975
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#reload()">reload</A></B>()</CODE>
978
Reload the configuration of this controller servlet from our
979
underlying configuration files.</TD>
981
<TR BGCOLOR="white" CLASS="TableRowColor">
982
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
983
<CODE> void</CODE></FONT></TD>
984
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#removeFormBean(org.apache.struts.action.ActionFormBean)">removeFormBean</A></B>(<A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A> formBean)</CODE>
987
Deregister a form bean definition from the set configured for
990
<TR BGCOLOR="white" CLASS="TableRowColor">
991
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
992
<CODE> void</CODE></FONT></TD>
993
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#removeForward(org.apache.struts.action.ActionForward)">removeForward</A></B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</CODE>
996
Deregister a forwarding from the set configured for this servlet.</TD>
998
<TR BGCOLOR="white" CLASS="TableRowColor">
999
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1000
<CODE> void</CODE></FONT></TD>
1001
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#removeMapping(org.apache.struts.action.ActionMapping)">removeMapping</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</CODE>
1004
Deregister a mapping from the set configured for this servlet.</TD>
1006
<TR BGCOLOR="white" CLASS="TableRowColor">
1007
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1008
<CODE> void</CODE></FONT></TD>
1009
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setBufferSize(int)">setBufferSize</A></B>(int bufferSize)</CODE>
1012
Set the buffer size (how large of a chunk of data is
1013
recieved by the input stream at once) used for file
1016
<TR BGCOLOR="white" CLASS="TableRowColor">
1017
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1018
<CODE> void</CODE></FONT></TD>
1019
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setFormBeanClass(java.lang.String)">setFormBeanClass</A></B>(java.lang.String formBeanClass)</CODE>
1022
Set the Java class name of the class used to instantiate
1023
<code>ActionFormBean</code> objects.</TD>
1025
<TR BGCOLOR="white" CLASS="TableRowColor">
1026
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1027
<CODE> void</CODE></FONT></TD>
1028
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setForwardClass(java.lang.String)">setForwardClass</A></B>(java.lang.String forwardClass)</CODE>
1031
Set the Java class name of the class used to instantiate
1032
<code>ActionForward</code> objects.</TD>
1034
<TR BGCOLOR="white" CLASS="TableRowColor">
1035
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1036
<CODE> void</CODE></FONT></TD>
1037
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setMappingClass(java.lang.String)">setMappingClass</A></B>(java.lang.String mappingClass)</CODE>
1040
Set the Java class name of the class used to instantiate
1041
<code>ActionMapping</code> objects.</TD>
1043
<TR BGCOLOR="white" CLASS="TableRowColor">
1044
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1045
<CODE> void</CODE></FONT></TD>
1046
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setMaxFileSize(java.lang.String)">setMaxFileSize</A></B>(java.lang.String maxFileSize)</CODE>
1049
Set the maximum file size that a client can upload, number String with a trailing
1050
letter indicating the size.</TD>
1052
<TR BGCOLOR="white" CLASS="TableRowColor">
1053
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1054
<CODE> void</CODE></FONT></TD>
1055
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setMultipartClass(java.lang.String)">setMultipartClass</A></B>(java.lang.String multipartClass)</CODE>
1058
Set the class name of the MultipartRequestHandler implementation</TD>
1060
<TR BGCOLOR="white" CLASS="TableRowColor">
1061
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1062
<CODE> void</CODE></FONT></TD>
1063
<TD><CODE><B><A HREF="../../../../org/apache/struts/action/ActionServlet.html#setTempDir(java.lang.String)">setTempDir</A></B>(java.lang.String tempDir)</CODE>
1066
Set the directory used to temporarily store files for MultipartRequestHandler
1067
implementations that write to the disk</TD>
1070
<A NAME="methods_inherited_from_class_javax.servlet.http.HttpServlet"><!-- --></A>
1071
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1072
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
1073
<TD><B>Methods inherited from class javax.servlet.http.HttpServlet</B></TD>
1075
<TR BGCOLOR="white" CLASS="TableRowColor">
1076
<TD><CODE><clinit>, doDelete, doHead, doOptions, doPut, doTrace, getAllDeclaredMethods, getLastModified, maybeSetLastModified, service, service</CODE></TD>
1079
<A NAME="methods_inherited_from_class_javax.servlet.GenericServlet"><!-- --></A>
1080
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1081
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
1082
<TD><B>Methods inherited from class javax.servlet.GenericServlet</B></TD>
1084
<TR BGCOLOR="white" CLASS="TableRowColor">
1085
<TD><CODE>getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log</CODE></TD>
1088
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
1089
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1090
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
1091
<TD><B>Methods inherited from class java.lang.Object</B></TD>
1093
<TR BGCOLOR="white" CLASS="TableRowColor">
1094
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD>
1100
<!-- ============ FIELD DETAIL =========== -->
1102
<A NAME="field_detail"><!-- --></A>
1103
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1104
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1105
<TD COLSPAN=1><FONT SIZE="+2">
1106
<B>Field Detail</B></FONT></TD>
1110
<A NAME="actions"><!-- --></A><H3>
1113
protected <A HREF="../../../../org/apache/struts/util/FastHashMap.html">FastHashMap</A> <B>actions</B></PRE>
1115
<DD>The set of Action instances that have been created and initialized,
1116
keyed by the fully qualified Java class name.</DL>
1119
<A NAME="application"><!-- --></A><H3>
1122
protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>application</B></PRE>
1124
<DD>The resources object for our application resources (if any).</DL>
1127
<A NAME="config"><!-- --></A><H3>
1130
protected java.lang.String <B>config</B></PRE>
1132
<DD>The context-relative path to our configuration resource.</DL>
1135
<A NAME="content"><!-- --></A><H3>
1138
protected java.lang.String <B>content</B></PRE>
1140
<DD>The default content type and character encoding to be set on each
1141
response (may be overridden by forwarded-to resources).</DL>
1144
<A NAME="dataSources"><!-- --></A><H3>
1147
protected <A HREF="../../../../org/apache/struts/util/FastHashMap.html">FastHashMap</A> <B>dataSources</B></PRE>
1149
<DD>The JDBC data sources that has been configured for this application,
1150
if any, keyed by the servlet context attribute under which they are
1154
<A NAME="debug"><!-- --></A><H3>
1157
protected int <B>debug</B></PRE>
1159
<DD>The debugging detail level for this servlet.</DL>
1162
<A NAME="defaultLocale"><!-- --></A><H3>
1165
protected final java.util.Locale <B>defaultLocale</B></PRE>
1167
<DD>The default Locale for this server.</DL>
1170
<A NAME="factoryClass"><!-- --></A><H3>
1173
protected java.lang.String <B>factoryClass</B></PRE>
1175
<DD>The Java class name of the <code>MessageResourcesFactory</code>
1176
class for the application message resources bundle.</DL>
1179
<A NAME="formBeanClass"><!-- --></A><H3>
1182
protected java.lang.String <B>formBeanClass</B></PRE>
1184
<DD>The Java class name of the ActionFormBean implementation class to use.</DL>
1187
<A NAME="formBeans"><!-- --></A><H3>
1190
protected <A HREF="../../../../org/apache/struts/action/ActionFormBeans.html">ActionFormBeans</A> <B>formBeans</B></PRE>
1192
<DD>The global ActionFormBean collection for this controller.</DL>
1195
<A NAME="forwardClass"><!-- --></A><H3>
1198
protected java.lang.String <B>forwardClass</B></PRE>
1200
<DD>The Java class name of the ActionForward implementation class to use.</DL>
1203
<A NAME="forwards"><!-- --></A><H3>
1206
protected <A HREF="../../../../org/apache/struts/action/ActionForwards.html">ActionForwards</A> <B>forwards</B></PRE>
1208
<DD>The global ActionForward collection for this controller.</DL>
1211
<A NAME="internal"><!-- --></A><H3>
1214
protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>internal</B></PRE>
1216
<DD>The resources object for our internal resources.</DL>
1219
<A NAME="internalName"><!-- --></A><H3>
1222
protected java.lang.String <B>internalName</B></PRE>
1224
<DD>The Java base name of our internal resources.</DL>
1227
<A NAME="locale"><!-- --></A><H3>
1230
protected boolean <B>locale</B></PRE>
1232
<DD>Should we create a <code>java.util.Locale</code> for this user,
1233
based on the HTTP headers of the request, if one is not present?</DL>
1236
<A NAME="mappingClass"><!-- --></A><H3>
1239
protected java.lang.String <B>mappingClass</B></PRE>
1241
<DD>The Java class name of our ActionMapping implementation class.</DL>
1244
<A NAME="mappings"><!-- --></A><H3>
1247
protected <A HREF="../../../../org/apache/struts/action/ActionMappings.html">ActionMappings</A> <B>mappings</B></PRE>
1249
<DD>The configured mappings for this web application, keyed by path.</DL>
1252
<A NAME="nocache"><!-- --></A><H3>
1255
protected boolean <B>nocache</B></PRE>
1257
<DD>Include the no-caching headers in our response?</DL>
1260
<A NAME="registrations"><!-- --></A><H3>
1263
protected java.lang.String[] <B>registrations</B></PRE>
1265
<DD>The set of public identifiers, and corresponding resource names, for
1266
the versions of the configuration file DTDs that we know about. There
1267
<strong>MUST</strong> be an even number of Strings in this list!</DL>
1270
<A NAME="servletMapping"><!-- --></A><H3>
1273
protected java.lang.String <B>servletMapping</B></PRE>
1275
<DD>The URL pattern to which we are mapped in our web application
1276
deployment descriptor.</DL>
1279
<A NAME="servletName"><!-- --></A><H3>
1282
protected java.lang.String <B>servletName</B></PRE>
1284
<DD>The servlet name under which we are registered in our web application
1285
deployment descriptor.</DL>
1288
<A NAME="validate"><!-- --></A><H3>
1291
protected boolean <B>validate</B></PRE>
1293
<DD>Are we using the new configuration file format?</DL>
1296
<A NAME="validating"><!-- --></A><H3>
1299
protected boolean <B>validating</B></PRE>
1301
<DD>Should we use a validating XML parser to read the configuration file?</DL>
1304
<A NAME="bufferSize"><!-- --></A><H3>
1307
protected int <B>bufferSize</B></PRE>
1309
<DD>The size in bytes of the buffer used to read files from a client upload</DL>
1312
<A NAME="maxFileSize"><!-- --></A><H3>
1315
protected java.lang.String <B>maxFileSize</B></PRE>
1317
<DD>The maximum size allowed for a client upload. A suffix of "K"
1318
represents Kilobytes, a suffix of "M" represents "Megabytes",
1319
a suffix of "G" represents Gigabytes, and no suffix is taken
1323
<A NAME="multipartClass"><!-- --></A><H3>
1326
protected java.lang.String <B>multipartClass</B></PRE>
1328
<DD>The MultipartRequestHandler class name used for handling
1329
multipart form requests. This is the global default value,
1330
the handler can also be set in individual mapping entries</DL>
1333
<A NAME="tempDir"><!-- --></A><H3>
1336
protected java.lang.String <B>tempDir</B></PRE>
1338
<DD>The directory used to store temporary files for the DiskMultipartRequestHandler
1339
multipart implementation</DL>
1341
<!-- ========= CONSTRUCTOR DETAIL ======== -->
1343
<A NAME="constructor_detail"><!-- --></A>
1344
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1345
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1346
<TD COLSPAN=1><FONT SIZE="+2">
1347
<B>Constructor Detail</B></FONT></TD>
1351
<A NAME="ActionServlet()"><!-- --></A><H3>
1354
public <B>ActionServlet</B>()</PRE>
1358
<!-- ============ METHOD DETAIL ========== -->
1360
<A NAME="method_detail"><!-- --></A>
1361
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1362
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1363
<TD COLSPAN=1><FONT SIZE="+2">
1364
<B>Method Detail</B></FONT></TD>
1368
<A NAME="destroy()"><!-- --></A><H3>
1371
public void <B>destroy</B>()</PRE>
1373
<DD>Gracefully shut down this controller servlet, releasing any resources
1374
that were allocated at initialization.<DD><DL>
1375
<DT><B>Overrides:</B><DD><CODE>destroy</CODE> in class <CODE>javax.servlet.GenericServlet</CODE></DL>
1380
<A NAME="init()"><!-- --></A><H3>
1383
public void <B>init</B>()
1384
throws javax.servlet.ServletException</PRE>
1386
<DD>Initialize this servlet. Most of the processing has been factored into
1387
support methods so that you can override particular functionality at a
1388
fairly granular level.<DD><DL>
1389
<DT><B>Overrides:</B><DD><CODE>init</CODE> in class <CODE>javax.servlet.GenericServlet</CODE></DL>
1392
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if we cannot configure ourselves correctly</DL>
1397
<A NAME="doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
1400
public void <B>doGet</B>(javax.servlet.http.HttpServletRequest request,
1401
javax.servlet.http.HttpServletResponse response)
1402
throws java.io.IOException,
1403
javax.servlet.ServletException</PRE>
1405
<DD>Process an HTTP "GET" request.<DD><DL>
1406
<DT><B>Overrides:</B><DD><CODE>doGet</CODE> in class <CODE>javax.servlet.http.HttpServlet</CODE></DL>
1409
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet 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>
1414
<A NAME="doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
1417
public void <B>doPost</B>(javax.servlet.http.HttpServletRequest request,
1418
javax.servlet.http.HttpServletResponse response)
1419
throws java.io.IOException,
1420
javax.servlet.ServletException</PRE>
1422
<DD>Process an HTTP "POST" request.<DD><DL>
1423
<DT><B>Overrides:</B><DD><CODE>doPost</CODE> in class <CODE>javax.servlet.http.HttpServlet</CODE></DL>
1426
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet 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>
1431
<A NAME="addDataSource(java.lang.String, javax.sql.DataSource)"><!-- --></A><H3>
1434
public void <B>addDataSource</B>(java.lang.String key,
1435
javax.sql.DataSource dataSource)</PRE>
1437
<DD>Add a data source object to be used by this application.<DD><DL>
1438
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The servlet context attribute key under which to store
1439
this data source, or <code>null</code> for the default<DD><CODE>dataSource</CODE> - The data source to be used</DL>
1444
<A NAME="addFormBean(org.apache.struts.action.ActionFormBean)"><!-- --></A><H3>
1447
public void <B>addFormBean</B>(<A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A> formBean)</PRE>
1449
<DD>Register a form bean definition to the set configured for this servlet.<DD><DL>
1450
<DT><B>Parameters:</B><DD><CODE>formBean</CODE> - The form bean definition to be added</DL>
1455
<A NAME="addForward(org.apache.struts.action.ActionForward)"><!-- --></A><H3>
1458
public void <B>addForward</B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</PRE>
1460
<DD>Register a logical forwarding to the set configured for this servlet.<DD><DL>
1461
<DT><B>Parameters:</B><DD><CODE>forward</CODE> - The forwarding to be added</DL>
1466
<A NAME="addMapping(org.apache.struts.action.ActionMapping)"><!-- --></A><H3>
1469
public void <B>addMapping</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</PRE>
1471
<DD>Register a mapping to the set configured for this servlet.<DD><DL>
1472
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The mapping to be added</DL>
1477
<A NAME="addServletMapping(java.lang.String, java.lang.String)"><!-- --></A><H3>
1478
addServletMapping</H3>
1480
public void <B>addServletMapping</B>(java.lang.String servletName,
1481
java.lang.String urlPattern)</PRE>
1483
<DD>Remember a servlet mapping from our web application deployment
1484
descriptor, if it is for this servlet.<DD><DL>
1485
<DT><B>Parameters:</B><DD><CODE>servletName</CODE> - The name of the servlet being mapped<DD><CODE>urlPattern</CODE> - The URL pattern to which this servlet is mapped</DL>
1490
<A NAME="findDataSource(java.lang.String)"><!-- --></A><H3>
1493
public javax.sql.DataSource <B>findDataSource</B>(java.lang.String key)</PRE>
1495
<DD>Return a JDBC data source associated with this application, if any.<DD><DL>
1496
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The servlet context attribute key under which this data
1497
source is stored, or <code>null</code> for the default.</DL>
1502
<A NAME="findFormBean(java.lang.String)"><!-- --></A><H3>
1505
public <A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A> <B>findFormBean</B>(java.lang.String name)</PRE>
1507
<DD>Return the form bean definition associated with the specified
1508
logical name, if any; otherwise return <code>null</code>.<DD><DL>
1509
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Logical name of the requested form bean definition</DL>
1514
<A NAME="findForward(java.lang.String)"><!-- --></A><H3>
1517
public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>findForward</B>(java.lang.String name)</PRE>
1519
<DD>Return the forwarding associated with the specified logical name,
1520
if any; otherwise return <code>null</code>.<DD><DL>
1521
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Logical name of the requested forwarding</DL>
1526
<A NAME="findMapping(java.lang.String)"><!-- --></A><H3>
1529
public <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>findMapping</B>(java.lang.String path)</PRE>
1531
<DD>Return the mapping associated with the specified request path, if any;
1532
otherwise return <code>null</code>.<DD><DL>
1533
<DT><B>Parameters:</B><DD><CODE>path</CODE> - Request path for which a mapping is requested</DL>
1538
<A NAME="getBufferSize()"><!-- --></A><H3>
1541
public int <B>getBufferSize</B>()</PRE>
1543
<DD>Get the buffer size (how large of a chunk of data is
1544
recieved by the input stream at once) used for file
1546
<DT><B>Returns:</B><DD>The size in bytes of the buffer</DL>
1551
<A NAME="getDebug()"><!-- --></A><H3>
1554
public int <B>getDebug</B>()</PRE>
1556
<DD>Return the debugging detail level for this servlet.</DL>
1559
<A NAME="getFormBeanClass()"><!-- --></A><H3>
1560
getFormBeanClass</H3>
1562
public java.lang.String <B>getFormBeanClass</B>()</PRE>
1564
<DD>Return the Java class name of the class used to instantiate
1565
<code>ActionFormBean</code> objects.</DL>
1568
<A NAME="getForwardClass()"><!-- --></A><H3>
1569
getForwardClass</H3>
1571
public java.lang.String <B>getForwardClass</B>()</PRE>
1573
<DD>Return the Java class name of the class used to instantiate
1574
<code>ActionForward</code> objects.</DL>
1577
<A NAME="getMappingClass()"><!-- --></A><H3>
1578
getMappingClass</H3>
1580
public java.lang.String <B>getMappingClass</B>()</PRE>
1582
<DD>Return the Java class name of the class used to instantiate
1583
<code>ActionMapping</code> objects.</DL>
1586
<A NAME="getMaxFileSize()"><!-- --></A><H3>
1589
public java.lang.String <B>getMaxFileSize</B>()</PRE>
1591
<DD>Get the maximum file size. See <A HREF="../../../../org/apache/struts/action/ActionServlet.html#setMaxFileSize(java.lang.String)"><CODE>setMaxFileSize</CODE></A>
1592
for information on the number format used.</DL>
1595
<A NAME="getMultipartClass()"><!-- --></A><H3>
1596
getMultipartClass</H3>
1598
public java.lang.String <B>getMultipartClass</B>()</PRE>
1600
<DD>Get the class name of the MultipartRequestHandler implementation<DD><DL>
1601
<DT><B>Returns:</B><DD>A qualified classname of the MultipartRequestHandler implementation</DL>
1606
<A NAME="getResources()"><!-- --></A><H3>
1609
public <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>getResources</B>()</PRE>
1611
<DD>Return the application resources for this web application, if any.</DL>
1614
<A NAME="getTempDir()"><!-- --></A><H3>
1617
public java.lang.String <B>getTempDir</B>()</PRE>
1619
<DD>Get the directory used to temporarily store form files<DD><DL>
1620
<DT><B>Returns:</B><DD>A platform-dependant String representing the path to the temporary directory</DL>
1625
<A NAME="log(java.lang.String, int)"><!-- --></A><H3>
1628
public void <B>log</B>(java.lang.String message,
1629
int level)</PRE>
1631
<DD>Log the specified message if the current debugging detail level for
1632
this servlet has been set to an equal or higher value. Otherwise,
1633
ignore this message.<DD><DL>
1634
<DT><B>Parameters:</B><DD><CODE>message</CODE> - Message to be logged<DD><CODE>level</CODE> - Debugging detail level of this message</DL>
1639
<A NAME="reload()"><!-- --></A><H3>
1642
public void <B>reload</B>()
1643
throws java.io.IOException,
1644
javax.servlet.ServletException</PRE>
1646
<DD>Reload the configuration of this controller servlet from our
1647
underlying configuration files.<DD><DL>
1648
<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>
1653
<A NAME="removeFormBean(org.apache.struts.action.ActionFormBean)"><!-- --></A><H3>
1656
public void <B>removeFormBean</B>(<A HREF="../../../../org/apache/struts/action/ActionFormBean.html">ActionFormBean</A> formBean)</PRE>
1658
<DD>Deregister a form bean definition from the set configured for
1659
this servlet.<DD><DL>
1660
<DT><B>Parameters:</B><DD><CODE>formBean</CODE> - The form bean definition to be deregistered</DL>
1665
<A NAME="removeForward(org.apache.struts.action.ActionForward)"><!-- --></A><H3>
1668
public void <B>removeForward</B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward)</PRE>
1670
<DD>Deregister a forwarding from the set configured for this servlet.<DD><DL>
1671
<DT><B>Parameters:</B><DD><CODE>forward</CODE> - The forwarding to be deregistered</DL>
1676
<A NAME="removeMapping(org.apache.struts.action.ActionMapping)"><!-- --></A><H3>
1679
public void <B>removeMapping</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</PRE>
1681
<DD>Deregister a mapping from the set configured for this servlet.<DD><DL>
1682
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The mapping to be deregistered</DL>
1687
<A NAME="setBufferSize(int)"><!-- --></A><H3>
1690
public void <B>setBufferSize</B>(int bufferSize)</PRE>
1692
<DD>Set the buffer size (how large of a chunk of data is
1693
recieved by the input stream at once) used for file
1695
<DT><B>Parameters:</B><DD><CODE>bufferSize</CODE> - The size in bytes of the buffer</DL>
1700
<A NAME="setFormBeanClass(java.lang.String)"><!-- --></A><H3>
1701
setFormBeanClass</H3>
1703
public void <B>setFormBeanClass</B>(java.lang.String formBeanClass)</PRE>
1705
<DD>Set the Java class name of the class used to instantiate
1706
<code>ActionFormBean</code> objects.<DD><DL>
1707
<DT><B>Parameters:</B><DD><CODE>formBeanClass</CODE> - The new class name</DL>
1712
<A NAME="setForwardClass(java.lang.String)"><!-- --></A><H3>
1713
setForwardClass</H3>
1715
public void <B>setForwardClass</B>(java.lang.String forwardClass)</PRE>
1717
<DD>Set the Java class name of the class used to instantiate
1718
<code>ActionForward</code> objects.<DD><DL>
1719
<DT><B>Parameters:</B><DD><CODE>forwardClass</CODE> - The new class name</DL>
1724
<A NAME="setMappingClass(java.lang.String)"><!-- --></A><H3>
1725
setMappingClass</H3>
1727
public void <B>setMappingClass</B>(java.lang.String mappingClass)</PRE>
1729
<DD>Set the Java class name of the class used to instantiate
1730
<code>ActionMapping</code> objects.<DD><DL>
1731
<DT><B>Parameters:</B><DD><CODE>mappingClass</CODE> - The new class name</DL>
1736
<A NAME="setMaxFileSize(java.lang.String)"><!-- --></A><H3>
1739
public void <B>setMaxFileSize</B>(java.lang.String maxFileSize)</PRE>
1741
<DD>Set the maximum file size that a client can upload, number String with a trailing
1742
letter indicating the size. "K" indicates "kilobytes", "M" indicates "megabytes",
1743
"G" indicates "gigabytes". If there's no trailing letter the suffix is assumed to
1744
indicate the number is in bytes. For example, to set a maximum file size of
1745
500 megabytes, you'd call <code>setMaxFileSize</code>("<i>500M</i>").<DD><DL>
1746
<DT><B>Parameters:</B><DD><CODE>maxFileSize</CODE> - A String representing the maximum file size.</DL>
1751
<A NAME="setMultipartClass(java.lang.String)"><!-- --></A><H3>
1752
setMultipartClass</H3>
1754
public void <B>setMultipartClass</B>(java.lang.String multipartClass)</PRE>
1756
<DD>Set the class name of the MultipartRequestHandler implementation<DD><DL>
1757
<DT><B>Parameters:</B><DD><CODE>multipartClass</CODE> - A qualified classname of the MultipartRequestHandler implementation</DL>
1762
<A NAME="setTempDir(java.lang.String)"><!-- --></A><H3>
1765
public void <B>setTempDir</B>(java.lang.String tempDir)</PRE>
1767
<DD>Set the directory used to temporarily store files for MultipartRequestHandler
1768
implementations that write to the disk<DD><DL>
1769
<DT><B>Parameters:</B><DD><CODE>tempDir</CODE> - A platform-dependant String representing the path to the temporary directory</DL>
1774
<A NAME="destroyActions()"><!-- --></A><H3>
1777
protected void <B>destroyActions</B>()</PRE>
1779
<DD>Gracefully shut down any action instances we have created.</DL>
1782
<A NAME="destroyApplication()"><!-- --></A><H3>
1783
destroyApplication</H3>
1785
protected void <B>destroyApplication</B>()</PRE>
1787
<DD>Gracefully terminate use of the application MessageResources (if any).</DL>
1790
<A NAME="destroyDataSources()"><!-- --></A><H3>
1791
destroyDataSources</H3>
1793
protected void <B>destroyDataSources</B>()</PRE>
1795
<DD>Gracefully terminate use of the data source associated with this
1796
application (if any).</DL>
1799
<A NAME="destroyInternal()"><!-- --></A><H3>
1800
destroyInternal</H3>
1802
protected void <B>destroyInternal</B>()</PRE>
1804
<DD>Gracefully terminate use of the internal MessageResources.</DL>
1807
<A NAME="initActions()"><!-- --></A><H3>
1810
protected void <B>initActions</B>()</PRE>
1812
<DD>Initialize the collection of previously instantiated Action instances.</DL>
1815
<A NAME="initApplication()"><!-- --></A><H3>
1816
initApplication</H3>
1818
protected void <B>initApplication</B>()
1819
throws javax.servlet.ServletException</PRE>
1821
<DD>Initialize the MessageResources bundle for this application, if any.<DD><DL>
1822
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if we cannot initialize these resources</DL>
1827
<A NAME="initDataSources()"><!-- --></A><H3>
1828
initDataSources</H3>
1830
protected void <B>initDataSources</B>()
1831
throws javax.servlet.ServletException</PRE>
1833
<DD>Initialize use of the data sources associated with this
1834
application (if any).<DD><DL>
1835
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if a fatal initialization error occurs</DL>
1840
<A NAME="initDebug()"><!-- --></A><H3>
1843
protected void <B>initDebug</B>()
1844
throws javax.servlet.ServletException</PRE>
1846
<DD>Initialize the debugging detail level for this application.<DD><DL>
1847
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if we cannot initialize these resources</DL>
1852
<A NAME="initDigester(int)"><!-- --></A><H3>
1855
protected <A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A> <B>initDigester</B>(int detail)</PRE>
1857
<DD>Construct and return a digester that uses the new configuration
1861
<A NAME="initDigesterOld(int)"><!-- --></A><H3>
1862
initDigesterOld</H3>
1864
protected <A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A> <B>initDigesterOld</B>(int detail)</PRE>
1866
<DD>Construct and return a digester that uses the old configuration
1870
<A NAME="initInternal()"><!-- --></A><H3>
1873
protected void <B>initInternal</B>()
1874
throws javax.servlet.ServletException</PRE>
1876
<DD>Initialize our internal MessageResources bundle.<DD><DL>
1877
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if we cannot initialize these resources</DL>
1882
<A NAME="initMapping()"><!-- --></A><H3>
1885
protected void <B>initMapping</B>()
1886
throws java.io.IOException,
1887
javax.servlet.ServletException</PRE>
1889
<DD>Initialize the mapping information for this application.<DD><DL>
1890
<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error is encountered<DD><CODE>javax.servlet.ServletException</CODE> - if we cannot initialize these resources</DL>
1895
<A NAME="initOther()"><!-- --></A><H3>
1898
protected void <B>initOther</B>()
1899
throws javax.servlet.ServletException</PRE>
1901
<DD>Initialize other configuration parameters that have not yet
1902
been processed.<DD><DL>
1903
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if we cannot initialize these resources</DL>
1908
<A NAME="initServlet()"><!-- --></A><H3>
1911
protected void <B>initServlet</B>()
1912
throws javax.servlet.ServletException</PRE>
1914
<DD>Initialize the servlet mapping under which our controller servlet
1915
is being accessed. This will be used in the <code>&html:form></code>
1916
tag to generate correct destination URLs for form submissions.</DL>
1919
<A NAME="initUpload()"><!-- --></A><H3>
1922
protected void <B>initUpload</B>()
1923
throws javax.servlet.ServletException</PRE>
1925
<DD>Initialize upload parameters and "bufferSize", "multipartClass",
1926
"maxFileSize", "tempDir"<DD><DL>
1927
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if there are invalid parameters</DL>
1932
<A NAME="process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
1935
protected void <B>process</B>(javax.servlet.http.HttpServletRequest request,
1936
javax.servlet.http.HttpServletResponse response)
1937
throws java.io.IOException,
1938
javax.servlet.ServletException</PRE>
1940
<DD>Process an HTTP request.<DD><DL>
1941
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet 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>
1946
<A NAME="processActionCreate(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
1947
processActionCreate</H3>
1949
protected <A HREF="../../../../org/apache/struts/action/Action.html">Action</A> <B>processActionCreate</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
1950
javax.servlet.http.HttpServletRequest request)</PRE>
1952
<DD>Create or retrieve the Action instance that will process this request,
1953
or <code>null</code> if no such Action instance can be created.<DD><DL>
1954
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>request</CODE> - The servlet request we are processing</DL>
1959
<A NAME="processActionForm(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
1960
processActionForm</H3>
1962
protected <A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> <B>processActionForm</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
1963
javax.servlet.http.HttpServletRequest request)</PRE>
1965
<DD>Retrieve and return the <code>ActionForm</code> bean associated with
1966
this mapping, creating and stashing one if necessary. If there is no
1967
form bean associated with this mapping, return <code>null</code>.<DD><DL>
1968
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>request</CODE> - The servlet request we are processing</DL>
1973
<A NAME="processActionForward(org.apache.struts.action.ActionForward, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
1974
processActionForward</H3>
1976
protected void <B>processActionForward</B>(<A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> forward,
1977
<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
1978
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
1979
javax.servlet.http.HttpServletRequest request,
1980
javax.servlet.http.HttpServletResponse response)
1981
throws java.io.IOException,
1982
javax.servlet.ServletException</PRE>
1984
<DD>Forward to the specified destination, by the specified mechanism,
1985
if an <code>ActionForward</code> instance was returned by the
1986
<code>Action</code>.<DD><DL>
1987
<DT><B>Parameters:</B><DD><CODE>forward</CODE> - The ActionForward returned by our action<DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>formInstance</CODE> - The ActionForm we are processing<DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet 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>
1992
<A NAME="processActionPerform(org.apache.struts.action.Action, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
1993
processActionPerform</H3>
1995
protected <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>processActionPerform</B>(<A HREF="../../../../org/apache/struts/action/Action.html">Action</A> action,
1996
<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
1997
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
1998
javax.servlet.http.HttpServletRequest request,
1999
javax.servlet.http.HttpServletResponse response)
2000
throws java.io.IOException,
2001
javax.servlet.ServletException</PRE>
2003
<DD>Ask the specified Action instance to handle this request. Return
2004
the <code>ActionForward</code> instance (if any) returned by
2005
the called <code>Action</code>.<DD><DL>
2006
<DT><B>Parameters:</B><DD><CODE>action</CODE> - The Action to process this request<DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>formInstance</CODE> - The ActionForm we are processing<DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet 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>
2011
<A NAME="processContent(javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
2014
protected void <B>processContent</B>(javax.servlet.http.HttpServletResponse response)</PRE>
2016
<DD>Set the default content type (with optional character encoding) for
2017
all responses. This value may be overridden by forwarded-to servlets
2018
or JSP pages.<DD><DL>
2019
<DT><B>Parameters:</B><DD><CODE>response</CODE> - The response we are processing</DL>
2024
<A NAME="processForward(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
2027
protected boolean <B>processForward</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
2028
javax.servlet.http.HttpServletRequest request,
2029
javax.servlet.http.HttpServletResponse response)
2030
throws java.io.IOException,
2031
javax.servlet.ServletException</PRE>
2033
<DD>Process a forward requested by this mapping, if any. Return
2034
<code>true</code> if processing of this request should continue (i.e.
2035
be processed by an Action class), or <code>false</code> if we have
2036
already handled this request.<DD><DL>
2037
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>request</CODE> - The request we are processing<DD><CODE>response</CODE> - The response we are processing<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if the included resource throws an exception<DD><CODE>javax.servlet.ServletException</CODE> - if the included resource throws an
2043
<A NAME="processInclude(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
2046
protected boolean <B>processInclude</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
2047
javax.servlet.http.HttpServletRequest request,
2048
javax.servlet.http.HttpServletResponse response)
2049
throws java.io.IOException,
2050
javax.servlet.ServletException</PRE>
2052
<DD>Process an include requested by this mapping, if any. Return
2053
<code>true</code> if processing of this request should continue (i.e.
2054
be processed by an Action class), or <code>false</code> if we have
2055
already handled this request.<DD><DL>
2056
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>request</CODE> - The request we are processing<DD><CODE>response</CODE> - The response we are processing<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if the included resource throws an exception<DD><CODE>javax.servlet.ServletException</CODE> - if the included resource throws an
2062
<A NAME="processLocale(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
2065
protected void <B>processLocale</B>(javax.servlet.http.HttpServletRequest request)</PRE>
2067
<DD>Automatically calculate an appropriate <code>java.util.Locale</code>
2068
for this user, and store it in their session, if there is no such
2069
Locale object present already.<DD><DL>
2070
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing</DL>
2075
<A NAME="processMapping(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
2078
protected <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> <B>processMapping</B>(java.lang.String path,
2079
javax.servlet.http.HttpServletRequest request)</PRE>
2081
<DD>Identify and return an appropriate ActionMapping for the specified
2082
path. If no such mapping can be identified, return <code>null</code>.
2083
The <code>request</code> parameter is available if you need to make
2084
decisions on available mappings (such as checking permissions) based
2085
on request parameters or other properties, but it is not used in the
2086
default implementation.<DD><DL>
2087
<DT><B>Parameters:</B><DD><CODE>path</CODE> - Path component used to select a mapping<DD><CODE>request</CODE> - The request we are processing</DL>
2092
<A NAME="processNoCache(javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
2095
protected void <B>processNoCache</B>(javax.servlet.http.HttpServletResponse response)
2096
throws java.io.IOException,
2097
javax.servlet.ServletException</PRE>
2099
<DD>Render the HTTP headers to defeat browser caching if requested.<DD><DL>
2100
<DT><B>Parameters:</B><DD><CODE>response</CODE> - The servlet 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>
2105
<A NAME="processPath(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
2108
protected java.lang.String <B>processPath</B>(javax.servlet.http.HttpServletRequest request)</PRE>
2110
<DD>Identify and return the path component (from the request URI) that
2111
we will use to select an ActionMapping to dispatch with. If no such
2112
path can be identified, return <code>null</code>.<DD><DL>
2113
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>
2118
<A NAME="processPreprocess(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
2119
processPreprocess</H3>
2121
protected boolean <B>processPreprocess</B>(javax.servlet.http.HttpServletRequest request,
2122
javax.servlet.http.HttpServletResponse response)
2123
throws java.io.IOException,
2124
javax.servlet.ServletException</PRE>
2126
<DD>General purpose preprocessing hook that can be overridden to support
2127
application specific preprocessing activity. This hook can examine
2128
and/or modify the properties of the request and response objects, and
2129
optionally complete the response if it wishes.
2131
The default implementation does nothing.<DD><DL>
2132
<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet response we are generating<DT><B>Returns:</B><DD><code>true</code> if the remainder of the standard processing
2133
should be performed, or <code>false</code> if the response has already
2134
been created so the calling method should immediately exit<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>
2139
<A NAME="processPopulate(org.apache.struts.action.ActionForm, org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
2140
processPopulate</H3>
2142
protected void <B>processPopulate</B>(<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
2143
<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
2144
javax.servlet.http.HttpServletRequest request)
2145
throws javax.servlet.ServletException</PRE>
2147
<DD>Populate the properties of the specified ActionForm from the request
2148
parameters included with this request.<DD><DL>
2149
<DT><B>Parameters:</B><DD><CODE>formInstance</CODE> - The ActionForm we are processing<DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>request</CODE> - The servlet request we are processing<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - if thrown by RequestUtils.populate()</DL>
2154
<A NAME="processValidate(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
2155
processValidate</H3>
2157
protected boolean <B>processValidate</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,
2158
<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> formInstance,
2159
javax.servlet.http.HttpServletRequest request,
2160
javax.servlet.http.HttpServletResponse response)
2161
throws java.io.IOException,
2162
javax.servlet.ServletException</PRE>
2164
<DD>Call the <code>validate()</code> method of the specified ActionForm,
2165
and forward back to the input form if there are any errors. Return
2166
<code>true</code> if we should continue processing (and call the
2167
<code>Action</code> class <code>perform()</code> method), or return
2168
<code>false</code> if we have already forwarded control back to the
2170
<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping we are processing<DD><CODE>formInstance</CODE> - The ActionForm we are processing<DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet response we are processing<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>
2173
<!-- ========= END OF CLASS DATA ========= -->
2176
<!-- ========== START OF NAVBAR ========== -->
2177
<A NAME="navbar_bottom"><!-- --></A>
2178
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
2180
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
2181
<A NAME="navbar_bottom_firstrow"><!-- --></A>
2182
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
2183
<TR ALIGN="center" VALIGN="top">
2184
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
2185
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
2186
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
2187
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
2188
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
2189
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
2190
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
2194
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
2200
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
2201
<A HREF="../../../../org/apache/struts/action/ActionMappings.html"><B>PREV CLASS</B></A>
2202
<A HREF="../../../../org/apache/struts/action/AddDataSourceRule.html"><B>NEXT CLASS</B></A></FONT></TD>
2203
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
2204
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
2205
<A HREF="ActionServlet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
2208
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2209
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
2210
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2211
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
2214
<!-- =========== END OF NAVBAR =========== -->
2217
Copyright � 2000-2001 - Apache Software Foundation
added
removed
legacy/api-1.0/org/apache/struts/action/ActionServlet.html
