Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.struts.action: Javadoc index of package org.apache.struts.action.


Package Samples:

org.apache.struts.action
org.apache.struts.actions

Classes:

ActionServlet: ActionServlet provides the "controller" in the Model-View-Controller (MVC) design pattern for web applications that is commonly known as "Model 2". This nomenclature originated with a description in the JavaServerPages Specification, version 0.92, and has persisted ever since (in the absence of a better name). Generally, a "Model 2" application is architected as follows: The user interface will generally be created with server pages, which will not themselves contain any business logic. These pages represent the "view" component of an MVC architecture. Forms and hyperlinks in the user interface ...
MappingDispatchAction: An abstract Action that dispatches to a public method that is named by the parameter attribute of the corresponding ActionMapping. This is useful for developers who prefer to combine many related actions into a single Action class. To configure the use of this action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" type="org.example.SubscriptionAction" name="subscriptionForm" scope="request" input="/subscription.jsp" parameter="method"/> where 'method' is the name of a method in your subclass of MappingDispatchAction that has the same signature (other ...
EventActionDispatcher: An Action helper class that dispatches to to one of the public methods that are named in the parameter attribute of the corresponding ActionMapping and matches a submission parameter. This is useful for developers who prefer to use many submit buttons, images, or submit links on a single form and whose related actions exist in a single Action class. The method(s) in the associated Action must have the same signature (other than method name) of the standard Action.execute method. To configure the use of this action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" ...
LookupDispatchAction: An abstract Action that dispatches to the subclass mapped execute method. This is useful in cases where an HTML form has multiple submit buttons with the same name. The button name is specified by the parameter property of the corresponding ActionMapping. To configure the use of this action in your struts-config.xml file, create an entry like this: <action path="/test" type="org.example.MyAction" name="MyForm" scope="request" input="/test.jsp" parameter="method"/> which will use the value of the request parameter named "method" to locate the corresponding key in ApplicationResources. For ...
DispatchAction: An abstract Action that dispatches to a public method that is named by the request parameter whose name is specified by the parameter property of the corresponding ActionMapping. This Action is useful for developers who prefer to combine many similar actions into a single Action class, in order to simplify their application design. To configure the use of this action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" type="org.apache.struts.actions.DispatchAction" name="subscriptionForm" scope="request" input="/subscription.jsp" parameter="method"/> ...
ActionDispatcher: Action helper class that dispatches to a public method in an Action. This class is provided as an alternative mechanism to using DispatchAction and its various flavours and means Dispatch behaviour can be easily implemented into any Action without having to inherit from a particular super Action . To implement dispatch behaviour in an Action class, create your custom Action as follows, along with the methods you require (and optionally "cancelled" and "unspecified" methods): public class MyCustomAction extends Action { protected ActionDispatcher dispatcher = new ActionDispatcher(this, ActionDispatcher.MAPPING_FLAVOR); ...
EventDispatchAction: An Action that dispatches to to one of the public methods that are named in the parameter attribute of the corresponding ActionMapping and matches a submission parameter. This is useful for developers who prefer to use many submit buttons, images, or submit links on a single form and whose related actions exist in a single Action class. The method(s) must have the same signature (other than method name) of the standard Action.execute method. To configure the use of this action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" type="org.example.SubscriptionAction" ...
ActionForward: An ActionForward represents a destination to which the controller, RequestProcessor , might be directed to perform a RequestDispatcher.forward or HttpServletResponse.sendRedirect to, as a result of processing activities of an Action class. Instances of this class may be created dynamically as necessary, or configured in association with an ActionMapping instance for named lookup of potentially multiple destinations for a particular mapping instance. An ActionForward has the following minimal set of properties. Additional properties can be provided as needed by subclassses. contextRelative - Should ...
ActionForm: An ActionForm is a JavaBean optionally associated with one or more ActionMappings . Such a bean will have had its properties initialized from the corresponding request parameters before the corresponding Action.execute method is called. When the properties of this bean have been populated, but before the execute method of the Action is called, this bean's validate method will be called, which gives the bean a chance to verify that the properties submitted by the user are correct and valid. If this method finds problems, it returns an error messages object that encapsulates those problems, and the ...
Action: An Action is an adapter between the contents of an incoming HTTP request and the corresponding business logic that should be executed to process this request. The controller (RequestProcessor) will select an appropriate Action for each request, create an instance (if necessary), and call the execute method. Actions must be programmed in a thread-safe manner, because the controller will share the same instance for multiple simultaneous requests. This means you should design with the following items in mind: Instance and static variables MUST NOT be used to store information related to the state ...
PlugIn: A PlugIn 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 init and destroy on the corresponding ActionServlet instance). PlugIn objects can be configured in the struts-config.xml file, without the need to subclass ActionServlet simply to perform application lifecycle activities. Implementations of this interface must supply a zero-argument constructor for use by ActionServlet . Configuration can be accomplished by providing standard JavaBeans property ...
ActionRedirect: A subclass of ActionForward which is designed for use in redirecting requests, with support for adding parameters at runtime. An org.apache.struts.config.ForwardConfig (or subclass) can be passed to the constructor to copy its configuration: public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception { ActionRedirect redirect = new ActionRedirect(mapping.findForward("doRedirect")); redirect.addParameter("param1","value1"); redirect.addParameter("param2","2"); redirect.addParameter("param3","3.0"); return redirect; ...
ForwardAction: An Action that forwards to the context-relative URI specified by the parameter property of our associated ActionMapping . This can be used to integrate Struts with other business logic components that are implemented as servlets (or JSP pages), but still take advantage of the Struts controller servlet's functionality (such as processing of form beans). To configure the use of this Action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" type="org.apache.struts.actions.ForwardAction" name="subscriptionForm" scope="request" input="/subscription.jsp" parameter="/path/to/processing/servlet"/> ...
IncludeAction: An Action that includes the context-relative URI specified by the parameter property of our associated ActionMapping . This can be used to integrate Struts with other business logic components that are implemented as servlets (or JSP pages), but still take advantage of the Struts controller servlet's functionality (such as processing of form beans). To configure the use of this Action in your struts-config.xml file, create an entry like this: <action path="/saveSubscription" type="org.apache.struts.actions.IncludeAction" name="subscriptionForm" scope="request" input="/subscription.jsp" parameter="/path/to/processing/servlet"> ...
ActionErrors: A class that encapsulates the error messages being reported by the validate() method of an ActionForm . Validation errors are either global to the entire ActionForm bean they are associated with, or they are specific to a particular bean property (and, therefore, a particular input field on the corresponding form). Each individual error is described by an ActionMessage object, which contains a message key (to be looked up in an appropriate message resources database), and up to four placeholder arguments used for parametric substitution in the resulting message. IMPLEMENTATION NOTE - It is assumed ...
RedeployableActionServlet: WebLogic (at least v6 and v7) attempts to serialize the TilesRequestProcessor when re-deploying the Webapp in development mode. The TilesRequestProcessor is not serializable, and loses the Tiles definitions. This results in NullPointerException and/or NotSerializableException when using the app after automatic redeploy. This bug report proposes a workaround for this problem, in the hope it will help others and maybe motivate an actual fix. The attached class extends the Struts Action servlet and fixes the problem by reloading the Tiles definitions when they have disappeared. For background discussion ...
SwitchAction: A standard Action that switches to a new module and then forwards control to a URI (specified in a number of possible ways) within the new module. Valid request parameters for this Action are: page - Module-relative URI (beginning with "/") to which control should be forwarded after switching. prefix - The module prefix (beginning with "/") of the module to which control should be switched. Use a zero-length string for the default module. The appropriate ModuleConfig object will be stored as a request attribute, so any subsequent logic will assume the new module.
ActionMessages: A class that encapsulates messages. Messages can be either global or they are specific to a particular bean property. Each individual message is described by an ActionMessage object, which contains a message key (to be looked up in an appropriate message resources database), and up to four placeholder arguments used for parametric substitution in the resulting message. IMPLEMENTATION NOTE - It is assumed that these objects are created and manipulated only within the context of a single thread. Therefore, no synchronization is required for access to internal collections.
ActionError: An encapsulation of an individual error message returned by the validate method of an ActionForm , 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. The placeholder objects are referenced in the message text using the same syntax used by the JDK MessageFormat class. Thus, the first placeholder is '{0}', the second is '{1}', etc. Since Struts 1.1 ActionError extends ActionMessage .
DynaActionForm: Specialized subclass of ActionForm 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. USAGE NOTE - Since Struts 1.1, the reset method no longer initializes property values to those specified in <form-property> elements in the Struts module configuration file. If you wish to utilize that behavior, the simplest solution is to subclass DynaActionForm and call the initialize method inside it.
ActionFormBean: An ActionFormBean is the definition of a form bean that is loaded from a <form-bean> element in the Struts configuration file. It can be subclassed as necessary to add additional properties. Since Struts 1.1 ActionFormBean extends FormBeanConfig . NOTE - This class would have been deprecated and replaced by org.apache.struts.config.FormBeanConfig except for the fact that it is part of the public API that existing applications are using.
ActionServletWrapper: Provide a wrapper around an ActionServlet to expose only those methods needed by other objects. When used with an ActionForm , subclasses must be careful that they do not return an object with public getters and setters that could be exploited by automatic population of properties.
DownloadAction: This is an abstract base class that minimizes the amount of special coding that needs to be written to download a file. All that is required to use this class is to extend it and implement the getStreamInfo() method so that it returns the relevant information for the file (or other stream) to be downloaded. Optionally, the getBufferSize() method may be overridden to customize the size of the buffer used to transfer the file.
RequestProcessor: RequestProcessor contains the processing logic that the ActionServlet performs as it receives each servlet request from the container. You can customize the request processing behavior by subclassing this class and overriding the method(s) whose behavior you are interested in changing.
DynaActionFormClass: Implementation of DynaClass for DynaActionForm classes that allow developers to define ActionForms without having to individually code all of the classes. NOTE - This class is only used in the internal implementation of dynamic action form beans. Application developers never need to consult this documentation.

Home | Contact Us | Privacy Policy | Terms of Service