Apache Struts API Documentation: Class ActionForward

org.apache.struts.action Class ActionForward

java.lang.Object
  |
  +--org.apache.struts.config.ForwardConfig
        |
        +--org.apache.struts.action.ActionForward

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActionRedirect, ForwardingActionForward, RedirectingActionForward

public class ActionForward

extends ForwardConfig

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 the path value be interpreted as context-relative (instead of module-relative, if it starts with a '/' character? [false]
• name - Logical name by which this instance may be looked up in relationship to a particular ActionMapping.
• path - Module-relative or context-relative URI to which control should be forwarded, or an absolute or relative URI to which control should be redirected.
• redirect - Set to true if the controller servlet should call HttpServletResponse.sendRedirect() on the associated path; otherwise false. [false]

Since Struts 1.1 this class extends ForwardConfig and inherits the contextRelative property.

NOTE - This class would have been deprecated and replaced by org.apache.struts.config.ForwardConfig except for the fact that it is part of the public API that existing applications are using.

Version:

$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

See Also:

Serialized Form

ActionForward

public ActionForward()

Construct a new instance with default values.

ActionForward

public ActionForward(java.lang.String path)

Construct a new instance with the specified path.

Parameters:

path - Path for this instance

ActionForward

public ActionForward(java.lang.String path,
                     boolean redirect)

Construct a new instance with the specified path and redirect flag.

Parameters:

path - Path for this instance

redirect - Redirect flag for this instance

ActionForward

public ActionForward(java.lang.String name,
                     java.lang.String path,
                     boolean redirect)

Construct a new instance with the specified name, path and redirect flag.

Parameters:

name - Name of this instance

path - Path for this instance

redirect - Redirect flag for this instance

ActionForward

public ActionForward(java.lang.String name,
                     java.lang.String path,
                     boolean redirect,
                     boolean contextRelative)

Deprecated. Use module rather than contextRelative

Construct a new instance with the specified values.

Parameters:

name - Name of this instance

path - Path for this instance

redirect - Redirect flag for this instance

contextRelative - Context relative flag for this instance

ActionForward

public ActionForward(java.lang.String name,
                     java.lang.String path,
                     boolean redirect,
                     java.lang.String module)

Construct a new instance with the specified values.

Parameters:

name - Name of this forward

path - Path to which control should be forwarded or redirected

redirect - Should we do a redirect?

module - Module prefix, if any

ActionForward

public ActionForward(ActionForward copyMe)

Construct a new instance based on the values of another ActionForward.

Parameters:

copyMe - An ActionForward instance to copy

Since:

Struts 1.2.1