| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Aug 22 03:43:52 EDT 2003 --> |
| <TITLE> |
| org.apache.struts.action (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.action package"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="org.apache.struts.action (Apache Struts API Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/apache/struts/actions/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <H2> |
| Package org.apache.struts.action |
| </H2> |
| The action package is the core of the struts framework, |
| providing the "Controller" aspect of a MVC model. |
| <P> |
| <B>See:</B> |
| <BR> |
| <A HREF="#package_description"><B>Description</B></A> |
| <P> |
| |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Interface Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="PlugIn.html"><I>PlugIn</I></A></B></TD> |
| <TD>A <strong>PlugIn</strong> is a configuration wrapper for a |
| module-specific resource or service that needs to be notified about |
| application startup and application shutdown events (corresponding to when |
| the container calls <code>init()</code> and <code>destroy()</code> on the |
| corresponding <A HREF="../../../../org/apache/struts/action/ActionServlet.html"><CODE>ActionServlet</CODE></A> instance).</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Class Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="Action.html">Action</A></B></TD> |
| <TD>An <strong>Action</strong> is an adapter between the contents of an incoming |
| HTTP request and the corresponding business logic that should be executed to |
| process this request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionError.html">ActionError</A></B></TD> |
| <TD>An encapsulation of an individual error message returned by the |
| <code>validate()</code> method of an <code>ActionForm</code>, consisting |
| of a message key (to be used to look up message text in an appropriate |
| message resources database) plus up to four placeholder objects that can |
| be used for parametric replacement in the message text.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionErrors.html">ActionErrors</A></B></TD> |
| <TD>A class that encapsulates the error messages being reported by |
| the <code>validate()</code> method of an <code>ActionForm</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionException.html">ActionException</A></B></TD> |
| <TD><B>Deprecated.</B> <I>Replaced by org.apache.struts.config.ExceptionConfig</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionForm.html">ActionForm</A></B></TD> |
| <TD>An <strong>ActionForm</strong> is a JavaBean optionally associated with |
| one or more <code>ActionMappings</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionFormBean.html">ActionFormBean</A></B></TD> |
| <TD>An <strong>ActionFormBean</strong> is the definition of a form bean that |
| is loaded from a <code><form-bean></code> element in the Struts |
| configuration file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionFormBeans.html">ActionFormBeans</A></B></TD> |
| <TD><B>Deprecated.</B> <I>Replaced by collection of FormBeanConfig instances |
| in <A HREF="../../../../org/apache/struts/config/ModuleConfig.html"><CODE>ModuleConfig</CODE></A></I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionForward.html">ActionForward</A></B></TD> |
| <TD>An <strong>ActionForward</strong> represents a destination to which the |
| controller servlet, <code>ActionServlet</code>, might be directed to |
| perform a <code>RequestDispatcher.forward()</code> or |
| <code>HttpServletResponse.sendRedirect()</code> to, as a result of |
| processing activities of an <code>Action</code> class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionForwards.html">ActionForwards</A></B></TD> |
| <TD><B>Deprecated.</B> <I>Replaced by collection of ForwardConfig instances in |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html"><CODE>ModuleConfig</CODE></A> and ActionConfig</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionMapping.html">ActionMapping</A></B></TD> |
| <TD>An <strong>ActionMapping</strong> represents the information that the |
| controller servlet, <code>ActionServlet</code>, knows about the mapping |
| of a particular request to an instance of a particular action class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionMappings.html">ActionMappings</A></B></TD> |
| <TD><B>Deprecated.</B> <I>Replaced by collection of ActionConfig instances in |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html"><CODE>ModuleConfig</CODE></A></I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionMessage.html">ActionMessage</A></B></TD> |
| <TD>An encapsulation of an individual message returned by the |
| <code>validate()</code> method of an <code>ActionForm</code>, consisting |
| of a message key (to be used to look up message text in an appropriate |
| message resources database) plus up to four placeholder objects that can |
| be used for parametric replacement in the message text.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionMessages.html">ActionMessages</A></B></TD> |
| <TD>A class that encapsulates messages.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionServlet.html">ActionServlet</A></B></TD> |
| <TD><strong>ActionServlet</strong> represents the "controller" in the |
| Model-View-Controller (MVC) design pattern for web applications that is |
| commonly known as "Model 2".</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ActionServletWrapper.html">ActionServletWrapper</A></B></TD> |
| <TD>Provide a wrapper around an ActionServlet to expose only |
| those methods needed by other objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="DynaActionForm.html">DynaActionForm</A></B></TD> |
| <TD>Specialized subclass of <code>ActionForm</code> that allows the creation |
| of form beans with dynamic sets of properties, without requiring the |
| developer to create a Java class for each type of form bean.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="DynaActionFormClass.html">DynaActionFormClass</A></B></TD> |
| <TD>Implementation of <code>DynaClass</code> for |
| <code>DynaActionForm</code> classes that allow developers to define |
| ActionForms without having to individually code all of the classes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ExceptionHandler.html">ExceptionHandler</A></B></TD> |
| <TD>An ExceptionHandler is configured in the Struts configuration file to handle a specific |
| type of exception thrown by an Action's execute method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="ForwardingActionForward.html">ForwardingActionForward</A></B></TD> |
| <TD>A subclass of <strong>ActionForward</strong> that defaults the |
| <code>redirect</code> attribute to <code>false</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="RedirectingActionForward.html">RedirectingActionForward</A></B></TD> |
| <TD>A subclass of <strong>ActionForward</strong> that defaults the |
| <code>redirect</code> attribute to <code>true</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="RequestActionMapping.html">RequestActionMapping</A></B></TD> |
| <TD>Subclass of <code>ActionMapping</code> that defaults the form bean |
| scope to <code>request</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="RequestProcessor.html">RequestProcessor</A></B></TD> |
| <TD><strong>RequestProcessor</strong> contains the processing logic that |
| the Struts controller servlet performs as it receives each servlet request |
| from the container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="SessionActionMapping.html">SessionActionMapping</A></B></TD> |
| <TD>Subclass of <code>ActionMapping</code> that defaults the form bean |
| scope to <code>session</code>.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| <A NAME="package_description"><!-- --></A><H2> |
| Package org.apache.struts.action Description |
| </H2> |
| |
| <P> |
| <p> The action package is the core of the struts framework, |
| providing the "Controller" aspect of a MVC model.</p> |
| <br> |
| <br> |
| <img src="doc-files/actionUML.gif" alt="Action Package UML" > |
| <br> |
| |
| <h2>Package Specification</h2> |
| ##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT ##### |
| <ul> |
| <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a> |
| </li> |
| |
| </ul> |
| |
| <h2>Related Documentation</h2> |
| For overviews, tutorials, examples, guides, and tool documentation, |
| please see: |
| <ul> |
| <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a> |
| </li> |
| |
| </ul> |
| <!-- Put @see and @since tags down here. --> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/apache/struts/actions/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
