Coverage Report

Coverage Report - org.seasar.teeda.core.portlet.FacesPortlet

Classes in this File

Line Coverage

Branch Coverage

Complexity

FacesPortlet

0/263

0/104

3.154

 /*
  * Copyright 2004-2011 the Seasar Foundation and the Others.
  *
  * Licensed 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.seasar.teeda.core.portlet;
 
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
 import javax.faces.FactoryFinder;
 import javax.faces.application.FacesMessage;
 import javax.faces.application.StateManager;
 import javax.faces.context.ExternalContext;
 import javax.faces.context.FacesContext;
 import javax.faces.context.FacesContextFactory;
 import javax.faces.internal.WebAppUtil;
 import javax.faces.internal.WindowIdUtil;
 import javax.faces.internal.scope.PageScope;
 import javax.faces.internal.scope.RedirectScope;
 import javax.faces.lifecycle.Lifecycle;
 import javax.faces.lifecycle.LifecycleFactory;
 import javax.faces.webapp.FacesServlet;
 import javax.portlet.ActionRequest;
 import javax.portlet.ActionResponse;
 import javax.portlet.GenericPortlet;
 import javax.portlet.PortletContext;
 import javax.portlet.PortletException;
 import javax.portlet.PortletRequest;
 import javax.portlet.PortletSession;
 import javax.portlet.RenderRequest;
 import javax.portlet.RenderResponse;
 import javax.servlet.ServletException;
 
 import org.seasar.framework.log.Logger;
 import org.seasar.teeda.core.JsfConstants;
 import org.seasar.teeda.core.util.DIContainerUtil;
 import org.seasar.teeda.core.util.ErrorPageManager;
 import org.seasar.teeda.core.util.NullErrorPageManagerImpl;
 import org.seasar.teeda.core.util.PortletUtil;
 
 /**
  * @author shinsuke
  *
  */
 public class FacesPortlet extends GenericPortlet {
     /**
      * Logger for this class
      */
     private static final Logger logger = Logger.getLogger(FacesPortlet.class);
 
     public static final String PORTLET_CONFIG = "javax.portlet.PortletConfig";
 
     public static final String VIEW_ID = FacesPortlet.class.getName() +
             ".VIEW_ID";
 
     public static final String DEFAULT_PAGE = FacesPortlet.class.getName() +
             ".DEFAULT_PAGE";
 
     public static final String DEFAULT_VIEW_PAGE = "view-page";
 
     public static final String DEFAULT_EDIT_PAGE = "edit-page";
 
     public static final String DEFAULT_HELP_PAGE = "help-page";
 
     public static final String FACES_PORTLET_STATE_PREFIX = FacesPortlet.class
             .getName() +
             ".FACES_PORTLET_STATE" + "-";
 
     public static final String PREVIOUS_PORTLET_MODE = FacesPortlet.class
             .getName() +
             ".PREVIOUS_PORTLET_MODE";
 
     public static final String CURRENT_PORTLET_MODE = FacesPortlet.class
             .getName() +
             ".CURRENT_PORTLET_MODE";
 
     public static final String EXCLUDED_ATTRIBUTE_LIST = FacesPortlet.class
             .getName() +
             ".EXCLUDED_ATTRIBUTE_LIST";
 
     public static final String REDEPLOYED_PORTLET = FacesPortlet.class
             .getName() +
             ".REDEPLOYED_PORTLET";
 
     public static final String RENDER_PARAMETER = FacesPortlet.class.getName() +
             ".RENDER_PARAMETER";
 
     protected FacesContextFactory facesContextFactory;
 
     protected Lifecycle lifecycle;
 
     private String defaultViewPage = null;
 
     private String defaultEditPage = null;
 
     private String defaultHelpPage = null;
 
     public void init() throws PortletException {
         super.init();
 
         // Load default pages
         defaultViewPage = getPortletConfig()
                 .getInitParameter(DEFAULT_VIEW_PAGE);
         defaultEditPage = getPortletConfig()
                 .getInitParameter(DEFAULT_EDIT_PAGE);
         defaultHelpPage = getPortletConfig()
                 .getInitParameter(DEFAULT_HELP_PAGE);
         if (null == defaultViewPage) {
             // A Faces Portlet is required to have at least the default page
             throw new PortletException("Portlet " +
                     getPortletConfig().getPortletName() +
                     " is incorrectly configured. No default View page is defined.");
         }
         if (null == defaultEditPage) {
             defaultEditPage = defaultViewPage;
         }
         if (null == defaultHelpPage) {
             defaultHelpPage = defaultViewPage;
         }
 
         // Intialize Faces(from FacesServlet)
         LifecycleFactory lifecycleFactory;
         try {
             facesContextFactory = (FacesContextFactory) WebAppUtil
                     .getFactory(FactoryFinder.FACES_CONTEXT_FACTORY);
             lifecycleFactory = (LifecycleFactory) WebAppUtil
                     .getFactory(FactoryFinder.LIFECYCLE_FACTORY);
             String lifecycleId = getLifecycleId(getPortletContext());
             lifecycle = lifecycleFactory.getLifecycle(lifecycleId);
         } catch (ServletException e) {
             throw new PortletException(e);
         }
     }
 
     protected String getLifecycleId(PortletContext portletContext) {
         String lifecycleId = portletContext
                 .getInitParameter(FacesServlet.LIFECYCLE_ID_ATTR);
         if (lifecycleId == null) {
             lifecycleId = LifecycleFactory.DEFAULT_LIFECYCLE;
         }
         return lifecycleId;
     }
 
     public void destroy() {
         super.destroy();
         FactoryFinder.releaseFactories();
         facesContextFactory = null;
         lifecycle = null;
         defaultViewPage = null;
         defaultEditPage = null;
         defaultHelpPage = null;
     }
 
     //
     // Render Methods
     //
 
     protected void doEdit(RenderRequest request, RenderResponse response)
             throws PortletException, IOException {
         setContentType(request, response);
         setDefaultPage(request, defaultEditPage);
         renderFaces(request, response);
     }
 
     protected void doHelp(RenderRequest request, RenderResponse response)
             throws PortletException, IOException {
         setContentType(request, response);
         setDefaultPage(request, defaultHelpPage);
         renderFaces(request, response);
     }
 
     protected void doView(RenderRequest request, RenderResponse response)
             throws PortletException, IOException {
         setContentType(request, response);
         setDefaultPage(request, defaultViewPage);
         renderFaces(request, response);
     }
 
     protected void setContentType(RenderRequest request, RenderResponse response) {
 
         if (response.getContentType() == null) {
             String portalPreferredContentType = request
                     .getResponseContentType();
             if (portalPreferredContentType != null) {
                 response.setContentType(portalPreferredContentType);
             } else {
                 response.setContentType("text/html");
             }
         }
     }
 
     protected void setDefaultPage(PortletRequest request, String page) {
         if (request.getAttribute(DEFAULT_PAGE) == null) {
             request.setAttribute(DEFAULT_PAGE, page);
         }
     }
 
     private void storePortletConfig(PortletRequest request) {
         request.setAttribute(PORTLET_CONFIG, getPortletConfig());
     }
 
     private void setCurrentPortletMode(PortletRequest request) {
         request.setAttribute(CURRENT_PORTLET_MODE, request.getPortletMode()
                 .toString());
     }
 
     protected void renderFaces(RenderRequest request, RenderResponse response)
             throws PortletException, java.io.IOException {
         if (logger.isDebugEnabled()) {
             logger.debug("called renderFaces..");
         }
 
         // create excluded list
         createExcludedAttributeList(request);
 
         // restore error info
         restoreErrorInfo(request);
 
         storePortletConfig(request);
         setCurrentPortletMode(request);
 
         FacesContext facesContext = facesContextFactory.getFacesContext(
                 getPortletContext(), request, response, lifecycle);
         request.setAttribute(JsfConstants.FACES_CONTEXT, facesContext);
 
         String redirectPath = null;
         try {
             WindowIdUtil.setupWindowId(facesContext.getExternalContext());
             final Map pageScope = PageScope.getOrCreateContext(facesContext);
             synchronized (pageScope) {
                 restoreFacesState(facesContext);
                 lifecycle.render(facesContext);
             }
             saveFacesState(facesContext);
         } catch (Throwable e) {
             handleException(facesContext, e);
         } finally {
             redirectPath = RedirectScope.getRedirectingPath(facesContext);
             if (redirectPath != null) {
                 //remove redirect scope
                 RedirectScope.removeContext(facesContext);
             }
             facesContext.release();
             request.getPortletSession().setAttribute(PREVIOUS_PORTLET_MODE,
                     request.getPortletMode().toString());
             request.getPortletSession().setAttribute(REDEPLOYED_PORTLET,
                     Boolean.FALSE);
         }
 
         // redirect
         if (redirectPath != null) {
             redirectRenderFaces(request, response, redirectPath);
         }
 
         // clear error info
         clearErrorInfo(request);
     }
 
     protected void redirectRenderFaces(RenderRequest request,
             RenderResponse response, String viewId) throws PortletException,
             java.io.IOException {
         if (logger.isDebugEnabled()) {
             logger.debug("called redirectRenderFaces.. viewId is " + viewId);
         }
 
         List excludedNameList = (List) request
                 .getAttribute(EXCLUDED_ATTRIBUTE_LIST);
         // clear attribute
         for (Enumeration e = request.getAttributeNames(); e.hasMoreElements();) {
             String key = (String) e.nextElement();
             if (!excludedNameList.contains(key)) {
                 request.removeAttribute(key);
             }
         }
         // call renderFaces again
         request.getPortletSession().removeAttribute(
                 FacesPortlet.PREVIOUS_PORTLET_MODE);
         request.setAttribute(FacesPortlet.DEFAULT_PAGE, viewId);
         renderFaces(request, response);
 
     }
 
     protected void restoreFacesState(FacesContext facesContext) {
 
         Map sessionMap = facesContext.getExternalContext().getSessionMap();
         Map requestMap = facesContext.getExternalContext().getRequestMap();
 
         String currentPortletMode = (String) requestMap
                 .get(CURRENT_PORTLET_MODE);
         String previousPortletMode = (String) sessionMap
                 .get(PREVIOUS_PORTLET_MODE);
 
         FacesPortletState state = null;
         if (previousPortletMode != null &&
                 previousPortletMode.equals(currentPortletMode)) {
             state = (FacesPortletState) sessionMap
                     .get(FACES_PORTLET_STATE_PREFIX + currentPortletMode);
             if (state == null) {
                 // from request parameter
                 Map requestParameterMap = facesContext.getExternalContext()
                         .getRequestParameterMap();
                 String viewId = (String) requestParameterMap.get(VIEW_ID);
                 if (viewId != null && !checkSessionState(facesContext)) {
                     requestMap.put(VIEW_ID, viewId);
                 }
 
                 restoreView(facesContext);
                 return;
             } else {
                 // get viewId
                 String viewId = state.getViewId();
                 requestMap.put(VIEW_ID, viewId);
 
                 // restore view
                 restoreView(facesContext);
 
                 // restore message information
                 Iterator clientIds = state.getClientIds();
                 while (clientIds.hasNext()) {
                     String clientId = (String) clientIds.next();
                     Iterator msgs = state.getMessages(clientId);
                     while (msgs.hasNext()) {
                         facesContext.addMessage(clientId, (FacesMessage) msgs
                                 .next());
                     }
                 }
 
                 // restore request attributes
                 copyMap(state.getRequestMap(), facesContext
                         .getExternalContext().getRequestMap(), new ArrayList());
 
                 // restore state to UIViewRoot
                 Object s = state.getState();
                 if (s != null) {
                     facesContext.getViewRoot().processRestoreState(
                             facesContext, s);
                 }
 
             }
         } else {
             // display new page
             restoreDefaultFacesState(facesContext);
         }
 
     }
 
     protected void restoreDefaultFacesState(FacesContext facesContext) {
         ExternalContext externalContext = facesContext.getExternalContext();
         Map requestMap = externalContext.getRequestMap();
         // get default page
         String viewId = (String) externalContext.getRequestMap().get(
                 DEFAULT_PAGE);
         requestMap.put(VIEW_ID, viewId);
 
         // remove all states in session
         for (Iterator i = externalContext.getSessionMap().entrySet().iterator(); i
                 .hasNext();) {
             Map.Entry e = (Map.Entry) i.next();
             if (e.getKey() instanceof String) {
                 String key = (String) e.getKey();
                 if (key.startsWith(FACES_PORTLET_STATE_PREFIX)) {
                     externalContext.getSessionMap().remove(key);
                 }
             }
         }
 
         // remove redirect scope
         if (RedirectScope.isRedirecting(facesContext)) {
             RedirectScope.removeContext(facesContext);
         }
 
         restoreView(facesContext);
     }
 
     private void restoreView(FacesContext facesContext) {
         facesContext.renderResponse();
         // call restore phase only
         lifecycle.execute(facesContext);
     }
 
     //
     // Action Methods
     //
 
     public void processAction(ActionRequest request, ActionResponse response)
             throws PortletException, IOException {
         if (logger.isDebugEnabled()) {
             logger.debug("called processAction..");
         }
 
         // check session timeout
         if (checkSessionState(request)) {
             return;
         }
 
         String viewId = request.getParameter(VIEW_ID);
         if (viewId != null) {
             request.setAttribute(VIEW_ID, viewId);
             executeFaces(request, response);
         } else {
             if (logger.isDebugEnabled()) {
                 logger.debug("skip processAction because viewId is null.");
             }
         }
     }
 
     protected void executeFaces(ActionRequest request, ActionResponse response)
             throws PortletException, IOException {
 
         storePortletConfig(request);
         setCurrentPortletMode(request);
 
         // create excluded list
         createExcludedAttributeList(request);
 
         FacesContext facesContext = facesContextFactory.getFacesContext(
                 getPortletContext(), request, response, lifecycle);
 
         try {
             WindowIdUtil.setupWindowId(facesContext.getExternalContext());
             final Map pageScope = PageScope.getOrCreateContext(facesContext);
             synchronized (pageScope) {
                 lifecycle.execute(facesContext);
             }
         } catch (Throwable e) {
             handleException(facesContext, e);
         } finally {
             if (!facesContext.getResponseComplete()) {
                 request.setAttribute(VIEW_ID, facesContext.getViewRoot()
                         .getViewId());
                 saveFacesState(facesContext);
                 if (request.getParameter(RENDER_PARAMETER) != null) {
                     setRenderParameters(request, response);
                 }
             } else if (RedirectScope.isRedirecting(facesContext)) {
                 saveFacesState(facesContext);
             }
             // release the FacesContext instance for this request
             facesContext.release();
         }
     }
 
     protected void saveFacesState(FacesContext facesContext) {
         Map sessionMap = facesContext.getExternalContext().getSessionMap();
         Map requestMap = facesContext.getExternalContext().getRequestMap();
 
         // save portlet mode
         String currentPortletMode = (String) requestMap
                 .get(CURRENT_PORTLET_MODE);
         sessionMap.put(PREVIOUS_PORTLET_MODE, currentPortletMode);
 
         FacesPortletState state = new FacesPortletState();
 
         if (!PortletUtil.isRender(facesContext)) {
             // save message information from this FacesContext
             Iterator clientIds = facesContext.getClientIdsWithMessages();
             while (clientIds.hasNext()) {
                 String clientId = (String) clientIds.next();
                 Iterator msgs = facesContext.getMessages(clientId);
                 while (msgs.hasNext()) {
                     state.addMessage(clientId, (FacesMessage) msgs.next());
                 }
             }
         }
 
         String redirectPath = RedirectScope.getRedirectingPath(facesContext);
         if (redirectPath == null) {
             state.setViewId(facesContext.getViewRoot().getViewId());
 
             List excludedNameList = (List) requestMap
                     .get(EXCLUDED_ATTRIBUTE_LIST);
             // save request attributes
             Map map = new HashMap();
             copyMap(requestMap, map, excludedNameList);
             state.setRequestMap(map);
 
             // save state
             StateManager stateManager = facesContext.getApplication()
                     .getStateManager();
             stateManager.saveSerializedView(facesContext);
 
             // store state to FacesPortletState
             state.setState(facesContext.getViewRoot().processSaveState(
                     facesContext));
         } else {
             // replace viewId
             state.setViewId(redirectPath);
 
             // save request attributes
             Map map = new HashMap();
             state.setRequestMap(map);
 
             // set state to null
             state.setState(null);
         }
 
         // store state to session
         sessionMap.put(FACES_PORTLET_STATE_PREFIX + currentPortletMode, state);
 
     }
 
     //
     // Others
     //
 
     protected void handleException(FacesContext context, Throwable e)
             throws PortletException, IOException {
         ErrorPageManager errorPageManager = null;
         try {
             errorPageManager = (ErrorPageManager) DIContainerUtil
                     .getComponent(ErrorPageManager.class);
         } catch (Exception e1) {
         }
         if (errorPageManager == null) {
             errorPageManager = new NullErrorPageManagerImpl();
         }
 
         ExternalContext extContext = context.getExternalContext();
         if (errorPageManager.handleException(e, context, extContext)) {
             context.responseComplete();
         } else {
             if (e instanceof IOException) {
                 throw (IOException) e;
             } else if (e instanceof PortletException) {
                 throw (PortletException) e;
             } else if (e.getMessage() != null) {
                 throw new PortletException(e.getMessage(), e);
             }
             throw new PortletException(e);
         }
     }
 
     protected boolean checkSessionState(PortletRequest request) {
         return request.getPortletSession(false) == null ||
                 (request.getPortletSession().getAttribute(REDEPLOYED_PORTLET) == null);
     }
 
     protected boolean checkSessionState(FacesContext context) {
         return context.getExternalContext().getSession(false) == null ||
                 (context.getExternalContext().getSessionMap().get(
                         REDEPLOYED_PORTLET) == null);
     }
 
     protected void createExcludedAttributeList(PortletRequest request) {
         // create excluded list
         ArrayList excludedNameList = new ArrayList();
         Enumeration enu = request.getAttributeNames();
         while (enu.hasMoreElements()) {
             excludedNameList.add(enu.nextElement());
         }
         // reserved names
         excludedNameList.add(EXCLUDED_ATTRIBUTE_LIST);
         excludedNameList.add(JsfConstants.FACES_CONTEXT);
         request.setAttribute(EXCLUDED_ATTRIBUTE_LIST, excludedNameList);
     }
 
     private void copyMap(Map fromMap, Map toMap, List excludedNameList) {
         for (Iterator i = fromMap.entrySet().iterator(); i.hasNext();) {
             Map.Entry e = (Map.Entry) i.next();
             if (!toMap.containsKey((String) e.getKey()) &&
                     !excludedNameList.contains((String) e.getKey())) {
                 toMap.put(e.getKey(), e.getValue());
             }
         }
     }
 
     protected void setRenderParameters(ActionRequest request,
             ActionResponse response) {
         Enumeration enu = request.getParameterNames();
         while (enu.hasMoreElements()) {
             String key = (String) enu.nextElement();
             response.setRenderParameter(key, request.getParameter(key));
         }
     }
 
     protected void restoreErrorInfo(PortletRequest request) {
         PortletSession portletSession = request.getPortletSession();
         Throwable exception = (Throwable) portletSession
                 .getAttribute(JsfConstants.ERROR_EXCEPTION);
         if (exception != null) {
             request.setAttribute(JsfConstants.ERROR_EXCEPTION, exception);
             request.setAttribute(JsfConstants.ERROR_EXCEPTION_TYPE, exception
                     .getClass());
             request.setAttribute(JsfConstants.ERROR_MESSAGE, exception
                     .getMessage());
         }
     }
 
     protected void clearErrorInfo(PortletRequest request) {
         request.getPortletSession().removeAttribute(
                 JsfConstants.ERROR_EXCEPTION);
     }
 }

1		/*
2		* Copyright 2004-2011 the Seasar Foundation and the Others.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13		* either express or implied. See the License for the specific language
14		* governing permissions and limitations under the License.
15		*/
16		package org.seasar.teeda.core.portlet;
17
18		import java.io.IOException;
19		import java.util.ArrayList;
20		import java.util.Enumeration;
21		import java.util.HashMap;
22		import java.util.Iterator;
23		import java.util.List;
24		import java.util.Map;
25
26		import javax.faces.FactoryFinder;
27		import javax.faces.application.FacesMessage;
28		import javax.faces.application.StateManager;
29		import javax.faces.context.ExternalContext;
30		import javax.faces.context.FacesContext;
31		import javax.faces.context.FacesContextFactory;
32		import javax.faces.internal.WebAppUtil;
33		import javax.faces.internal.WindowIdUtil;
34		import javax.faces.internal.scope.PageScope;
35		import javax.faces.internal.scope.RedirectScope;
36		import javax.faces.lifecycle.Lifecycle;
37		import javax.faces.lifecycle.LifecycleFactory;
38		import javax.faces.webapp.FacesServlet;
39		import javax.portlet.ActionRequest;
40		import javax.portlet.ActionResponse;
41		import javax.portlet.GenericPortlet;
42		import javax.portlet.PortletContext;
43		import javax.portlet.PortletException;
44		import javax.portlet.PortletRequest;
45		import javax.portlet.PortletSession;
46		import javax.portlet.RenderRequest;
47		import javax.portlet.RenderResponse;
48		import javax.servlet.ServletException;
49
50		import org.seasar.framework.log.Logger;
51		import org.seasar.teeda.core.JsfConstants;
52		import org.seasar.teeda.core.util.DIContainerUtil;
53		import org.seasar.teeda.core.util.ErrorPageManager;
54		import org.seasar.teeda.core.util.NullErrorPageManagerImpl;
55		import org.seasar.teeda.core.util.PortletUtil;
56
57		/**
58		* @author shinsuke
59		*
60		*/
61	0	public class FacesPortlet extends GenericPortlet {
62		/**
63		* Logger for this class
64		*/
65	0	private static final Logger logger = Logger.getLogger(FacesPortlet.class);
66
67		public static final String PORTLET_CONFIG = "javax.portlet.PortletConfig";
68
69	0	public static final String VIEW_ID = FacesPortlet.class.getName() +
70		".VIEW_ID";
71
72	0	public static final String DEFAULT_PAGE = FacesPortlet.class.getName() +
73		".DEFAULT_PAGE";
74
75		public static final String DEFAULT_VIEW_PAGE = "view-page";
76
77		public static final String DEFAULT_EDIT_PAGE = "edit-page";
78
79		public static final String DEFAULT_HELP_PAGE = "help-page";
80
81	0	public static final String FACES_PORTLET_STATE_PREFIX = FacesPortlet.class
82		.getName() +
83		".FACES_PORTLET_STATE" + "-";
84
85	0	public static final String PREVIOUS_PORTLET_MODE = FacesPortlet.class
86		.getName() +
87		".PREVIOUS_PORTLET_MODE";
88
89	0	public static final String CURRENT_PORTLET_MODE = FacesPortlet.class
90		.getName() +
91		".CURRENT_PORTLET_MODE";
92
93	0	public static final String EXCLUDED_ATTRIBUTE_LIST = FacesPortlet.class
94		.getName() +
95		".EXCLUDED_ATTRIBUTE_LIST";
96
97	0	public static final String REDEPLOYED_PORTLET = FacesPortlet.class
98		.getName() +
99		".REDEPLOYED_PORTLET";
100
101	0	public static final String RENDER_PARAMETER = FacesPortlet.class.getName() +
102		".RENDER_PARAMETER";
103
104		protected FacesContextFactory facesContextFactory;
105
106		protected Lifecycle lifecycle;
107
108	0	private String defaultViewPage = null;
109
110	0	private String defaultEditPage = null;
111
112	0	private String defaultHelpPage = null;
113
114		public void init() throws PortletException {
115	0	super.init();
116
117		// Load default pages
118	0	defaultViewPage = getPortletConfig()
119		.getInitParameter(DEFAULT_VIEW_PAGE);
120	0	defaultEditPage = getPortletConfig()
121		.getInitParameter(DEFAULT_EDIT_PAGE);
122	0	defaultHelpPage = getPortletConfig()
123		.getInitParameter(DEFAULT_HELP_PAGE);
124	0	if (null == defaultViewPage) {
125		// A Faces Portlet is required to have at least the default page
126	0	throw new PortletException("Portlet " +
127		getPortletConfig().getPortletName() +
128		" is incorrectly configured. No default View page is defined.");
129		}
130	0	if (null == defaultEditPage) {
131	0	defaultEditPage = defaultViewPage;
132		}
133	0	if (null == defaultHelpPage) {
134	0	defaultHelpPage = defaultViewPage;
135		}
136
137		// Intialize Faces(from FacesServlet)
138		LifecycleFactory lifecycleFactory;
139		try {
140	0	facesContextFactory = (FacesContextFactory) WebAppUtil
141		.getFactory(FactoryFinder.FACES_CONTEXT_FACTORY);
142	0	lifecycleFactory = (LifecycleFactory) WebAppUtil
143		.getFactory(FactoryFinder.LIFECYCLE_FACTORY);
144	0	String lifecycleId = getLifecycleId(getPortletContext());
145	0	lifecycle = lifecycleFactory.getLifecycle(lifecycleId);
146	0	} catch (ServletException e) {
147	0	throw new PortletException(e);
148	0	}
149	0	}
150
151		protected String getLifecycleId(PortletContext portletContext) {
152	0	String lifecycleId = portletContext
153		.getInitParameter(FacesServlet.LIFECYCLE_ID_ATTR);
154	0	if (lifecycleId == null) {
155	0	lifecycleId = LifecycleFactory.DEFAULT_LIFECYCLE;
156		}
157	0	return lifecycleId;
158		}
159
160		public void destroy() {
161	0	super.destroy();
162	0	FactoryFinder.releaseFactories();
163	0	facesContextFactory = null;
164	0	lifecycle = null;
165	0	defaultViewPage = null;
166	0	defaultEditPage = null;
167	0	defaultHelpPage = null;
168	0	}
169
170		//
171		// Render Methods
172		//
173
174		protected void doEdit(RenderRequest request, RenderResponse response)
175		throws PortletException, IOException {
176	0	setContentType(request, response);
177	0	setDefaultPage(request, defaultEditPage);
178	0	renderFaces(request, response);
179	0	}
180
181		protected void doHelp(RenderRequest request, RenderResponse response)
182		throws PortletException, IOException {
183	0	setContentType(request, response);
184	0	setDefaultPage(request, defaultHelpPage);
185	0	renderFaces(request, response);
186	0	}
187
188		protected void doView(RenderRequest request, RenderResponse response)
189		throws PortletException, IOException {
190	0	setContentType(request, response);
191	0	setDefaultPage(request, defaultViewPage);
192	0	renderFaces(request, response);
193	0	}
194
195		protected void setContentType(RenderRequest request, RenderResponse response) {
196
197	0	if (response.getContentType() == null) {
198	0	String portalPreferredContentType = request
199		.getResponseContentType();
200	0	if (portalPreferredContentType != null) {
201	0	response.setContentType(portalPreferredContentType);
202		} else {
203	0	response.setContentType("text/html");
204		}
205		}
206	0	}
207
208		protected void setDefaultPage(PortletRequest request, String page) {
209	0	if (request.getAttribute(DEFAULT_PAGE) == null) {
210	0	request.setAttribute(DEFAULT_PAGE, page);
211		}
212	0	}
213
214		private void storePortletConfig(PortletRequest request) {
215	0	request.setAttribute(PORTLET_CONFIG, getPortletConfig());
216	0	}
217
218		private void setCurrentPortletMode(PortletRequest request) {
219	0	request.setAttribute(CURRENT_PORTLET_MODE, request.getPortletMode()
220		.toString());
221	0	}
222
223		protected void renderFaces(RenderRequest request, RenderResponse response)
224		throws PortletException, java.io.IOException {
225	0	if (logger.isDebugEnabled()) {
226	0	logger.debug("called renderFaces..");
227		}
228
229		// create excluded list
230	0	createExcludedAttributeList(request);
231
232		// restore error info
233	0	restoreErrorInfo(request);
234
235	0	storePortletConfig(request);
236	0	setCurrentPortletMode(request);
237
238	0	FacesContext facesContext = facesContextFactory.getFacesContext(
239		getPortletContext(), request, response, lifecycle);
240	0	request.setAttribute(JsfConstants.FACES_CONTEXT, facesContext);
241
242	0	String redirectPath = null;
243		try {
244	0	WindowIdUtil.setupWindowId(facesContext.getExternalContext());
245	0	final Map pageScope = PageScope.getOrCreateContext(facesContext);
246	0	synchronized (pageScope) {
247	0	restoreFacesState(facesContext);
248	0	lifecycle.render(facesContext);
249	0	}
250	0	saveFacesState(facesContext);
251	0	} catch (Throwable e) {
252	0	handleException(facesContext, e);
253	0	} finally {
254	0	redirectPath = RedirectScope.getRedirectingPath(facesContext);
255	0	if (redirectPath != null) {
256		//remove redirect scope
257	0	RedirectScope.removeContext(facesContext);
258		}
259	0	facesContext.release();
260	0	request.getPortletSession().setAttribute(PREVIOUS_PORTLET_MODE,
261		request.getPortletMode().toString());
262	0	request.getPortletSession().setAttribute(REDEPLOYED_PORTLET,
263		Boolean.FALSE);
264	0	}
265
266		// redirect
267	0	if (redirectPath != null) {
268	0	redirectRenderFaces(request, response, redirectPath);
269		}
270
271		// clear error info
272	0	clearErrorInfo(request);
273	0	}
274
275		protected void redirectRenderFaces(RenderRequest request,
276		RenderResponse response, String viewId) throws PortletException,
277		java.io.IOException {
278	0	if (logger.isDebugEnabled()) {
279	0	logger.debug("called redirectRenderFaces.. viewId is " + viewId);
280		}
281
282	0	List excludedNameList = (List) request
283		.getAttribute(EXCLUDED_ATTRIBUTE_LIST);
284		// clear attribute
285	0	for (Enumeration e = request.getAttributeNames(); e.hasMoreElements();) {
286	0	String key = (String) e.nextElement();
287	0	if (!excludedNameList.contains(key)) {
288	0	request.removeAttribute(key);
289		}
290		}
291		// call renderFaces again
292	0	request.getPortletSession().removeAttribute(
293		FacesPortlet.PREVIOUS_PORTLET_MODE);
294	0	request.setAttribute(FacesPortlet.DEFAULT_PAGE, viewId);
295	0	renderFaces(request, response);
296
297	0	}
298
299		protected void restoreFacesState(FacesContext facesContext) {
300
301	0	Map sessionMap = facesContext.getExternalContext().getSessionMap();
302	0	Map requestMap = facesContext.getExternalContext().getRequestMap();
303
304	0	String currentPortletMode = (String) requestMap
305		.get(CURRENT_PORTLET_MODE);
306	0	String previousPortletMode = (String) sessionMap
307		.get(PREVIOUS_PORTLET_MODE);
308
309	0	FacesPortletState state = null;
310	0	if (previousPortletMode != null &&
311		previousPortletMode.equals(currentPortletMode)) {
312	0	state = (FacesPortletState) sessionMap
313		.get(FACES_PORTLET_STATE_PREFIX + currentPortletMode);
314	0	if (state == null) {
315		// from request parameter
316	0	Map requestParameterMap = facesContext.getExternalContext()
317		.getRequestParameterMap();
318	0	String viewId = (String) requestParameterMap.get(VIEW_ID);
319	0	if (viewId != null && !checkSessionState(facesContext)) {
320	0	requestMap.put(VIEW_ID, viewId);
321		}
322
323	0	restoreView(facesContext);
324	0	return;
325		} else {
326		// get viewId
327	0	String viewId = state.getViewId();
328	0	requestMap.put(VIEW_ID, viewId);
329
330		// restore view
331	0	restoreView(facesContext);
332
333		// restore message information
334	0	Iterator clientIds = state.getClientIds();
335	0	while (clientIds.hasNext()) {
336	0	String clientId = (String) clientIds.next();
337	0	Iterator msgs = state.getMessages(clientId);
338	0	while (msgs.hasNext()) {
339	0	facesContext.addMessage(clientId, (FacesMessage) msgs
340		.next());
341		}
342		}
343
344		// restore request attributes
345	0	copyMap(state.getRequestMap(), facesContext
346		.getExternalContext().getRequestMap(), new ArrayList());
347
348		// restore state to UIViewRoot
349	0	Object s = state.getState();
350	0	if (s != null) {
351	0	facesContext.getViewRoot().processRestoreState(
352		facesContext, s);
353		}
354
355		}
356		} else {
357		// display new page
358	0	restoreDefaultFacesState(facesContext);
359		}
360
361	0	}
362
363		protected void restoreDefaultFacesState(FacesContext facesContext) {
364	0	ExternalContext externalContext = facesContext.getExternalContext();
365	0	Map requestMap = externalContext.getRequestMap();
366		// get default page
367	0	String viewId = (String) externalContext.getRequestMap().get(
368		DEFAULT_PAGE);
369	0	requestMap.put(VIEW_ID, viewId);
370
371		// remove all states in session
372	0	for (Iterator i = externalContext.getSessionMap().entrySet().iterator(); i
373	0	.hasNext();) {
374	0	Map.Entry e = (Map.Entry) i.next();
375	0	if (e.getKey() instanceof String) {
376	0	String key = (String) e.getKey();
377	0	if (key.startsWith(FACES_PORTLET_STATE_PREFIX)) {
378	0	externalContext.getSessionMap().remove(key);
379		}
380		}
381		}
382
383		// remove redirect scope
384	0	if (RedirectScope.isRedirecting(facesContext)) {
385	0	RedirectScope.removeContext(facesContext);
386		}
387
388	0	restoreView(facesContext);
389	0	}
390
391		private void restoreView(FacesContext facesContext) {
392	0	facesContext.renderResponse();
393		// call restore phase only
394	0	lifecycle.execute(facesContext);
395	0	}
396
397		//
398		// Action Methods
399		//
400
401		public void processAction(ActionRequest request, ActionResponse response)
402		throws PortletException, IOException {
403	0	if (logger.isDebugEnabled()) {
404	0	logger.debug("called processAction..");
405		}
406
407		// check session timeout
408	0	if (checkSessionState(request)) {
409	0	return;
410		}
411
412	0	String viewId = request.getParameter(VIEW_ID);
413	0	if (viewId != null) {
414	0	request.setAttribute(VIEW_ID, viewId);
415	0	executeFaces(request, response);
416		} else {
417	0	if (logger.isDebugEnabled()) {
418	0	logger.debug("skip processAction because viewId is null.");
419		}
420		}
421	0	}
422
423		protected void executeFaces(ActionRequest request, ActionResponse response)
424		throws PortletException, IOException {
425
426	0	storePortletConfig(request);
427	0	setCurrentPortletMode(request);
428
429		// create excluded list
430	0	createExcludedAttributeList(request);
431
432	0	FacesContext facesContext = facesContextFactory.getFacesContext(
433		getPortletContext(), request, response, lifecycle);
434
435		try {
436	0	WindowIdUtil.setupWindowId(facesContext.getExternalContext());
437	0	final Map pageScope = PageScope.getOrCreateContext(facesContext);
438	0	synchronized (pageScope) {
439	0	lifecycle.execute(facesContext);
440	0	}
441	0	} catch (Throwable e) {
442	0	handleException(facesContext, e);
443	0	} finally {
444	0	if (!facesContext.getResponseComplete()) {
445	0	request.setAttribute(VIEW_ID, facesContext.getViewRoot()
446		.getViewId());
447	0	saveFacesState(facesContext);
448	0	if (request.getParameter(RENDER_PARAMETER) != null) {
449	0	setRenderParameters(request, response);
450		}
451	0	} else if (RedirectScope.isRedirecting(facesContext)) {
452	0	saveFacesState(facesContext);
453		}
454		// release the FacesContext instance for this request
455	0	facesContext.release();
456	0	}
457	0	}
458
459		protected void saveFacesState(FacesContext facesContext) {
460	0	Map sessionMap = facesContext.getExternalContext().getSessionMap();
461	0	Map requestMap = facesContext.getExternalContext().getRequestMap();
462
463		// save portlet mode
464	0	String currentPortletMode = (String) requestMap
465		.get(CURRENT_PORTLET_MODE);
466	0	sessionMap.put(PREVIOUS_PORTLET_MODE, currentPortletMode);
467
468	0	FacesPortletState state = new FacesPortletState();
469
470	0	if (!PortletUtil.isRender(facesContext)) {
471		// save message information from this FacesContext
472	0	Iterator clientIds = facesContext.getClientIdsWithMessages();
473	0	while (clientIds.hasNext()) {
474	0	String clientId = (String) clientIds.next();
475	0	Iterator msgs = facesContext.getMessages(clientId);
476	0	while (msgs.hasNext()) {
477	0	state.addMessage(clientId, (FacesMessage) msgs.next());
478		}
479		}
480		}
481
482	0	String redirectPath = RedirectScope.getRedirectingPath(facesContext);
483	0	if (redirectPath == null) {
484	0	state.setViewId(facesContext.getViewRoot().getViewId());
485
486	0	List excludedNameList = (List) requestMap
487		.get(EXCLUDED_ATTRIBUTE_LIST);
488		// save request attributes
489	0	Map map = new HashMap();
490	0	copyMap(requestMap, map, excludedNameList);
491	0	state.setRequestMap(map);
492
493		// save state
494	0	StateManager stateManager = facesContext.getApplication()
495		.getStateManager();
496	0	stateManager.saveSerializedView(facesContext);
497
498		// store state to FacesPortletState
499	0	state.setState(facesContext.getViewRoot().processSaveState(
500		facesContext));
501		} else {
502		// replace viewId
503	0	state.setViewId(redirectPath);
504
505		// save request attributes
506	0	Map map = new HashMap();
507	0	state.setRequestMap(map);
508
509		// set state to null
510	0	state.setState(null);
511		}
512
513		// store state to session
514	0	sessionMap.put(FACES_PORTLET_STATE_PREFIX + currentPortletMode, state);
515
516	0	}
517
518		//
519		// Others
520		//
521
522		protected void handleException(FacesContext context, Throwable e)
523		throws PortletException, IOException {
524	0	ErrorPageManager errorPageManager = null;
525		try {
526	0	errorPageManager = (ErrorPageManager) DIContainerUtil
527		.getComponent(ErrorPageManager.class);
528	0	} catch (Exception e1) {
529	0	}
530	0	if (errorPageManager == null) {
531	0	errorPageManager = new NullErrorPageManagerImpl();
532		}
533
534	0	ExternalContext extContext = context.getExternalContext();
535	0	if (errorPageManager.handleException(e, context, extContext)) {
536	0	context.responseComplete();
537		} else {
538	0	if (e instanceof IOException) {
539	0	throw (IOException) e;
540	0	} else if (e instanceof PortletException) {
541	0	throw (PortletException) e;
542	0	} else if (e.getMessage() != null) {
543	0	throw new PortletException(e.getMessage(), e);
544		}
545	0	throw new PortletException(e);
546		}
547	0	}
548
549		protected boolean checkSessionState(PortletRequest request) {
550	0	return request.getPortletSession(false) == null \|\|
551		(request.getPortletSession().getAttribute(REDEPLOYED_PORTLET) == null);
552		}
553
554		protected boolean checkSessionState(FacesContext context) {
555	0	return context.getExternalContext().getSession(false) == null \|\|
556		(context.getExternalContext().getSessionMap().get(
557		REDEPLOYED_PORTLET) == null);
558		}
559
560		protected void createExcludedAttributeList(PortletRequest request) {
561		// create excluded list
562	0	ArrayList excludedNameList = new ArrayList();
563	0	Enumeration enu = request.getAttributeNames();
564	0	while (enu.hasMoreElements()) {
565	0	excludedNameList.add(enu.nextElement());
566		}
567		// reserved names
568	0	excludedNameList.add(EXCLUDED_ATTRIBUTE_LIST);
569	0	excludedNameList.add(JsfConstants.FACES_CONTEXT);
570	0	request.setAttribute(EXCLUDED_ATTRIBUTE_LIST, excludedNameList);
571	0	}
572
573		private void copyMap(Map fromMap, Map toMap, List excludedNameList) {
574	0	for (Iterator i = fromMap.entrySet().iterator(); i.hasNext();) {
575	0	Map.Entry e = (Map.Entry) i.next();
576	0	if (!toMap.containsKey((String) e.getKey()) &&
577		!excludedNameList.contains((String) e.getKey())) {
578	0	toMap.put(e.getKey(), e.getValue());
579		}
580		}
581	0	}
582
583		protected void setRenderParameters(ActionRequest request,
584		ActionResponse response) {
585	0	Enumeration enu = request.getParameterNames();
586	0	while (enu.hasMoreElements()) {
587	0	String key = (String) enu.nextElement();
588	0	response.setRenderParameter(key, request.getParameter(key));
589		}
590	0	}
591
592		protected void restoreErrorInfo(PortletRequest request) {
593	0	PortletSession portletSession = request.getPortletSession();
594	0	Throwable exception = (Throwable) portletSession
595		.getAttribute(JsfConstants.ERROR_EXCEPTION);
596	0	if (exception != null) {
597	0	request.setAttribute(JsfConstants.ERROR_EXCEPTION, exception);
598	0	request.setAttribute(JsfConstants.ERROR_EXCEPTION_TYPE, exception
599		.getClass());
600	0	request.setAttribute(JsfConstants.ERROR_MESSAGE, exception
601		.getMessage());
602		}
603	0	}
604
605		protected void clearErrorInfo(PortletRequest request) {
606	0	request.getPortletSession().removeAttribute(
607		JsfConstants.ERROR_EXCEPTION);
608	0	}
609		}