org.apache.struts2.portlet.result
Class PortletActionRedirectResult
java.lang.Object
org.apache.struts2.dispatcher.StrutsResultSupport
org.apache.struts2.portlet.result.PortletResult
org.apache.struts2.portlet.result.PortletActionRedirectResult
- All Implemented Interfaces:
- Result, Serializable, PortletActionConstants, StrutsStatics
public class PortletActionRedirectResult
- extends PortletResult
Portlet modification of the ServletActionRedirectResult
.
This result uses the ActionMapper
provided by the ActionMapperFactory
to instruct the render phase to
invoke the specified action and (optional) namespace. This is better than the PortletResult
because it does not require you to encode the URL patterns processed by the ActionMapper
in to your struts.xml
configuration files. This means you can change your URL patterns at any point and your application will still work.
It is strongly recommended that if you are redirecting to another action, you use this result rather than the
standard redirect result.
See examples below for an example of how request parameters could be passed in.
This result type takes the following parameters:
- actionName (default) - the name of the action that will be redirect to
- namespace - used to determine which namespace the action is in that we're redirecting to . If namespace is
null, this defaults to the current namespace
Example:
<package name="public" extends="struts-default">
<action name="login" class="...">
<!-- Redirect to another namespace -->
<result type="redirect-action">
<param name="actionName">dashboard</param>
<param name="namespace">/secure</param>
</result>
</action>
</package>
<package name="secure" extends="struts-default" namespace="/secure">
<-- Redirect to an action in the same namespace -->
<action name="dashboard" class="...">
<result>dashboard.jsp</result>
<result name="error" type="redirect-action">error</result>
</action>
<action name="error" class="...">
<result>error.jsp</result>
</action>
</package>
<package name="passingRequestParameters" extends="struts-default" namespace="/passingRequestParameters">
<-- Pass parameters (reportType, width and height) -->
<!--
The redirect-action url generated will be :
/genReport/generateReport.action?reportType=pie&width=100&height=100
-->
<action name="gatherReportInfo" class="...">
<result name="showReportResult" type="redirect-action">
<param name="actionName">generateReport</param>
<param name="namespace">/genReport</param>
<param name="reportType">pie</param>
<param name="width">100</param>
<param name="height">100</param>
</result>
</action>
</package>
- See Also:
ActionMapper
,
Serialized Form
Fields inherited from interface org.apache.struts2.portlet.PortletActionConstants |
ACTION_PARAM, ACTION_RESET, DEFAULT_ACTION_FOR_MODE, DEFAULT_ACTION_NAME, DEFAULT_DISPATCHER_SERVLET_NAME, ERROR_ACTION, EVENT_ACTION, EVENT_PHASE, MODE_NAMESPACE_MAP, MODE_PARAM, PHASE, PORTLET_CONFIG, PORTLET_NAMESPACE, RENDER_DIRECT_LOCATION, RENDER_PHASE, REQUEST, RESPONSE, STACK_FROM_EVENT_PHASE |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
DEFAULT_PARAM
public static final String DEFAULT_PARAM
- The default parameter
- See Also:
- Constant Field Values
actionName
protected String actionName
namespace
protected String namespace
method
protected String method
requestParameters
private Map<String,String> requestParameters
actionMapper
private ActionMapper actionMapper
prohibitedResultParam
protected List<String> prohibitedResultParam
PortletActionRedirectResult
public PortletActionRedirectResult()
PortletActionRedirectResult
public PortletActionRedirectResult(String actionName)
PortletActionRedirectResult
public PortletActionRedirectResult(String actionName,
String method)
PortletActionRedirectResult
public PortletActionRedirectResult(String namespace,
String actionName,
String method)
setActionMapper
public void setActionMapper(ActionMapper actionMapper)
execute
public void execute(ActionInvocation invocation)
throws Exception
- Description copied from class:
StrutsResultSupport
- Implementation of the execute method from the Result interface. This will call
the abstract method
StrutsResultSupport.doExecute(String, ActionInvocation)
after optionally evaluating the
location as an OGNL evaluation.
- Specified by:
execute
in interface Result
- Overrides:
execute
in class StrutsResultSupport
- Parameters:
invocation
- the execution state of the action.
- Throws:
Exception
- if an error occurs while executing the result.- See Also:
Result.execute(com.opensymphony.xwork2.ActionInvocation)
setActionName
public void setActionName(String actionName)
- Sets the action name
- Parameters:
actionName
- The name
setNamespace
public void setNamespace(String namespace)
- Sets the namespace
- Parameters:
namespace
- The namespace
setMethod
public void setMethod(String method)
- Sets the method
- Parameters:
method
- The method
addParameter
public PortletActionRedirectResult addParameter(String key,
Object value)
- Adds a request parameter to be added to the redirect url
- Parameters:
key
- The parameter namevalue
- The parameter value
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.