org.apache.struts2.dispatcher: abstract public class: StrutsResultSupport

org.apache.struts2.dispatcher
abstract public class: StrutsResultSupport [javadoc | source]

java.lang.Object
   org.apache.struts2.dispatcher.StrutsResultSupport

All Implemented Interfaces:
com.opensymphony.xwork2.Result, StrutsStatics

Direct Known Subclasses:
PortletVelocityResult, PortletResult, PortletFreemarkerResult, StreamResult, PortletActionRedirectResult, PlainTextResult, ServletRedirectResult, FreemarkerResult, ServletActionRedirectResult, ServletDispatcherResult, VelocityResult

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 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>

<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 #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.

Also see:

com.opensymphony.xwork2.Result

Field Summary
public static final String	DEFAULT_PARAM	The default parameter

Constructor:
public StrutsResultSupport() { this(null, true, false); }
public StrutsResultSupport(String location) { this(location, true, false); }
public StrutsResultSupport(String location, boolean parse, boolean encode) { this.location = location; this.parse = parse; this.encode = encode; }

Constructor:

 public StrutsResultSupport() {
      
        this(null, true, false);
}

 public StrutsResultSupport(String location) {
        this(location, true, false);
}

 public StrutsResultSupport(String location,
    boolean parse,
    boolean encode) {
        this.location = location;
        this.parse = parse;
        this.encode = encode;
}

Method from org.apache.struts2.dispatcher.StrutsResultSupport Summary:
conditionalParse, doExecute, execute, getLastFinalLocation, setEncode, setLocation, setParse

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.struts2.dispatcher.StrutsResultSupport Detail:
protected String conditionalParse(String param, ActionInvocation invocation) { if (parse && param != null && invocation != null) { return TextParseUtil.translateVariables(param, invocation.getStack(), new TextParseUtil.ParsedValueEvaluator() { public Object evaluate(Object parsedValue) { if (encode) { if (parsedValue != null) { try { // use UTF-8 as this is the recommended encoding by W3C to // avoid incompatibilities. return URLEncoder.encode(parsedValue.toString(), "UTF-8"); } catch(UnsupportedEncodingException e) { _log.warn("error while trying to encode ["+parsedValue+"]", e); } } } return parsedValue; } }); } else { return param; } } Parses the parameter for OGNL expressions against the valuestack
abstract protected void doExecute(String finalLocation, 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.
public void execute(ActionInvocation invocation) throws Exception { lastFinalLocation = conditionalParse(location, invocation); doExecute(lastFinalLocation, invocation); } 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.
public String getLastFinalLocation() { return lastFinalLocation; } Returns the last parsed and encoded location value
public void setEncode(boolean encode) { this.encode = encode; } Set encode to `true` to indicate that the location should be url encoded. This is set to `true` by default
public void setLocation(String location) { this.location = 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`.
public void setParse(boolean parse) { this.parse = parse; } Set parse to `true` to indicate that the location should be parsed as an OGNL expression. This is set to `true` by default.

Method from org.apache.struts2.dispatcher.StrutsResultSupport Detail:

 protected String conditionalParse(String param,
    ActionInvocation invocation) {
        if (parse && param != null && invocation != null) {
            return TextParseUtil.translateVariables(param, invocation.getStack(),
                    new TextParseUtil.ParsedValueEvaluator() {
                        public Object evaluate(Object parsedValue) {
                            if (encode) {
                                if (parsedValue != null) {
                                    try {
                                        // use UTF-8 as this is the recommended encoding by W3C to
                                        // avoid incompatibilities.
                                        return URLEncoder.encode(parsedValue.toString(), "UTF-8");
                                    }
                                    catch(UnsupportedEncodingException e) {
                                        _log.warn("error while trying to encode ["+parsedValue+"]", e);
                                    }
                                }
                            }
                            return parsedValue;
                        }
            });
        } else {
            return param;
        }
}

Parses the parameter for OGNL expressions against the valuestack

 abstract protected  void doExecute(String finalLocation,
    ActionInvocation invocation) throws ExceptionExecutes 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.

 public  void execute(ActionInvocation invocation) throws Exception {
        lastFinalLocation = conditionalParse(location, invocation);
        doExecute(lastFinalLocation, invocation);
}

execute

Result

#doExecute(String, ActionInvocation)

 public String getLastFinalLocation() {
        return lastFinalLocation;
}

Returns the last parsed and encoded location value

 public  void setEncode(boolean encode) {
        this.encode = encode;
}

true

 public  void setLocation(String location) {
        this.location = location;
}

parse

true

 public  void setParse(boolean parse) {
        this.parse = parse;
}

true