| java.lang.Object
 org.apache.struts2.dispatcher.StrutsResultSupport
All known Subclasses: org.apache.struts2.views.freemarker.FreemarkerResult, org.apache.struts2.dispatcher.StreamResult, org.apache.struts2.dispatcher.ServletRedirectResult, org.apache.struts2.portlet.result.PortletVelocityResult, org.apache.struts2.dispatcher.VelocityResult, org.apache.struts2.dispatcher.ServletDispatcherResult, org.apache.struts2.dispatcher.PlainTextResult, org.apache.struts2.portlet.result.PortletResult, org.apache.struts2.views.freemarker.PortletFreemarkerResult,
| StrutsResultSupport | | abstract public class StrutsResultSupport implements Result,StrutsStatics(Code) | |
A base class for all Struts action execution results.
The "location" param is the default parameter, meaning the most common usage of this result would be:
This class provides two common parameters for any subclass:
- location - the location to go to after execution (could be a jsp page or another action).
It can be parsed as per the rules definied in the
TextParseUtil.translateVariables(java.lang.Stringcom.opensymphony.xwork2.util.ValueStack) translateVariables method
- parse - true by default. If set to false, the location param will not be parsed for expressions
- encode - false by default. If set to false, the location param will not be url encoded. This only have effect when parse is true
NOTE:
The encode param will only have effect when parse is true
In the struts.xml configuration file, these would be included as:
<result name="success" type="redirect">
<param name="location">foo.jsp</param>
</result>
or
<result name="success" type="redirect" >
<param name="location">foo.jsp?url=${myUrl}</param>
<param name="parse">true</param>
<param name="encode">true</param>
</result>
In the above case, myUrl will be parsed against Ognl Value Stack and then
URL encoded.
or when using the default parameter feature
<result name="success" type="redirect">foo.jsp</result>
You should subclass this class if you're interested in adding more parameters or functionality
to your Result. If you do subclass this class you will need to
override
StrutsResultSupport.doExecute(String,ActionInvocation) .
Any custom result can be defined in struts.xml as:
<result-types>
...
<result-type name="myresult" class="com.foo.MyResult" />
</result-types>
Please see the
com.opensymphony.xwork2.Result class for more info on Results in general.
See Also: com.opensymphony.xwork2.Result |
| Method Summary | |
| protected String | conditionalParse(String param, ActionInvocation invocation)
| | abstract protected void | doExecute(String finalLocation, ActionInvocation invocation)
Executes the result given a final location (jsp page, action, etc) and the action invocation
(the state in which the action was executed). | | public void | execute(ActionInvocation invocation)
Implementation of the execute method from the Result interface. | | public String | getLastFinalLocation()
| | public void | setEncode(boolean encode)
Set encode to true to indicate that the location should be url encoded. | | public void | setLocation(String location)
The location to go to after action execution. | | public void | setParse(boolean parse)
Set parse to true to indicate that the location should be parsed as an OGNL expression. |
| DEFAULT_PARAM | | final public static String DEFAULT_PARAM(Code) | | The default parameter
|
| StrutsResultSupport | | public StrutsResultSupport()(Code) | | |
| StrutsResultSupport | | public StrutsResultSupport(String location)(Code) | | |
| StrutsResultSupport | | public StrutsResultSupport(String location, boolean parse, boolean encode)(Code) | | |
| conditionalParse | | protected String conditionalParse(String param, ActionInvocation invocation)(Code) | | Parses the parameter for OGNL expressions against the valuestack
Parameters:
param - The parameter value
Parameters:
invocation - The action invocation instance The resulting string |
| doExecute | | abstract protected void doExecute(String finalLocation, ActionInvocation invocation) throws Exception(Code) | | Executes the result given a final location (jsp page, action, etc) and the action invocation
(the state in which the action was executed). Subclasses must implement this class to handle
custom logic for result handling.
Parameters:
finalLocation - the location (jsp page, action, etc) to go to.
Parameters:
invocation - the execution state of the action.
throws:
Exception - if an error occurs while executing the result. |
| execute | | public void execute(ActionInvocation invocation) throws Exception(Code) | | 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.
Parameters:
invocation - the execution state of the action.
throws:
Exception - if an error occurs while executing the result. |
| getLastFinalLocation | | public String getLastFinalLocation()(Code) | | Returns the last parsed and encoded location value
|
| setEncode | | public void setEncode(boolean encode)(Code) | | Set encode to true to indicate that the location should be url encoded. This is set to
true by default
Parameters:
encode - true if the location parameter should be url encode, false otherwise. |
| setLocation | | public void setLocation(String location)(Code) | | The location to go to after action execution. This could be a JSP page or another action.
The location can contain OGNL expressions which will be evaulated if the parse
parameter is set to true.
Parameters:
location - the location to go to after action execution.
See Also: StrutsResultSupport.setParse(boolean) |
| setParse | | public void setParse(boolean parse)(Code) | | Set parse to true to indicate that the location should be parsed as an OGNL expression. This
is set to true by default.
Parameters:
parse - true if the location parameter is an OGNL expression, false otherwise. |
|
|