diff --git a/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletActionRedirectResult.java b/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletActionRedirectResult.java index 013bb6596..77ffc7d3f 100644 --- a/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletActionRedirectResult.java +++ b/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletActionRedirectResult.java @@ -26,9 +26,12 @@ import java.util.LinkedHashMap; import java.util.List; import java.util.Map; +import javax.portlet.PortletMode; + import org.apache.struts2.dispatcher.ServletActionRedirectResult; import org.apache.struts2.dispatcher.mapper.ActionMapper; import org.apache.struts2.dispatcher.mapper.ActionMapping; +import org.apache.struts2.portlet.PortletActionConstants; import org.apache.struts2.views.util.UrlHelper; import com.opensymphony.xwork2.ActionInvocation; @@ -40,78 +43,86 @@ import com.opensymphony.xwork2.inject.Inject; * Portlet modification of the {@link ServletActionRedirectResult}. * * - - * This result uses the {@link ActionMapper} provided by the {@link ActionMapperFactory} to instruct the render phase to - * invoke the specified action and (optional) namespace. This is better than the {@link PortletResult} - * because it does not require you to encode the URL patterns processed by the {@link 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 + * + * This result uses the {@link ActionMapper} provided by the + * {@link ActionMapperFactory} to instruct the render phase to invoke the + * specified action and (optional) namespace. This is better than the + * {@link PortletResult} because it does not require you to encode the URL + * patterns processed by the {@link 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. - * + * + * See examples below for an example of how request parameters could be passed + * in. + * * - * + * * This result type takes the following parameters: - * + * * - * + * * - * + * * - * + * * 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>
+ * 
+ * 
+ * <!-- START SNIPPET: 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>
- *
- * <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>
- *
- *
- * 
- * + * </package> + * + * + * <!-- END SNIPPET: example --> + *
+ * * @see ActionMapper */ public class PortletActionRedirectResult extends PortletResult { @@ -119,120 +130,129 @@ public class PortletActionRedirectResult extends PortletResult { private static final long serialVersionUID = -7627388936683562557L; /** The default parameter */ - public static final String DEFAULT_PARAM = "actionName"; + public static final String DEFAULT_PARAM = "actionName"; - protected String actionName; - protected String namespace; - protected String method; + protected String actionName; - private Map requestParameters = new LinkedHashMap(); + protected String namespace; - private ActionMapper actionMapper; - - public PortletActionRedirectResult() { - super(); - } + protected String method; - public PortletActionRedirectResult(String actionName) { - this(null, actionName, null); - } + private Map requestParameters = new LinkedHashMap(); - public PortletActionRedirectResult(String actionName, String method) { - this(null, actionName, method); - } + private ActionMapper actionMapper; - public PortletActionRedirectResult(String namespace, String actionName, String method) { - super(null); - this.namespace = namespace; - this.actionName = actionName; - this.method = method; - } - - protected List prohibitedResultParam = Arrays.asList(new String[] { - DEFAULT_PARAM, "namespace", "method", "encode", "parse", "location", - "prependServletContext" }); + public PortletActionRedirectResult() { + super(); + } - @Inject - public void setActionMapper(ActionMapper actionMapper) { - this.actionMapper = actionMapper; - } - - /** - * @see com.opensymphony.xwork2.Result#execute(com.opensymphony.xwork2.ActionInvocation) - */ - public void execute(ActionInvocation invocation) throws Exception { - actionName = conditionalParse(actionName, invocation); - if (namespace == null) { - namespace = invocation.getProxy().getNamespace(); - } else { - namespace = conditionalParse(namespace, invocation); - } - if (method == null) { - method = ""; - } - else { - method = conditionalParse(method, invocation); - } + public PortletActionRedirectResult(String actionName) { + this(null, actionName, null); + } - String resultCode = invocation.getResultCode(); - if (resultCode != null) { - ResultConfig resultConfig = invocation.getProxy().getConfig().getResults().get( - resultCode); - Map resultConfigParams = resultConfig.getParams(); - for (Iterator i = resultConfigParams.entrySet().iterator(); i.hasNext(); ) { - Map.Entry e = (Map.Entry) i.next(); - if (! prohibitedResultParam.contains(e.getKey())) { - requestParameters.put(e.getKey().toString(), - e.getValue() == null ? "": - conditionalParse(e.getValue().toString(), invocation)); - } - } - } + public PortletActionRedirectResult(String actionName, String method) { + this(null, actionName, method); + } - StringBuffer tmpLocation = new StringBuffer(actionMapper.getUriFromActionMapping(new ActionMapping(actionName, namespace, method, null))); - UrlHelper.buildParametersString(requestParameters, tmpLocation, "&"); + public PortletActionRedirectResult(String namespace, String actionName, String method) { + super(null); + this.namespace = namespace; + this.actionName = actionName; + this.method = method; + } - setLocation(tmpLocation.toString()); + protected List prohibitedResultParam = Arrays.asList(new String[] { DEFAULT_PARAM, "namespace", "method", + "encode", "parse", "location", "prependServletContext" }); - super.execute(invocation); - } + @Inject + public void setActionMapper(ActionMapper actionMapper) { + this.actionMapper = actionMapper; + } - /** - * Sets the action name - * - * @param actionName The name - */ - public void setActionName(String actionName) { - this.actionName = actionName; - } + /** + * @see com.opensymphony.xwork2.Result#execute(com.opensymphony.xwork2.ActionInvocation) + */ + public void execute(ActionInvocation invocation) throws Exception { + actionName = conditionalParse(actionName, invocation); + if (portletMode != null) { + Map namespaceMap = (Map) invocation.getInvocationContext().get( + PortletActionConstants.MODE_NAMESPACE_MAP); + namespace = namespaceMap.get(portletMode); + } + if (namespace == null) { + namespace = invocation.getProxy().getNamespace(); + } else { + namespace = conditionalParse(namespace, invocation); + } + if (method == null) { + method = ""; + } else { + method = conditionalParse(method, invocation); + } - /** - * Sets the namespace - * - * @param namespace The namespace - */ - public void setNamespace(String namespace) { - this.namespace = namespace; - } + String resultCode = invocation.getResultCode(); + if (resultCode != null) { + ResultConfig resultConfig = invocation.getProxy().getConfig().getResults().get(resultCode); + Map resultConfigParams = resultConfig.getParams(); + for (Iterator i = resultConfigParams.entrySet().iterator(); i.hasNext();) { + Map.Entry e = (Map.Entry) i.next(); + if (!prohibitedResultParam.contains(e.getKey())) { + requestParameters.put(e.getKey().toString(), e.getValue() == null ? "" : conditionalParse(e + .getValue().toString(), invocation)); + } + } + } - /** - * Sets the method - * - * @param method The method - */ - public void setMethod(String method) { - this.method = method; - } + StringBuffer tmpLocation = new StringBuffer(actionMapper.getUriFromActionMapping(new ActionMapping(actionName, + namespace, method, null))); + UrlHelper.buildParametersString(requestParameters, tmpLocation, "&"); - /** - * Adds a request parameter to be added to the redirect url - * - * @param key The parameter name - * @param value The parameter value - */ - public PortletActionRedirectResult addParameter(String key, Object value) { - requestParameters.put(key, String.valueOf(value)); - return this; - } + setLocation(tmpLocation.toString()); + + super.execute(invocation); + } + + /** + * Sets the action name + * + * @param actionName + * The name + */ + public void setActionName(String actionName) { + this.actionName = actionName; + } + + /** + * Sets the namespace + * + * @param namespace + * The namespace + */ + public void setNamespace(String namespace) { + this.namespace = namespace; + } + + /** + * Sets the method + * + * @param method + * The method + */ + public void setMethod(String method) { + this.method = method; + } + + /** + * Adds a request parameter to be added to the redirect url + * + * @param key + * The parameter name + * @param value + * The parameter value + */ + public PortletActionRedirectResult addParameter(String key, Object value) { + requestParameters.put(key, String.valueOf(value)); + return this; + } } diff --git a/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletResult.java b/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletResult.java index feef9c63d..693c58901 100644 --- a/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletResult.java +++ b/plugins/portlet/src/main/java/org/apache/struts2/portlet/result/PortletResult.java @@ -27,6 +27,7 @@ import java.util.StringTokenizer; import javax.portlet.ActionResponse; import javax.portlet.PortletContext; import javax.portlet.PortletException; +import javax.portlet.PortletMode; import javax.portlet.PortletRequestDispatcher; import javax.portlet.RenderRequest; import javax.portlet.RenderResponse; @@ -66,6 +67,8 @@ public class PortletResult extends StrutsResultSupport implements PortletActionC private String contentType = "text/html"; private String title; + + protected PortletMode portletMode; public PortletResult() { super(); @@ -121,7 +124,7 @@ public class PortletResult extends StrutsResultSupport implements PortletActionC * @param finalLocation * @param invocation */ - protected void executeActionResult(String finalLocation, ActionInvocation invocation) { + protected void executeActionResult(String finalLocation, ActionInvocation invocation) throws Exception { LOG.debug("Executing result in Event phase"); ActionResponse res = PortletActionContext.getActionResponse(); Map sessionMap = invocation.getInvocationContext().getSession(); @@ -139,8 +142,14 @@ public class PortletResult extends StrutsResultSupport implements PortletActionC res.setRenderParameter(ACTION_PARAM, "renderDirect"); sessionMap.put(RENDER_DIRECT_LOCATION, finalLocation); } - res.setRenderParameter(PortletActionConstants.MODE_PARAM, PortletActionContext.getRequest().getPortletMode() - .toString()); + if(portletMode != null) { + res.setPortletMode(portletMode); + res.setRenderParameter(PortletActionConstants.MODE_PARAM, portletMode.toString()); + } + else { + res.setRenderParameter(PortletActionConstants.MODE_PARAM, PortletActionContext.getRequest().getPortletMode() + .toString()); + } } /** @@ -211,6 +220,12 @@ public class PortletResult extends StrutsResultSupport implements PortletActionC public void setTitle(String title) { this.title = title; } + + public void setPortletMode(String portletMode) { + if(portletMode != null) { + this.portletMode = new PortletMode(portletMode); + } + } @Inject("struts.portlet.useDispatcherServlet") public void setUseDispatcherServlet(String useDispatcherServlet) {