com.opensymphony.webwork.dispatcher
Class WebWorkResultSupport

java.lang.Object
  extended bycom.opensymphony.webwork.dispatcher.WebWorkResultSupport
All Implemented Interfaces:
com.opensymphony.xwork.Result, Serializable, WebWorkStatics
Direct Known Subclasses:
FreemarkerResult, JasperReportsResult, ServletDispatcherResult, ServletRedirectResult, StreamResult, VelocityResult

public abstract class WebWorkResultSupport
extends Object
implements com.opensymphony.xwork.Result, WebWorkStatics

A base class for all WebWork 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:

In the xwork.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</param>
      <param name="parse">false</param>
  </result>

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 doExecute(String, ActionInvocation).

Any custom result can be defined in xwork.xml as:

  <result-types>
      ...
      <result-type name="myresult" class="com.foo.MyResult" />
  </result-types>

Please see the Result class for more info on Results in general.

Author:
Jason Carreira, Bill Lynch (docs)
See Also:
Result, Serialized Form

Field Summary
static String DEFAULT_PARAM
           
protected  boolean parse
           
 
Fields inherited from interface com.opensymphony.webwork.WebWorkStatics
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERLVET_DISPATCHER, SERVLET_CONFIG, SERVLET_DISPATCHER
 
Constructor Summary
WebWorkResultSupport()
           
 
Method Summary
protected  String conditionalParse(String param, com.opensymphony.xwork.ActionInvocation invocation)
           
protected abstract  void doExecute(String finalLocation, com.opensymphony.xwork.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).
 void execute(com.opensymphony.xwork.ActionInvocation invocation)
          Implementation of the execute method from the Result interface.
 void setLocation(String location)
          The location to go to after action execution.
 void setParse(boolean parse)
          Set parse to true to indicate that the location should be parsed as an OGNL expression.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_PARAM

public static final String DEFAULT_PARAM
See Also:
Constant Field Values

parse

protected boolean parse
Constructor Detail

WebWorkResultSupport

public WebWorkResultSupport()
Method Detail

setLocation

public void setLocation(String location)
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:
setParse(boolean)

setParse

public void setParse(boolean parse)
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.

execute

public void execute(com.opensymphony.xwork.ActionInvocation invocation)
             throws Exception
Implementation of the execute method from the Result interface. This will call the abstract method doExecute(String, ActionInvocation) after optionally evaluating the location as an OGNL evaluation.

Specified by:
execute in interface com.opensymphony.xwork.Result
Parameters:
invocation - the execution state of the action.
Throws:
Exception - if an error occurs while executing the result.

conditionalParse

protected String conditionalParse(String param,
                                  com.opensymphony.xwork.ActionInvocation invocation)

doExecute

protected abstract void doExecute(String finalLocation,
                                  com.opensymphony.xwork.ActionInvocation invocation)
                           throws Exception
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.
invocation - the execution state of the action.
Throws:
Exception - if an error occurs while executing the result.

WebWork Project Page