org.apache.struts.action

Class ActionRedirect

public class ActionRedirect extends ActionForward

A subclass of ActionForward which is designed for use in redirecting requests, with support for adding parameters at runtime.
An 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; }

Since: Struts 1.2.7

Version: $Rev: 164747 $ $Date: 2005-04-26 06:47:48 +0100 (Tue, 26 Apr 2005) $

Field Summary
protected static Loglog

Commons logging instance.

protected MapparameterValues

Holds the redirect parameters.

Constructor Summary
ActionRedirect()

Construct a new instance with redirect set to true and initialize parameter lists.

ActionRedirect(String path)

Construct a new instance with the specified path and initialize parameter lists.

ActionRedirect(String name, String path, String module)

Construct a new instance with the specified values and initialize parameter lists.

ActionRedirect(ForwardConfig baseConfig)

Construct a new instance with a ForwardConfig object to copy name, path, and contextRelative values from.

Method Summary
voidaddParameter(String fieldName, Object valueObj)

Adds the object's toString() to the list of parameters if it's not null, or an empty string with the given fieldName if it is.

StringgetOriginalPath()

Get the original path without the parameters added at runtime.

StringgetParameterString()

Forms the string containing the parameters passed onto this object thru calls to addParameter().

StringgetPath()

Get the path for this object, including any parameters that may have been added at runtime.

voidinitializeParameters()

Initializes the internal objects used to hold parameter values.

StringtoString()

Return a string description of this object.

Field Detail

log

protected static final Log log

Commons logging instance.

parameterValues

protected Map parameterValues

Holds the redirect parameters. Each entry is either a String or a String[] depending on whether it has one or more entries.

Constructor Detail

ActionRedirect

public ActionRedirect()

Construct a new instance with redirect set to true and initialize parameter lists.

ActionRedirect

public ActionRedirect(String path)

Construct a new instance with the specified path and initialize parameter lists.

Parameters: path Path for this instance

ActionRedirect

public ActionRedirect(String name, String path, String module)

Construct a new instance with the specified values and initialize parameter lists.

Parameters: name Name of this instance path Path for this instance module Module prefix, if any

ActionRedirect

public ActionRedirect(ForwardConfig baseConfig)

Construct a new instance with a ForwardConfig object to copy name, path, and contextRelative values from.

Parameters: baseConfig the ForwardConfig to copy configuration values from

Method Detail

addParameter

public void addParameter(String fieldName, Object valueObj)

Adds the object's toString() to the list of parameters if it's not null, or an empty string with the given fieldName if it is.

Parameters: fieldName the name to use for the parameter valueObj the value for this parameter

getOriginalPath

public String getOriginalPath()

Get the original path without the parameters added at runtime.

Returns: the original path as configured.

getParameterString

public String getParameterString()

Forms the string containing the parameters passed onto this object thru calls to addParameter().

Returns: a string which can be appended to the URLs. The return string does not include a leading question mark (?).

getPath

public String getPath()

Get the path for this object, including any parameters that may have been added at runtime.

initializeParameters

private void initializeParameters()

Initializes the internal objects used to hold parameter values.

toString

public String toString()

Return a string description of this object.

Returns: a string containing the original path for this object and the parameters it currently holds

Copyright B) 2000-2009 - The Apache Software Foundation