|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.struts.config.ForwardConfig | +--org.apache.struts.action.ActionForward | +--org.apache.struts.action.ActionRedirect
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;
}
Field Summary | |
protected static org.apache.commons.logging.Log |
log
Commons logging instance. |
protected java.util.Map |
parameterValues
Holds the redirect parameters. |
Fields inherited from class org.apache.struts.config.ForwardConfig |
configured, contextRelative, module, name, path, redirect |
Constructor Summary | |
ActionRedirect()
Construct a new instance with redirect set to true and initialize parameter lists. |
|
ActionRedirect(ForwardConfig baseConfig)
Construct a new instance with a ForwardConfig object
to copy name, path, and contextRelative values from. |
|
ActionRedirect(java.lang.String path)
Construct a new instance with the specified path and initialize parameter lists. |
|
ActionRedirect(java.lang.String name,
java.lang.String path,
java.lang.String module)
Construct a new instance with the specified values and initialize parameter lists. |
Method Summary | |
void |
addParameter(java.lang.String fieldName,
java.lang.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. |
java.lang.String |
getOriginalPath()
Get the original path without the parameters added at runtime. |
java.lang.String |
getParameterString()
Forms the string containing the parameters passed onto this object thru calls to addParameter(). |
java.lang.String |
getPath()
Get the path for this object, including any parameters that may have been added at runtime. |
private void |
initializeParameters()
Initializes the internal objects used to hold parameter values. |
java.lang.String |
toString()
Return a string description of this object. |
Methods inherited from class org.apache.struts.config.ForwardConfig |
freeze, getContextRelative, getModule, getName, getRedirect, setContextRelative, setModule, setName, setPath, setRedirect |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected static final org.apache.commons.logging.Log log
Commons logging instance.
protected java.util.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 |
public ActionRedirect()
Construct a new instance with redirect set to true and initialize parameter lists.
public ActionRedirect(java.lang.String path)
Construct a new instance with the specified path and initialize parameter lists.
path
- Path for this instancepublic ActionRedirect(java.lang.String name, java.lang.String path, java.lang.String module)
Construct a new instance with the specified values and initialize parameter lists.
name
- Name of this instancepath
- Path for this instancemodule
- Module prefix, if anypublic ActionRedirect(ForwardConfig baseConfig)
Construct a new instance with a ForwardConfig
object
to copy name, path, and contextRelative values from.
baseConfig
- the ForwardConfig
to copy configuration values fromMethod Detail |
private void initializeParameters()
Initializes the internal objects used to hold parameter values.
public void addParameter(java.lang.String fieldName, java.lang.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.
fieldName
- the name to use for the parametervalueObj
- the value for this parameterpublic java.lang.String getOriginalPath()
Get the original path without the parameters added at runtime.
public java.lang.String getPath()
Get the path for this object, including any parameters that may have been added at runtime.
getPath
in class ForwardConfig
public java.lang.String getParameterString()
Forms the string containing the parameters passed onto this object thru calls to addParameter().
public java.lang.String toString()
Return a string description of this object.
toString
in class ForwardConfig
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |