ActionForward Struts 1.3)

Description

public class 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.

See also:

Constructors

public ActionForward ()

Construct a new instance with default values.

public ActionForward (ActionForward copyMe)

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

public ActionForward (String path)

Construct a new instance with the specified path.

public ActionForward (String path, boolean redirect)

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

public ActionForward (String name, String path, boolean redirect)

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

public ActionForward (String name, String path, boolean redirect, String module)

Construct a new instance with the specified values.

Methods

Hide/Show inherited methods

protected boolean checkCircularInheritance (ModuleConfig moduleConfig, ActionConfig actionConfig) [Inherited From ForwardConfig]

Traces the hierarchy of this object to check if any of the ancestors are extending this instance.

protected Properties copyProperties () [Inherited From BaseConfig]

Return a copy of the properties held by this object.

public void freeze () [Inherited From BaseConfig]

Freeze the configuration of this action.

public String getCatalog () [Inherited From ForwardConfig]

public String getCommand () [Inherited From ForwardConfig]

public String getExtends () [Inherited From ForwardConfig]

public String getModule () [Inherited From ForwardConfig]

public String getName () [Inherited From ForwardConfig]

public String getPath () [Inherited From ForwardConfig]

protected Properties getProperties () [Inherited From BaseConfig]

Return the entire set of properties configured for this object.

public String getProperty (String key) [Inherited From BaseConfig]

Return the property-value for the specified key, if any; otherwise return null.

Return the property-value for the specified key, if any; otherwise
return null.
Returns: the value stored with the supplied key
Parameters:
- key - a key specified in the struts-config file
Since: Struts 1.3

public boolean getRedirect () [Inherited From ForwardConfig]

public void inheritFrom (ForwardConfig config) throws ClassNotFoundException IllegalAccessException InstantiationException InvocationTargetException [Inherited From ForwardConfig]

Inherit values that have not been overridden from the provided config object.

Inherit values that have not been overridden from the provided config object. Subclasses overriding this method should verify that the given parameter is of a class that contains a property it is trying to inherit:

 if (config instanceof MyCustomConfig) {
     MyCustomConfig myConfig =
         (MyCustomConfig) config;

     if (getMyCustomProp() == null) {
         setMyCustomProp(myConfig.getMyCustomProp());
     }
 }

If the given config is extending another object, those extensions should be resolved before it's used as a parameter to this method.

Parameters:
- config - The object that this instance will be inheriting its values from.
See Also: ForwardConfig.processExtends(ModuleConfig, ActionConfig),

protected void inheritProperties (BaseConfig baseConfig) [Inherited From BaseConfig]

Compare the properties of this config with that of the given and copy those that are not present.

public boolean isExtensionProcessed () [Inherited From ForwardConfig]

public void processExtends (ModuleConfig moduleConfig, ActionConfig actionConfig) throws ClassNotFoundException IllegalAccessException InstantiationException InvocationTargetException [Inherited From ForwardConfig]

Inherit configuration information from the ForwardConfig that this instance is extending.

public void setCatalog (String catalog) [Inherited From ForwardConfig]

public void setCommand (String command) [Inherited From ForwardConfig]

public void setExtends (String inherit) [Inherited From ForwardConfig]

public void setModule (String module) [Inherited From ForwardConfig]

public void setName (String name) [Inherited From ForwardConfig]

public void setPath (String path) [Inherited From ForwardConfig]

protected void setProperties (Properties properties) [Inherited From BaseConfig]

Set the entire set of properties configured for this object.

public void setProperty (String key, String value) [Inherited From BaseConfig]

Set an arbitary key/value pair which can be retrieved by this config class.

Set an arbitary key/value pair which can be retrieved by this config class. This facility should eliminate many use cases for subclassing *Config classes by providing a mechanism to pass any amount of arbitrary configuration information into an config class.

This method must not be called after configuration is complete, or an IllegalStateException will be thrown.

Example

 <action path="/example" type="com.example.MyAction">
    <set-property key="foo" property="bar" />
 </action>

Parameters:
- key - the key by which this value will be retrieved
- value - the value to store with the supplied key
Throws:
- IllegalStateException - if this module configuration has been frozen
Since: Struts 1.3

public void setRedirect (boolean redirect) [Inherited From ForwardConfig]

public void throwIfConfigured () [Inherited From BaseConfig]

Throw IllegalStateException if configuration is frozen.

Throw IllegalStateException if configuration is frozen.
Throws:
- IllegalStateException - if configuration is frozen

public String toString () [Inherited From ForwardConfig]

Return a String representation of this object.

Fields

Hide/Show inherited fields

protected String catalog [Inherited From ForwardConfig]

The name of a commons-chain catalog in which command should be looked up.

protected String command [Inherited From ForwardConfig]

The name of a commons-chain command which should be looked up and executed before Struts dispatches control to the view represented by this config.

protected boolean configured [Inherited From BaseConfig]

Indicates if configuration of this component been completed.

protected boolean extensionProcessed [Inherited From ForwardConfig]

Have the inheritance values for this class been applied?

protected String inherit [Inherited From ForwardConfig]

The name of the ForwardConfig that this object should inherit properties from.

protected String module [Inherited From ForwardConfig]

The prefix of the module to which this ForwardConfig entry points, which must start with a slash ("/") character.

protected String name [Inherited From ForwardConfig]

The unique identifier of this forward, which is used to reference it in Action classes.

protected String path [Inherited From ForwardConfig]

The URL to which this ForwardConfig entry points, which must start with a slash ("/") character.

protected boolean redirect [Inherited From ForwardConfig]

Should a redirect be used to transfer control to the specified path?