alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  
* </tr> * <tr> * <td class="confluenceTd">viewNamespace * </tr> * <tr> * <td class="confluenceTd">editNamespace * </tr> * <tr> * <td class="confluenceTd">helpNamespace * </tr> * <tr> * <td class="confluenceTd">defaultViewAction * </tr> * <tr> * <td class="confluenceTd">defaultEditAction * </tr> * <tr> * <td class="confluenceTd">defaultHelpAction * </tr> * </table> * <!-- END SNIPPET: params --> * <p>Example:

* <pre> * <!-- START SNIPPET: example --> * * <init-param> * <!-- The view mode namespace. Maps to a namespace in the xwork config file --> * <name>viewNamespace</name> * <value>/view</value> * </init-param> * <init-param> * <!-- The default action to invoke in view mode --> * <name>defaultViewAction</name> * <value>index</value> * </init-param> * <init-param> * <!-- The view mode namespace. Maps to a namespace in the xwork config file --> * <name>editNamespace</name> * <value>/edit</value> * </init-param> * <init-param> * <!-- The default action to invoke in view mode --> * <name>defaultEditAction</name> * <value>index</value> * </init-param> * <init-param> * <!-- The view mode namespace. Maps to a namespace in the xwork config file --> * <name>helpNamespace</name> * <value>/help</value> * </init-param> * <init-param> * <!-- The default action to invoke in view mode --> * <name>defaultHelpAction</name> * <value>index</value> * </init-param> * * <!-- END SNIPPET: example --> * </pre> */ public class Jsr168Dispatcher extends GenericPortlet implements StrutsStatics, PortletActionConstants { private static final Logger LOG = LoggerFactory.getLogger(Jsr168Dispatcher.class); private ActionProxyFactory factory = null; private Map<PortletMode,String> modeMap = new HashMap(3); private Map<PortletMode,ActionMapping> actionMap = new HashMap(3); private String portletNamespace = null; private Dispatcher dispatcherUtils; private ActionMapper actionMapper; private Container container; /** * Initialize the portlet with the init parameters from <tt>portlet.xml */ public void init(PortletConfig cfg) throws PortletException { super.init(cfg); if (LOG.isDebugEnabled()) LOG.debug("Initializing portlet " + getPortletName()); Map<String,String> params = new HashMap(); for (Enumeration e = cfg.getInitParameterNames(); e.hasMoreElements(); ) { String name = (String) e.nextElement(); String value = cfg.getInitParameter(name); params.put(name, value); } dispatcherUtils = new Dispatcher(new PortletServletContext(cfg.getPortletContext()), params); dispatcherUtils.init(); // For testability if (factory == null) { factory = dispatcherUtils.getConfigurationManager().getConfiguration().getContainer().getInstance(ActionProxyFactory.class); } portletNamespace = cfg.getInitParameter("portletNamespace"); if (LOG.isDebugEnabled()) LOG.debug("PortletNamespace: " + portletNamespace); parseModeConfig(actionMap, cfg, PortletMode.VIEW, "viewNamespace", "defaultViewAction"); parseModeConfig(actionMap, cfg, PortletMode.EDIT, "editNamespace", "defaultEditAction"); parseModeConfig(actionMap, cfg, PortletMode.HELP, "helpNamespace", "defaultHelpAction"); parseModeConfig(actionMap, cfg, new PortletMode("config"), "configNamespace", "defaultConfigAction"); parseModeConfig(actionMap, cfg, new PortletMode("about"), "aboutNamespace", "defaultAboutAction"); parseModeConfig(actionMap, cfg, new PortletMode("print"), "printNamespace", "defaultPrintAction"); parseModeConfig(actionMap, cfg, new PortletMode("preview"), "previewNamespace", "defaultPreviewAction"); parseModeConfig(actionMap, cfg, new PortletMode("edit_defaults"), "editDefaultsNamespace", "defaultEditDefaultsAction"); if (StringUtils.isEmpty(portletNamespace)) { portletNamespace = ""; } LocalizedTextUtil .addDefaultResourceBundle("org/apache/struts2/struts-messages"); container = dispatcherUtils.getContainer(); //check for configuration reloading if ("true".equalsIgnoreCase(container.getInstance(String.class, StrutsConstants.STRUTS_CONFIGURATION_XML_RELOAD))) { FileManager.setReloadingConfigs(true); } actionMapper = container.getInstance(ActionMapper.class); } /** * Parse the mode to namespace mappings configured in portlet.xml * @param actionMap The map with mode <-> default action mapping. * @param portletConfig The PortletConfig. * @param portletMode The PortletMode. * @param nameSpaceParam Name of the init parameter where the namespace for the mode * is configured. * @param defaultActionParam Name of the init parameter where the default action to * execute for the mode is configured. */ void parseModeConfig(Map<PortletMode, ActionMapping> actionMap, PortletConfig portletConfig, PortletMode portletMode, String nameSpaceParam, String defaultActionParam) { String namespace = portletConfig.getInitParameter(nameSpaceParam); if (StringUtils.isEmpty(namespace)) { namespace = ""; } modeMap.put(portletMode, namespace); String defaultAction = portletConfig .getInitParameter(defaultActionParam); String method = null; if (StringUtils.isEmpty(defaultAction)) { defaultAction = DEFAULT_ACTION_NAME; } if(defaultAction.indexOf('!') >= 0) { method = defaultAction.substring(defaultAction.indexOf('!') + 1); defaultAction = defaultAction.substring(0, defaultAction.indexOf('!')); } StringBuffer fullPath = new StringBuffer(); if (StringUtils.isNotEmpty(portletNamespace)) { fullPath.append(portletNamespace); } if (StringUtils.isNotEmpty(namespace)) { fullPath.append(namespace).append("/"); } else { fullPath.append("/"); } fullPath.append(defaultAction); ActionMapping mapping = new ActionMapping(); mapping.setName(getActionName(fullPath.toString())); mapping.setNamespace(getNamespace(fullPath.toString())); if(method != null) { mapping.setMethod(method); } actionMap.put(portletMode, mapping); } /** * Service an action from the <tt>event phase. * * @see javax.portlet.Portlet#processAction(javax.portlet.ActionRequest, * javax.portlet.ActionResponse) */ public void processAction(ActionRequest request, ActionResponse response) throws PortletException, IOException { if (LOG.isDebugEnabled()) LOG.debug("Entering processAction"); resetActionContext(); try { serviceAction(request, response, getRequestMap(request), getParameterMap(request), getSessionMap(request), getApplicationMap(), portletNamespace, EVENT_PHASE); if (LOG.isDebugEnabled()) LOG.debug("Leaving processAction"); } finally { ActionContext.setContext(null); } } /** * Service an action from the <tt>render phase. * * @see javax.portlet.Portlet#render(javax.portlet.RenderRequest, * javax.portlet.RenderResponse) */ public void render(RenderRequest request, RenderResponse response) throws PortletException, IOException { if (LOG.isDebugEnabled()) LOG.debug("Entering render"); resetActionContext(); response.setTitle(getTitle(request)); if(!request.getWindowState().equals(WindowState.MINIMIZED)) { try { // Check to see if an event set the render to be included directly serviceAction(request, response, getRequestMap(request), getParameterMap(request), getSessionMap(request), getApplicationMap(), portletNamespace, RENDER_PHASE); if (LOG.isDebugEnabled()) LOG.debug("Leaving render"); } finally { resetActionContext(); } } } /** * Reset the action context. */ private void resetActionContext() { ActionContext.setContext(null); } /** * Merges all application and portlet attributes into a single * <tt>HashMap to represent the entire Action context. * * @param requestMap a Map of all request attributes. * @param parameterMap a Map of all request parameters. * @param sessionMap a Map of all session attributes. * @param applicationMap a Map of all servlet context attributes. * @param request the PortletRequest object. * @param response the PortletResponse object. * @param portletConfig the PortletConfig object. * @param phase The portlet phase (render or action, see * {@link PortletActionConstants}) * @return a HashMap representing the <tt>Action context. */ public HashMap<String, Object> createContextMap(Map requestMap, Map parameterMap, Map<String, Object> sessionMap, Map applicationMap, PortletRequest request, PortletResponse response, HttpServletRequest servletRequest, HttpServletResponse servletResponse, ServletContext servletContext, PortletConfig portletConfig, Integer phase) throws IOException { // TODO Must put http request/response objects into map for use with container.inject(servletRequest); // ServletActionContext HashMap<String, Object> extraContext = new HashMap(); // The dummy servlet objects. Eases reuse of existing interceptors that uses the servlet objects. extraContext.put(StrutsStatics.HTTP_REQUEST, servletRequest); extraContext.put(StrutsStatics.HTTP_RESPONSE, servletResponse); extraContext.put(StrutsStatics.SERVLET_CONTEXT, servletContext); // End dummy servlet objects extraContext.put(ActionContext.PARAMETERS, parameterMap); extraContext.put(ActionContext.SESSION, sessionMap); extraContext.put(ActionContext.APPLICATION, applicationMap); String defaultLocale = dispatcherUtils.getContainer().getInstance(String.class, StrutsConstants.STRUTS_LOCALE); Locale locale = null; if (defaultLocale != null) { locale = LocalizedTextUtil.localeFromString(defaultLocale, request.getLocale()); } else { locale = request.getLocale(); } extraContext.put(ActionContext.LOCALE, locale); extraContext.put(StrutsStatics.STRUTS_PORTLET_CONTEXT, getPortletContext()); extraContext.put(REQUEST, request); extraContext.put(RESPONSE, response); extraContext.put(PORTLET_CONFIG, portletConfig); extraContext.put(PORTLET_NAMESPACE, portletNamespace); extraContext.put(DEFAULT_ACTION_FOR_MODE, actionMap.get(request.getPortletMode())); // helpers to get access to request/session/application scope extraContext.put("request", requestMap); extraContext.put("session", sessionMap); extraContext.put("application", applicationMap); extraContext.put("parameters", parameterMap); extraContext.put(MODE_NAMESPACE_MAP, modeMap); extraContext.put(PHASE, phase); AttributeMap attrMap = new AttributeMap(extraContext); extraContext.put("attr", attrMap); return extraContext; } /** * Loads the action and executes it. This method first creates the action * context from the given parameters then loads an <tt>ActionProxy * from the given action name and namespace. After that, the action is * executed and output channels throught the response object. * * @param request the HttpServletRequest object. * @param response the HttpServletResponse object. * @param requestMap a Map of request attributes. * @param parameterMap a Map of request parameters. * @param sessionMap a Map of all session attributes. * @param applicationMap a Map of all application attributes. * @param portletNamespace the namespace or context of the action. * @param phase The portlet phase (render or action, see * {@link PortletActionConstants}) */ public void serviceAction(PortletRequest request, PortletResponse response, Map<String, Object> requestMap, Map parameterMap, Map<String, Object> sessionMap, Map applicationMap, String portletNamespace, Integer phase) throws PortletException { if (LOG.isDebugEnabled()) LOG.debug("serviceAction"); Dispatcher.setInstance(dispatcherUtils); String actionName = null; String namespace = null; try { ServletContext servletContext = new PortletServletContext(getPortletContext()); HttpServletRequest servletRequest = new PortletServletRequest(request, getPortletContext()); HttpServletResponse servletResponse = new PortletServletResponse(response); if(EVENT_PHASE.equals(phase)) { servletRequest = dispatcherUtils.wrapRequest(servletRequest, servletContext); if(servletRequest instanceof MultiPartRequestWrapper) { // Multipart request. Request parameters are encoded in the multipart data, // so we need to manually add them to the parameter map. parameterMap.putAll(servletRequest.getParameterMap()); } } container.inject(servletRequest); ActionMapping mapping = getActionMapping(request, servletRequest); actionName = mapping.getName(); namespace = mapping.getNamespace(); HashMap<String, Object> extraContext = createContextMap(requestMap, parameterMap, sessionMap, applicationMap, request, response, servletRequest, servletResponse, servletContext, getPortletConfig(), phase); extraContext.put(PortletActionConstants.ACTION_MAPPING, mapping); LOG.debug("Creating action proxy for name = " + actionName + ", namespace = " + namespace); ActionProxy proxy = factory.createActionProxy(namespace, actionName, mapping.getMethod(), extraContext); request.setAttribute("struts.valueStack", proxy.getInvocation() .getStack()); proxy.execute(); } catch (ConfigurationException e) { LOG.error("Could not find action", e); throw new PortletException("Could not find action " + actionName, e); } catch (Exception e) { LOG.error("Could not execute action", e); throw new PortletException("Error executing action " + actionName, e); } finally { Dispatcher.setInstance(null); } } /** * Returns a Map of all application attributes. Copies all attributes from * the {@link PortletActionContext}into an {@link ApplicationMap}. * * @return a Map of all application attributes. */ protected Map getApplicationMap() { return new PortletApplicationMap(getPortletContext()); } /** * Gets the namespace of the action from the request. The namespace is the * same as the portlet mode. E.g, view mode is mapped to namespace * <code>view, and edit mode is mapped to the namespace * <code>edit * * @param request the PortletRequest object. * @return the namespace of the action. */ protected ActionMapping getActionMapping(final PortletRequest portletRequest, final HttpServletRequest servletRequest) { ActionMapping mapping = null; String actionPath = null; if (resetAction(portletRequest)) { mapping = (ActionMapping) actionMap.get(portletRequest.getPortletMode()); } else { actionPath = servletRequest.getParameter(ACTION_PARAM); if (StringUtils.isEmpty(actionPath)) { mapping = (ActionMapping) actionMap.get(portletRequest .getPortletMode()); } else { // Use the usual action mapper, but it is expecting an action extension // on the uri, so we add the default one, which should be ok as the // portlet is a portlet first, a servlet second mapping = actionMapper.getMapping(servletRequest, dispatcherUtils.getConfigurationManager()); } } if (mapping == null) { throw new StrutsException("Unable to locate action mapping for request, probably due to " + "an invalid action path: "+actionPath); } return mapping; } /** * Get the namespace part of the action path. * @param actionPath Full path to action * @return The namespace part. */ String getNamespace(String actionPath) { int idx = actionPath.lastIndexOf('/'); String namespace = ""; if (idx >= 0) { namespace = actionPath.substring(0, idx); } return namespace; } /** * Get the action name part of the action path. * @param actionPath Full path to action * @return The action name. */ String getActionName(String actionPath) { int idx = actionPath.lastIndexOf('/'); String action = actionPath; if (idx >= 0) { action = actionPath.substring(idx + 1); } return action; } /** * Returns a Map of all request parameters. This implementation just calls * {@link PortletRequest#getParameterMap()}. * * @param request the PortletRequest object. * @return a Map of all request parameters. * @throws IOException if an exception occurs while retrieving the parameter * map. */ protected Map<String, String[]> getParameterMap(PortletRequest request) throws IOException { return new HashMap<String, String[]>(request.getParameterMap()); } /** * Returns a Map of all request attributes. The default implementation is to * wrap the request in a {@link RequestMap}. Override this method to * customize how request attributes are mapped. * * @param request the PortletRequest object. * @return a Map of all request attributes. */ protected Map getRequestMap(PortletRequest request) { return new PortletRequestMap(request); } /** * Returns a Map of all session attributes. The default implementation is to * wrap the reqeust in a {@link SessionMap}. Override this method to * customize how session attributes are mapped. * * @param request the PortletRequest object. * @return a Map of all session attributes. */ protected Map getSessionMap(PortletRequest request) { return new PortletSessionMap(request); } /** * Convenience method to ease testing. * @param factory */ protected void setActionProxyFactory(ActionProxyFactory factory) { this.factory = factory; } /** * Check to see if the action parameter is valid for the current portlet mode. If the portlet * mode has been changed with the portal widgets, the action name is invalid, since the * action name belongs to the previous executing portlet mode. If this method evaluates to * <code>true the default<Mode>Action is used instead. * @param request The portlet request. * @return <code>true if the action should be reset. */ private boolean resetAction(PortletRequest request) { boolean reset = false; Map paramMap = request.getParameterMap(); String[] modeParam = (String[]) paramMap.get(MODE_PARAM); if (modeParam != null && modeParam.length == 1) { String originatingMode = modeParam[0]; String currentMode = request.getPortletMode().toString(); if (!currentMode.equals(originatingMode)) { reset = true; } } if(reset) { request.setAttribute(ACTION_RESET, Boolean.TRUE); } else { request.setAttribute(ACTION_RESET, Boolean.FALSE); } return reset; } public void destroy() { if (dispatcherUtils == null) { LOG.warn("something is seriously wrong, DispatcherUtil is not initialized (null) "); } else { dispatcherUtils.cleanup(); } } /** * @param actionMapper the actionMapper to set */ public void setActionMapper(ActionMapper actionMapper) { this.actionMapper = actionMapper; } }

Other Struts examples (source code examples)

Here is a short list of links related to this Struts Jsr168Dispatcher.java source code file:

Struts example source code file (Jsr168Dispatcher.java)

This example Struts source code file (Jsr168Dispatcher.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

actionmapping, actionmapping, could, hashmap, http, httpservletrequest, io, ioexception, map, map, object, object, portletexception, portletmode, request, response, servlet, string, string, util

The Struts Jsr168Dispatcher.java source code

/*
 * $Id: Jsr168Dispatcher.java 1076544 2011-03-03 07:19:37Z lukaszlenart $
 *
 * 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.dispatcher;

import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.GenericPortlet;
import javax.portlet.PortletConfig;
import javax.portlet.PortletException;
import javax.portlet.PortletMode;
import javax.portlet.PortletRequest;
import javax.portlet.PortletResponse;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.WindowState;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts2.StrutsConstants;
import org.apache.struts2.StrutsException;
import org.apache.struts2.StrutsStatics;
import org.apache.struts2.dispatcher.ApplicationMap;
import org.apache.struts2.dispatcher.Dispatcher;
import org.apache.struts2.dispatcher.RequestMap;
import org.apache.struts2.dispatcher.SessionMap;
import org.apache.struts2.dispatcher.mapper.ActionMapper;
import org.apache.struts2.dispatcher.mapper.ActionMapping;
import org.apache.struts2.dispatcher.multipart.MultiPartRequestWrapper;
import org.apache.struts2.portlet.PortletActionConstants;
import org.apache.struts2.portlet.PortletApplicationMap;
import org.apache.struts2.portlet.PortletRequestMap;
import org.apache.struts2.portlet.PortletSessionMap;
import org.apache.struts2.portlet.context.PortletActionContext;
import org.apache.struts2.portlet.servlet.PortletServletContext;
import org.apache.struts2.portlet.servlet.PortletServletRequest;
import org.apache.struts2.portlet.servlet.PortletServletResponse;
import org.apache.struts2.util.AttributeMap;
import org.apache.commons.lang.StringUtils;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionProxy;
import com.opensymphony.xwork2.ActionProxyFactory;
import com.opensymphony.xwork2.config.ConfigurationException;
import com.opensymphony.xwork2.inject.Container;
import com.opensymphony.xwork2.util.FileManager;
import com.opensymphony.xwork2.util.LocalizedTextUtil;
import com.opensymphony.xwork2.util.logging.Logger;
import com.opensymphony.xwork2.util.logging.LoggerFactory;

/**
 * <!-- START SNIPPET: javadoc -->
 * <p>
 * Struts JSR-168 portlet dispatcher. Similar to the WW2 Servlet dispatcher,
 * but adjusted to a portal environment. The portlet is configured through the <tt>portlet.xml
 * descriptor. Examples and descriptions follow below:
 * </p>
 * <!-- END SNIPPET: javadoc -->
 *
 * @author Nils-Helge Garli
 * @author Rainer Hermanns
 *
 * <p>Init parameters

 * <!-- START SNIPPET: params -->
 * <table class="confluenceTable">
 * <tr>
 *  <th class="confluenceTh">Name
 * <th class="confluenceTh">Description
 * <th class="confluenceTh">Default value
 * </tr>
 * <tr>
 *  <td class="confluenceTd">portletNamespace
The namespace for the portlet in the xwork configuration. This * namespace is prepended to all action lookups, and makes it possible to host multiple * portlets in the same portlet application. If this parameter is set, the complete namespace * will be <tt>/portletNamespace/modeNamespace/actionNameThe default namespaceBase namespace in the xwork configuration for the view portlet * mode</td>The default namespaceBase namespace in the xwork configuration for the edit portlet * mode</td>The default namespaceBase namespace in the xwork configuration for the help portlet * mode</td>The default namespaceDefault action to invoke in the view portlet mode if no action is * specified</td>defaultDefault action to invoke in the edit portlet mode if no action is * specified</td>defaultDefault action to invoke in the help portlet mode if no action is * specified</td>default
... this post is sponsored by my books ...

#1 New Release!
FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.