Struts example source code file (PortletActionRedirectResult.java)

This example Struts source code file (PortletActionRedirectResult.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Struts tags/keywords

default_param, default_param, iterator, linkedhashmap, log, map, map, portletactionredirectresult, portletactionredirectresult, reflectionexceptionhandler, resultconfig, string, string, stringbuilder, util

The Struts PortletActionRedirectResult.java source code

/*
 * $Id: PortletActionRedirectResult.java 833239 2009-11-05 23:46:50Z rgielen $
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.struts2.portlet.result;

import java.util.Arrays;
import java.util.Iterator;
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;
import com.opensymphony.xwork2.util.reflection.ReflectionExceptionHandler;
import com.opensymphony.xwork2.util.reflection.ReflectionException;
import com.opensymphony.xwork2.util.logging.Logger;
import com.opensymphony.xwork2.util.logging.LoggerFactory;
import com.opensymphony.xwork2.config.entities.ResultConfig;
import com.opensymphony.xwork2.inject.Inject;

/**
 *
 * Portlet modification of the {@link ServletActionRedirectResult}.
 *
 * <!-- START SNIPPET: description -->
 *
 * 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.
 *
 * <!-- END SNIPPET: description -->
 *
 * <b>This result type takes the following parameters:
 *
 * <!-- START SNIPPET: params -->
 *
 * <ul>
 *
 * <li>actionName (default) - the name of the action that will be
 * redirect to</li>
 *
 * <li>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</li>
 *
 * </ul>
 *
 * <!-- END SNIPPET: params -->
 *
 * <b>Example:
 *
 * <pre>
 * <!-- START SNIPPET: example -->
 *  <package name="public" extends="struts-default">
 *      <action name="login" class="...">
 *          <!-- Redirect to another namespace -->
 *          <result type="redirectAction">
 *              <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="redirectAction">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 redirectAction url generated will be :
 *     /genReport/generateReport.action?reportType=pie&width=100&height=100
 *     -->
 *     <action name="gatherReportInfo" class="...">
 *        <result name="showReportResult" type="redirectAction">
 *           <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>
 *
 *
 *  <!-- END SNIPPET: example -->
 * </pre>
 *
 * @see ActionMapper
 */
public class PortletActionRedirectResult extends PortletResult implements ReflectionExceptionHandler {

	private static final long serialVersionUID = -7627388936683562557L;

    private static final Logger LOG = LoggerFactory.getLogger(PortletActionRedirectResult.class);

    /** The default parameter */
	public static final String DEFAULT_PARAM = "actionName";

	protected String actionName;

	protected String namespace;

	protected String method;

	private Map<String, String> requestParameters = new LinkedHashMap();

	private ActionMapper actionMapper;

	public PortletActionRedirectResult() {
		super();
	}

	public PortletActionRedirectResult(String actionName) {
		this(null, actionName, null);
	}

	public PortletActionRedirectResult(String actionName, String method) {
		this(null, actionName, method);
	}

	public PortletActionRedirectResult(String namespace, String actionName, String method) {
		super(null);
		this.namespace = namespace;
		this.actionName = actionName;
		this.method = method;
	}

	protected List<String> prohibitedResultParam = Arrays.asList(new String[] { DEFAULT_PARAM, "namespace", "method",
			"encode", "parse", "location", "prependServletContext" });

	@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 (portletMode != null) {
			Map<PortletMode, String> 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);
		}

		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));
				}
			}
		}

		StringBuilder tmpLocation = new StringBuilder(actionMapper.getUriFromActionMapping(new ActionMapping(actionName,
                namespace, method, null)));
		UrlHelper.buildParametersString(requestParameters, tmpLocation, "&");

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

    public void handle(ReflectionException ex) {
        // Only log as debug as they are probably parameters to be appended to the url
        if (LOG.isDebugEnabled()) LOG.debug(ex.getMessage(), ex);
    }
}