September 2012 - gatein-commits - Jboss List Archives

gatein SVN: r8854 - epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal.

by do-not-reply＠jboss.org

Author: mputz Date: 2012-09-28 11:01:12 -0400 (Fri, 28 Sep 2012) New Revision: 8854 Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java Log: Revert changes to UIApplicationList.java Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 14:54:40 UTC (rev 8853) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 15:01:12 UTC (rev 8854) @@ -90,35 +90,8 @@ { if (selectedCategory == null) return null; - - String remoteUser = Util.getPortalRequestContext().getRemoteUser(); - if (remoteUser == null || remoteUser.equals("")) - { return null; } - - ApplicationRegistryService service = getApplicationComponent(ApplicationRegistryService.class); - UserACL userACL = Util.getUIPortalApplication().getApplicationComponent(UserACL.class); - - List<Application> allApps = selectedCategory.getApplications(); - List<Application> apps = new ArrayList<Application>(); + List<Application> apps = selectedCategory.getApplications(); - for (Application app : allApps) - { - List<String> accessPermission = app.getAccessPermissions(); - if(accessPermission == null || accessPermission.size()==0) - { - continue; - } - accessCheck: - for (String p : accessPermission) - { - if (userACL.hasPermission(p)) - { - apps.add(app); - } - break accessCheck; - } - } - //Correct IconURL of Gadget GadgetRegistryService gadgetService = getApplicationComponent(GadgetRegistryService.class); for (Application app : apps)

11 years, 7 months

1
0
0 / 0

gatein SVN: r8853 - in epp/portal/branches/EPP_5_2_2_GA_BZ851985: component/portal/src/main/java/org/exoplatform/portal/mop/user and 2 other directories.

by do-not-reply＠jboss.org

Author: mputz Date: 2012-09-28 10:54:40 -0400 (Fri, 28 Sep 2012) New Revision: 8853 Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/navigation/NodeContext.java epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilter.java epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilterConfig.java epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/page/UIPageActionListener.java epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java Log: Resolved BZ#851985 - Performance issue in EPP 5.2 due to additional pages being loaded Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/navigation/NodeContext.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/navigation/NodeContext.java 2012-09-28 14:48:13 UTC (rev 8852) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/navigation/NodeContext.java 2012-09-28 14:54:40 UTC (rev 8853) @@ -304,7 +304,7 @@ private void doFilter(int depth, NodeFilter filter) { - boolean accept = filter.accept(depth, getId(), name, getState()); + boolean accept = filter.accept(depth, getId(), getName(), getState()); setHidden(!accept); if (expanded) { Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilter.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilter.java 2012-09-28 14:48:13 UTC (rev 8852) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilter.java 2012-09-28 14:54:40 UTC (rev 8853) @@ -96,6 +96,10 @@ public boolean accept(int depth, String id, String name, NodeState state) { + if (config.customFilter != null && !config.customFilter.accept(depth, id, name, state)) + { + return false; + } Visibility visibility = state.getVisibility(); // Correct null -> displayed Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilterConfig.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilterConfig.java 2012-09-28 14:48:13 UTC (rev 8852) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985/component/portal/src/main/java/org/exoplatform/portal/mop/user/UserNodeFilterConfig.java 2012-09-28 14:54:40 UTC (rev 8853) @@ -21,7 +21,7 @@ import org.exoplatform.commons.utils.Safe; import org.exoplatform.portal.mop.Visibility; - +import org.exoplatform.portal.mop.navigation.NodeFilter; import java.util.Collections; import java.util.EnumSet; import java.util.Set; @@ -50,6 +50,9 @@ /** . */ final boolean temporalCheck; + + /** . */ + final NodeFilter customFilter; public UserNodeFilterConfig(Builder builder) { @@ -62,6 +65,7 @@ this.visibility = Safe.unmodifiableSet(builder.withVisibility); this.authorizationMode = builder.withAuthorizationMode; this.temporalCheck = builder.withTemporalCheck; + this.customFilter = builder.withCustomFilter; } public Set<Visibility> getVisibility() @@ -100,6 +104,9 @@ /** . */ private boolean withTemporalCheck; + + /** . */ + private NodeFilter withCustomFilter; private Builder() { @@ -191,6 +198,12 @@ this.withAuthorizationMode = AUTH_NO_CHECK; return this; } + + public Builder withCustomFilter(NodeFilter customFilter) + { + this.withCustomFilter = customFilter; + return this; + } public UserNodeFilterConfig build() { Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/page/UIPageActionListener.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/page/UIPageActionListener.java 2012-09-28 14:48:13 UTC (rev 8852) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/page/UIPageActionListener.java 2012-09-28 14:54:40 UTC (rev 8853) @@ -19,15 +19,19 @@ package org.exoplatform.portal.webui.page; +import org.apache.commons.lang.StringUtils; import org.exoplatform.portal.application.PortalRequestContext; import org.exoplatform.portal.config.DataStorage; import org.exoplatform.portal.config.UserPortalConfig; +import org.exoplatform.portal.config.UserPortalConfigService; import org.exoplatform.portal.config.model.Container; import org.exoplatform.portal.config.model.ModelObject; import org.exoplatform.portal.config.model.Page; import org.exoplatform.portal.config.model.PortalConfig; import org.exoplatform.portal.mop.SiteKey; import org.exoplatform.portal.mop.SiteType; +import org.exoplatform.portal.mop.navigation.NodeFilter; +import org.exoplatform.portal.mop.navigation.NodeState; import org.exoplatform.portal.mop.user.UserNavigation; import org.exoplatform.portal.mop.user.UserNode; import org.exoplatform.portal.mop.user.UserNodeFilterConfig; @@ -36,6 +40,7 @@ import org.exoplatform.portal.webui.portal.PageNodeEvent; import org.exoplatform.portal.webui.portal.UIPortal; import org.exoplatform.portal.webui.util.PortalDataMapper; +import org.exoplatform.portal.webui.util.Util; import org.exoplatform.portal.webui.workspace.UIPortalApplication; import org.exoplatform.portal.webui.workspace.UIWorkingWorkspace; import org.exoplatform.web.application.ApplicationMessage; @@ -64,11 +69,17 @@ UIPortalApplication uiPortalApp = event.getSource(); UIPortal showedUIPortal = uiPortalApp.getCurrentSite(); - UserNodeFilterConfig.Builder builder = UserNodeFilterConfig.builder(); - builder.withReadCheck(); + PageNodeEvent<UIPortalApplication> pageNodeEvent = (PageNodeEvent<UIPortalApplication>)event; String nodePath = pageNodeEvent.getTargetNodeUri(); + + UserNodeFilterConfig.Builder pathFilterBuild = UserNodeFilterConfig.builder(); + pathFilterBuild.withReadCheck(); + pathFilterBuild.withCustomFilter(new PathFilter(nodePath)); + + UserNodeFilterConfig.Builder defNodeBuild = UserNodeFilterConfig.builder(); + defNodeBuild.withCustomFilter(new DefaultNodeFilter()); UserNode targetNode = null; SiteKey siteKey = pageNodeEvent.getSiteKey(); @@ -77,13 +88,13 @@ UserNavigation navigation = userPortal.getNavigation(siteKey); if (navigation != null) { - targetNode = userPortal.resolvePath(navigation, builder.build(), nodePath); + targetNode = userPortal.resolvePath(navigation, pathFilterBuild.build(), nodePath); if (targetNode == null) { // If unauthenticated users have no permission on PORTAL node and URL is valid, they will be required to login if (pcontext.getRemoteUser() == null && siteKey.getType().equals(SiteType.PORTAL)) { - targetNode = userPortal.resolvePath(navigation, builder.withAuthMode(UserNodeFilterConfig.AUTH_NO_CHECK).build(), nodePath); + targetNode = userPortal.resolvePath(navigation, null, nodePath); if (targetNode != null) { uiPortalApp.setLastRequestURI(null); @@ -94,7 +105,7 @@ else { // If path to node is invalid, get the default node instead of. - targetNode = userPortal.getDefaultPath(navigation, builder.build()); + targetNode = userPortal.getDefaultPath(navigation, defNodeBuild.build()); } } } @@ -102,7 +113,7 @@ if (targetNode == null) { - targetNode = userPortal.getDefaultPath(builder.build()); + targetNode = userPortal.getDefaultPath(defNodeBuild.build()); if (targetNode == null) { if (showedUIPortal != null) @@ -184,8 +195,84 @@ //Reset selected navigation on userPortalConfig PortalDataMapper.toUIPortal(uiPortal, userPortalConfig.getPortalConfig()); return uiPortal; + } + + private class PathFilter implements NodeFilter + { + private List<String> paths; + + public PathFilter(String nodePath) + { + String[] tmp = StringUtils.split(nodePath, "/"); + + paths = new ArrayList<String>(); + if (tmp != null) + { + for (String str : tmp) + { + if (str != null && !"".equals(str.trim())) + { + paths.add(str.trim()); + } + } + } + } + + @Override + public boolean accept(int depth, String id, String name, NodeState state) + { + return depth == 0 || (depth <= paths.size() && paths.get(depth -1).equals(name)); + } } - } + + private class DefaultNodeFilter implements NodeFilter + { + private boolean found; + + @Override + public boolean accept(int depth, String id, String name, NodeState state) + { + if (depth == 0) + { + return true; + } + else + { + if (found) + { + return false; + } + else + { + found = hasPermission(state.getPageRef()); + return found; + } + } + } + + private boolean hasPermission(String pageRef) + { + UIPortalApplication uiPortalApp = Util.getUIPortalApplication(); + UserPortalConfigService service = uiPortalApp.getApplicationComponent(UserPortalConfigService.class); + if (pageRef != null) + { + try + { + Page page = service.getPage(pageRef); + if (page != null) + { + return service.getUserACL().hasPermission(page); + } + } + catch (Exception e) {} + } + return false; + } + } + } + + + static public class DeleteGadgetActionListener extends EventListener<UIPage> { Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 14:48:13 UTC (rev 8852) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 14:54:40 UTC (rev 8853) @@ -90,8 +90,35 @@ { if (selectedCategory == null) return null; - List<Application> apps = selectedCategory.getApplications(); + String remoteUser = Util.getPortalRequestContext().getRemoteUser(); + if (remoteUser == null || remoteUser.equals("")) + { return null; } + + ApplicationRegistryService service = getApplicationComponent(ApplicationRegistryService.class); + UserACL userACL = Util.getUIPortalApplication().getApplicationComponent(UserACL.class); + + List<Application> allApps = selectedCategory.getApplications(); + List<Application> apps = new ArrayList<Application>(); + + for (Application app : allApps) + { + List<String> accessPermission = app.getAccessPermissions(); + if(accessPermission == null || accessPermission.size()==0) + { + continue; + } + accessCheck: + for (String p : accessPermission) + { + if (userACL.hasPermission(p)) + { + apps.add(app); + } + break accessCheck; + } + } + //Correct IconURL of Gadget GadgetRegistryService gadgetService = getApplicationComponent(GadgetRegistryService.class); for (Application app : apps) @@ -199,4 +226,4 @@ } } -} \ No newline at end of file +}

11 years, 7 months

1
0
0 / 0

gatein SVN: r8852 - epp/portal/branches/EPP_5_2_2_GA_BZ851985_BZ861377/webui/portal/src/main/java/org/exoplatform/portal/webui/portal.

by do-not-reply＠jboss.org

Author: mputz Date: 2012-09-28 10:48:13 -0400 (Fri, 28 Sep 2012) New Revision: 8852 Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985_BZ861377/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java Log: Resolved BZ#861377 - Adding permission check to UIApplicationList.getApplications() Modified: epp/portal/branches/EPP_5_2_2_GA_BZ851985_BZ861377/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java =================================================================== --- epp/portal/branches/EPP_5_2_2_GA_BZ851985_BZ861377/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 12:41:54 UTC (rev 8851) +++ epp/portal/branches/EPP_5_2_2_GA_BZ851985_BZ861377/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 14:48:13 UTC (rev 8852) @@ -36,7 +36,6 @@ import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; -import java.util.Iterator; import java.util.List; /** @@ -90,26 +89,48 @@ { if (selectedCategory == null) return null; - List<Application> apps = selectedCategory.getApplications(); - //Correct IconURL of Gadget - GadgetRegistryService gadgetService = getApplicationComponent(GadgetRegistryService.class); - for (Application app : apps) + String remoteUser = Util.getPortalRequestContext().getRemoteUser(); + if (remoteUser == null || remoteUser.equals("")) + { return null; } + + UserACL userACL = getApplicationComponent(UserACL.class); + + List<Application> allApps = selectedCategory.getApplications(); + List<Application> apps = new ArrayList<Application>(); + + for (Application app : allApps) { - if (ApplicationType.GADGET.equals(app.getType())) + List<String> accessPermission = app.getAccessPermissions(); + if (accessPermission == null || accessPermission.size() == 0) { - try + continue; + } + + GadgetRegistryService gadgetService = getApplicationComponent(GadgetRegistryService.class); + for (String p : accessPermission) + { + if (userACL.hasPermission(p)) { - Gadget gadget; - gadget = gadgetService.getGadget(app.getApplicationName()); - if (gadget != null) - app.setIconURL(gadget.getThumbnail()); + if (ApplicationType.GADGET.equals(app.getType())) + { + try + { + Gadget gadget; + gadget = gadgetService.getGadget(app.getApplicationName()); + if (gadget != null) + app.setIconURL(gadget.getThumbnail()); + } + catch (Exception e) + { + } + } + apps.add(app); + break; } - catch (Exception e) - { - } - } + } } + return apps; } @@ -137,7 +158,7 @@ { return; } ApplicationRegistryService service = getApplicationComponent(ApplicationRegistryService.class); - UserACL userACL = Util.getUIPortalApplication().getApplicationComponent(UserACL.class); + UserACL userACL = getApplicationComponent(UserACL.class); final Comparator<Application> appComparator = new Comparator<Application>() { @@ -166,7 +187,6 @@ continue; } - accessCheck: for (String p : accessPermission) { if (userACL.hasPermission(p)) @@ -176,8 +196,8 @@ Collections.sort(apps, appComparator); } categories.add(category); + break; } - break accessCheck; } } @@ -199,4 +219,4 @@ } } -} \ No newline at end of file +}

11 years, 7 months

1
0
0 / 0

gatein SVN: r8851 - epp/portal/branches.

by do-not-reply＠jboss.org

Author: mputz Date: 2012-09-28 08:41:54 -0400 (Fri, 28 Sep 2012) New Revision: 8851 Added: epp/portal/branches/EPP_5_2_2_GA_BZ851985_BZ861377/ Log: Create patch branch for BZ#861377

11 years, 7 months

1
0
0 / 0

gatein SVN: r8850 - epp/portal/branches/EPP_5_2_Branch/webui/portal/src/main/java/org/exoplatform/portal/webui/portal.

by do-not-reply＠jboss.org

Author: mputz Date: 2012-09-28 08:24:45 -0400 (Fri, 28 Sep 2012) New Revision: 8850 Modified: epp/portal/branches/EPP_5_2_Branch/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java Log: Resolves BZ#856083 - Adding permission check to UIApplicationList.getApplications() method Modified: epp/portal/branches/EPP_5_2_Branch/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java =================================================================== --- epp/portal/branches/EPP_5_2_Branch/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-19 06:42:19 UTC (rev 8849) +++ epp/portal/branches/EPP_5_2_Branch/webui/portal/src/main/java/org/exoplatform/portal/webui/portal/UIApplicationList.java 2012-09-28 12:24:45 UTC (rev 8850) @@ -36,7 +36,6 @@ import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; -import java.util.Iterator; import java.util.List; /** @@ -90,26 +89,48 @@ { if (selectedCategory == null) return null; - List<Application> apps = selectedCategory.getApplications(); - //Correct IconURL of Gadget - GadgetRegistryService gadgetService = getApplicationComponent(GadgetRegistryService.class); - for (Application app : apps) + String remoteUser = Util.getPortalRequestContext().getRemoteUser(); + if (remoteUser == null || remoteUser.equals("")) + { return null; } + + UserACL userACL = getApplicationComponent(UserACL.class); + + List<Application> allApps = selectedCategory.getApplications(); + List<Application> apps = new ArrayList<Application>(); + + for (Application app : allApps) { - if (ApplicationType.GADGET.equals(app.getType())) + List<String> accessPermission = app.getAccessPermissions(); + if (accessPermission == null || accessPermission.size() == 0) { - try + continue; + } + + GadgetRegistryService gadgetService = getApplicationComponent(GadgetRegistryService.class); + for (String p : accessPermission) + { + if (userACL.hasPermission(p)) { - Gadget gadget; - gadget = gadgetService.getGadget(app.getApplicationName()); - if (gadget != null) - app.setIconURL(gadget.getThumbnail()); + if (ApplicationType.GADGET.equals(app.getType())) + { + try + { + Gadget gadget; + gadget = gadgetService.getGadget(app.getApplicationName()); + if (gadget != null) + app.setIconURL(gadget.getThumbnail()); + } + catch (Exception e) + { + } + } + apps.add(app); + break; } - catch (Exception e) - { - } - } + } } + return apps; } @@ -137,7 +158,7 @@ { return; } ApplicationRegistryService service = getApplicationComponent(ApplicationRegistryService.class); - UserACL userACL = Util.getUIPortalApplication().getApplicationComponent(UserACL.class); + UserACL userACL = getApplicationComponent(UserACL.class); final Comparator<Application> appComparator = new Comparator<Application>() { @@ -166,7 +187,6 @@ continue; } - accessCheck: for (String p : accessPermission) { if (userACL.hasPermission(p)) @@ -176,8 +196,8 @@ Collections.sort(apps, appComparator); } categories.add(category); + break; } - break accessCheck; } } @@ -199,4 +219,4 @@ } } -} \ No newline at end of file +}

11 years, 7 months

1
0
0 / 0

gatein SVN: r8849 - in epp/docs/branches/6.0/Reference_Guide/en-US: extras/PortletBridge_Configuration and 4 other directories.

by do-not-reply＠jboss.org

Author: jaredmorgs Date: 2012-09-19 02:42:19 -0400 (Wed, 19 Sep 2012) New Revision: 8849 Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default197.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default200.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default218.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default219.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default224.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default225.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml Log: BZ#856417 - First draft of Portlet Bridge rework Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -3,66 +3,20 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<book> +<book status="draft"> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortalDevelopment.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/> - <part> + <part> <title>Authentication and Authorization</title> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> </part> <part> - <title>Portlet Bridge</title> - <chapter> - <title><remark/>Overview</title> - <section> - <title>Portlet Bridge</title> - <para>A portlet bridge allows non-native application frameworks to run in a portal environment, independent to the underlying portlet API, or portlet concept. This functionality provides a developer flexibility to continue writing applications in a preferred language, and allows a controlled transition to new technologies. </para> - </section> - <section> - <title>JBoss Portlet Bridge</title> - <para>The JBoss Portlet Bridge is a non-final draft implementation of the JSR-329 specification which supports the JSF 1.2 and 2.0 runtime within a JSR 168 or 286 portlet and with added enhancements to support other web frameworks (such as Seam and RichFaces). - -The project follows the spec from JSR-301 to JSR-329 and now maintains an alpha version (3.0) compatible with JSF 2.0 and RichFaces 4.0.</para> - </section> - <section> - <title>File Locations</title> - <remark>BZ#856417 - NEEDINFO - Do not have the root configuration directory for Portlet Bridge. Asked Ken in email on 17th Sep.</remark> - <para>Configuration files for Portlet Bridge are located in the <DIRECTORY PATH GOES HERE>.</para> - <para><variablelist> - <varlistentry> - <term>portlet.xml</term> - <listitem> - <para>Contains the primary configuration information for the portlet. Information such as the GenericFacesPortlet location, and which Java Server Faces (JSF) pages to render are stored in this file.</para> - </listitem> - </varlistentry> - <varlistentry> - <term>faces-config.xml</term> - <listitem> - <para>Contains</para> - </listitem> - </varlistentry> - <varlistentry> - <term>web.xml</term> - <listitem> - <para/> - </listitem> - </varlistentry> - </variablelist></para> - </section> - </chapter> - <chapter> - <title>Configuration </title> - <section/> - </chapter> - </part> - <part> <title>Web Services for Remote Portlets (WSRP)</title> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/> </part> - <part/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Advanced.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/eXoJCR.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -8,8 +8,8 @@ <simpara> <revhistory> <revision> - <revnumber>5.2.2-100</revnumber> - <date>Wed Sep 05 2012</date> + <revnumber>6.0.0-1</revnumber> + <date>Thu Sep 19 2012</date> <author> <firstname>Jared</firstname> <surname>Morgan</surname> @@ -17,38 +17,10 @@ </author> <revdescription> <simplelist> - <member>Prepared guide for JBoss Enterprise Portal Platform 5.2.2 GA. Refer to 5.2.2 Release Notes for a summary of changes to this guide.</member> + <member>BZ#856417 - First draft containing Portlet Bridge work. </member> </simplelist> </revdescription> </revision> - <revision> - <revnumber>5.2.1-100</revnumber> - <date>Tue Apr 17 2012</date> - <author> - <firstname>Jared</firstname> - <surname>Morgan</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Prepared guide for JBoss Enterprise Portal Platform 5.2.1 GA. Refer to 5.2.1 Release Notes for a summary of changes to this guide.</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>5.2.0-100</revnumber> - <date>Wed Dec 14 2011</date> - <author> - <firstname>Scott</firstname> - <surname>Mumford</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Publication build.</member> - </simplelist> - </revdescription> - </revision> </revhistory> </simpara> </appendix> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default197.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default197.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default197.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -1,20 +1,54 @@ -<portlet> +<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" + version="2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"> + <portlet> <portlet-name>yourPortletName</portlet-name> <portlet-class> javax.portlet.faces.GenericFacesPortlet </portlet-class> - + <init-param> <name>javax.portlet.faces.defaultViewId.view</name> <value>/welcome.xhtml</value> </init-param> - + <init-param> <name>javax.portlet.faces.defaultViewId.edit</name> <value>/jsf/edit.xhtml</value> </init-param> - + <init-param> <name>javax.portlet.faces.defaultViewId.help</name> <value>/jsf/help.xhtml</value> </init-param> + + <init-param> + <name>javax.portlet.faces.preserveActionParams</name> + <value>true</value> + </init-param> + + <init-param> + <name>javax.portlet.faces.autoDispatchEvents</name> + <value>true</value> + </init-param> + + <init-param> + <name>javax.portlet.faces.bridgeEventHandler</name> + <value>org.jboss.example.booking.BookingEventHandler</value> + </init-param> + + + <supported-publishing-event> + <qname xmlns:jbp="urn:jboss:portal:samples:event">[namespace]:[Event_name]</qname> + </supported-publishing-event> + + <event-definition> + <qname xmlns:jbp="urn:jboss:portal:samples:event">[namespace]:[event_name]</qname> + <value-type>[the appropriate class to map the application type to]</value-type> + </event-definition> + + <supported-processing-event> + <qname xmlns:jbp="urn:jboss:portal:samples:event">[namespace]:[event_name]</qname> + </supported-processing-event> +</portlet> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default200.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default200.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default200.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -3,8 +3,11 @@ xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"> ... -  - <context-param> - <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name> - <param-value>org.jboss.portletbridge.application.FaceletPortletViewHandler</param-value> - </context-param> + <context-param> + <param-name> + javax.portlet.faces.RENDER_POLICY + </param-name> + <param-value> + ALWAYS_DELEGATE + </param-value> + </context-param> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -2,12 +2,12 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"> - - <context-param> - <param-name>javax.portlet.faces.RENDER_POLICY </param-name> - <param-value> - NEVER_DELEGATE - </param-value> - </context-param> - ... + + <context-param> + <param-name>javax.portlet.faces.RENDER_POLICY </param-name> + <param-value> + NEVER_DELEGATE + </param-value> + </context-param> + </web-app> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default218.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default218.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default218.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -1 +1 @@ -<security:portal-identity authenticate-method="#{authenticator.authenticate}"/> +<security:portal-identity authenticate-method="#{authenticator.authenticate}"/> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default219.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default219.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_GettingStarted/default219.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -1,4 +1,4 @@ - <context-param> - <param-name>org.jboss.portletbridge.WRAP_SCRIPTS</param-name> - <param-value>true</param-value> - </context-param> +<context-param> + <param-name>org.jboss.portletbridge.WRAP_SCRIPTS</param-name> + <param-value>true</param-value> +</context-param> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default224.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default224.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default224.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -1,7 +1,7 @@ <navigation-rule> - <from-view-id>/register.jspx</from-view-id> - <navigation-case> - <from-outcome>edit</from-outcome> - <to-view-id>/edit.jspx?javax.portlet.faces.PortletMode=edit</to-view-id> - </navigation-case> -</navigation-rule> \ No newline at end of file + <from-view-id>/register.xhtml</from-view-id> + <navigation-case> + <from-outcome>edit</from-outcome> + <to-view-id>/edit.xhtml?javax.portlet.faces.PortletMode=edit</to-view-id> + </navigation-case> +</navigation-rule> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default225.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default225.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Portlet_Development/default225.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -1,7 +1,7 @@ <navigation-rule> - <from-view-id>/edit.jspx*</from-view-id> - <navigation-case> - <from-outcome>view</from-outcome> - <to-view-id>#{sessionScope['javax.portlet.faces.viewIdHistory.view']}</to-view-id> - </navigation-case> -</navigation-rule> \ No newline at end of file + <from-view-id>/edit.xhtml*</from-view-id> + <navigation-case> + <from-outcome>view</from-outcome> + <to-view-id>#{sessionScope['javax.portlet.faces.viewIdHistory.view']}</to-view-id> + </navigation-case> +</navigation-rule> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -40,11 +40,8 @@ </portlet-app> </programlisting> <para> - The path to the global <filename>portlet.xml</filename> is the value of <literal>gatein.portlet.config</literal> in the <filename>configuration.properties.xml</filename> file. By default The file path is <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/portlet.xml</filename> + The path to the global <filename>portlet.xml</filename> is the value of <literal>gatein.portlet.config</literal> in the <filename>configuration.properties.xml</filename> file. By default, the file path is <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/portlet.xml</filename> </para> - <para> - <emphasis role="bold">For JBoss</emphasis>: The file path is <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/default/conf/gatein/portlet.xml</filename>. - </para> <section id="sect-Reference_Guide-Shared_portlet.xml-Global_Metadata_Elements"> <title>Global Metadata Elements</title> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -5,663 +5,58 @@ ]> <section id="sect-Reference_Guide-Bridge_Configuration"> <title>Bridge Configuration</title> - <para> - The 329 specification is aimed at making the developer's life as easy as possible with JSF+Portlet development. You will see below that there are minimal settings to getting any JSF web application up and running in the Portal environment. - </para> - <section id="sect-Reference_Guide-Bridge_Configuration-Core_Setup_and_Configuration"> - <title>Core Setup and Configuration</title> - <section id="sect-Reference_Guide-Core_Setup_and_Configuration-portlet.xml"> - <title>portlet.xml</title> - <para> - The basic JSR-329 portlet configuration. + <section id="sect-Reference_Guide-Core_Setup_and_Configuration-portlet.xml"> + <title>portlet.xml</title> + <para>To have access to all portlet 2 specification features, you must declare the portlet schema definition as prescribed in the <filename>portlet.xml</filename> file. The <init-param> directives are explained in more detail if required below the portlet.xml code.</para> + <para>The XML below describes the basic directives required for a JSF2 portlet. +Some directives are optional, and are called-out in the file. </para> + <programlisting language="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default197.xml" parse="text"/></programlisting> + <variablelist> + <title><init-param> directives</title> + <varlistentry> + <term>preserveActionParams</term> + <listitem> + <para>Specifies how request parameters are maintained during a portal action request. </para> + <important> + <para>When the entire portlet is written in JSF, this parameter must be set to <parameter>true</parameter>. If your portlet uses a mix of view technologies, set this parameter to <parameter>false</parameter>, or do not specify it.</para> + </important> + <para> + When set to <parameter>true</parameter>, the bridge must maintain any request parameters assigned during the portlet's <emphasis>bridge request scope</emphasis> action request. +When set to <parameter>false</parameter>, or not defined, the action's request parameters are only maintained for the duration of the <emphasis>portlet request scope</emphasis>. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default197.xml" parse="text"/></programlisting> - <para> - When <parameter>preserveActionParams</parameter> is set to <parameter>TRUE</parameter>, the bridge must maintain any request parameters assigned during the portlet's action request. - </para> - <para> - The request parameters are maintained in the <emphasis>"bridge request scope"</emphasis>. When this attribute is not present or is <parameter>FALSE</parameter> the action's request parameters are only maintained for the duration of the <emphasis>portlet request scope</emphasis>. - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default198.xml" parse="text"/></programlisting> - </section> - <section id="sect-Reference_Guide-Core_Setup_and_Configuration-faces_config.xml"> - <title>faces-config.xml</title> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>autoDispatchEvents</term> + <listitem> + <para>Explicitly specifies that GenericFacesPortlet overrides event handling to dispatch all events to the Bridge. </para> + <para>GenericFacesPortlet overrides event handling by default, without supplying this directive. However, this parameter can be set to <parameter>true</parameter> so the behavior is explicitly stated in the configuration file.</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <title>Other directives</title> + <varlistentry> + <term><supported-publishing-event></term> + <listitem> + <para>Specifies that the portlet can publish an event to the portal. </para> + <para>The value of the <qname> parameter specifies a namespace (for example, jbp:), and the name to use when publishing the event (for example, BookingEvent).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><event-definition></term> + <listitem> + <para>Specifies how the event namespace and publishing name link to an actual type within a portlet application.</para> + <para>The directive requires a <qname> element, and a <value-type> element.</para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section id="sect-Reference_Guide-Core_Setup_and_Configuration-faces_config.xml"> + <title>faces-config.xml</title> + <para> The <parameter>PortletViewHandler</parameter> ensures that each JSF portlet instance is properly namespaced. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default199.xml" parse="text"/></programlisting> - </section> - <section id="sect-Reference_Guide-Core_Setup_and_Configuration-Facelets_Configuration"> - <title>Facelets Configuration</title> - <para> - The following <filename>web.xml</filename> setting is only for <literal>Facelets</literal> based applications - </para> - <section id="sect-Reference_Guide-Facelets_Configuration-web.xml"> - <title>web.xml</title> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default200.xml" parse="text"/></programlisting> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default201.xml" parse="text"/></programlisting> - <variablelist id="vari-Reference_Guide-web.xml-RenderPolicy_Options"> - <title>RenderPolicy Options</title> - <varlistentry> - <term>ALWAYS_DELEGATE</term> - <listitem> - <para> - Indicates the bridge should not render the view itself but rather always delegate the rendering. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>NEVER_DELEGATE</term> - <listitem> - <para> - Indicates the bridge should always render the view itself and never delegate. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>DEFAULT</term> - <listitem> - <para> - Directs the bridge to first delegate the render. If an exception is thrown, the bridge renders the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using default behavior as it would if DEFAULT was set. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - </section> - <section id="sect-Reference_Guide-Core_Setup_and_Configuration-JSP_Only_Configuration"> - <title>JSP Only Configuration</title> - <para> - The following <filename>web.xml</filename> setting is only for JSP based applications. Download the demonstration application <ulink url="http://anonsvn.jboss.org/repos/portletbridge/trunk/examples/jsf-ri/1.2-ba...">here</ulink>. - </para> - <section id="sect-Reference_Guide-JSP_Only_Configuration-web.xml"> - <title>web.xml</title> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default202.xml" parse="text"/></programlisting> - </section> - </section> - </section> - <section id="sect-Reference_Guide-Bridge_Configuration-RichFaces_Setup_and_Configuration_Options"> - <title>RichFaces Setup and Configuration Options</title> - <section id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-web.xml"> - <title>web.xml</title> - <para> - The following configuration is designated for portlets using the <application>RichFaces</application> library. These settings will vary based on your individual needs. - </para> - <para> - See <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/..."> this section</ulink> of the <application>RichFaces</application> documentation for more details. - </para> - <para> - Sometimes it is better to use the "<parameter>ALL</parameter>" load strategy in portlets so you do not need to worry about loading the "framework.pack.js" and "ui.pack.js" files manually in your portlet header. - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default204.xml" parse="text"/></programlisting> - <note> - <para> - If you use the "<parameter>NONE</parameter>" strategy, you must include the following scripts in your portlet or portal page header. If you are using <application>JBoss Portal</application>, you can add this to the <filename>jboss-portlet.xml</filename> file. - </para> - </note> - <para> - The <literal>org.ajax4jsf.RESOURCE_URI_PREFIX</literal> configuration cross-references the path to your scripts below. These settings are required for <application>RichFaces</application> using the "<parameter>NONE</parameter>" strategy. Replace all <replaceable>richFacesPortlet</replaceable> text in the example with the actual name of the portlet resource. </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default205.xml" parse="text"/></programlisting> - <para> - <application>Seam</application> automatically configures your Ajax4JSF Filter, so if you are running a <application>Seam</application> portlet, you do not need the following Filter configuration (however, you do need the <literal>RESOURCE_URI_PREFIX</literal> no matter what). - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default206.xml" parse="text"/></programlisting> - </section> - <section id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge"> - <title>Configure RichFaces to work with WSRP and PortletBridge</title> - <para> - Use the following settings in <filename>web.xml</filename> when running WSRP portlets: - </para> - <programlisting language="XML" role="XML"><context-param> - <param-name>org.jboss.portletbridge.WRAP_SCRIPTS</param-name> - <param-value>false</param-value> - </context-param> -.... - <context-param> - <param-name>org.richfaces.LoadStyleStrategy</param-name> - <param-value>ALL</param-value> - </context-param> - <context-param> - <param-name>org.richfaces.LoadScriptStrategy</param-name> - <param-value>DEFAULT</param-value> - </context-param> -</programlisting> - <para> - The styles below must also be manually added to the facelets template header in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/portletbridge/examples/richFacesPortlet-<replaceable>VERSION</replaceable>.war:richFacesPortlet.war/templates/main.xhtml</filename> file. - </para> - <programlisting language="XML" role="XML"><link rel="stylesheet" type="text/css" href="/richFacesPortlet/faces/rfRes/org/richfaces/renderkit/html/css/basic_both.xcss"/> -<link rel="stylesheet" type="text/css" href="/richFacesPortlet/faces/rfRes/org/richfaces/renderkit/html/css/extended_both.xcss"/> -<link rel="stylesheet" type="text/css" href="/richFacesPortlet/faces/rfRes/org/richfaces/skin.xcss"/> -</programlisting> - <para> - The table below outlines the current status of RichFaces features when used in both local and remote portlets. - </para> - <table id="tabl-Reference_Guide-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge-RichFaces_Feature_Status"> - <title>RichFaces Feature Status</title> - <tgroup cols="3"> - <thead> - <row> - <entry> Richfaces Component </entry> - <entry> Supported as Local Portlet </entry> - <entry> Supported as Remote Portlet using WSRP </entry> - </row> - </thead> - <tbody> - <row> - <entry> - <literal>a4j:commandButton</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:commandLink</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:jsFunction</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:push</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:poll</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:queue</literal> - </entry> - <entry> No </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>a4j:status</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:keepAlive</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:include</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:loadStyle</literal> - </entry> - <entry> No </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>a4j:loadScript</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:ajaxValidator</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:beanValidator</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:graphValidator</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:mediaOutput</literal> - </entry> - <entry> No </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:outputPanel</literal> - </entry> - <entry> Yes (except Firefox 3.5) </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>a4j:log</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:dataTable</literal> - </entry> - <entry> Yes (except Firefox 3.6 and IE8) </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>a4j:dataFilterSlider</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:dataGrid</literal> - </entry> - <entry> Yes </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:dataList</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:datascroller</literal> - </entry> - <entry> No </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:extendedDataTable</literal> - </entry> - <entry> Yes (except IE7) </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:repeat</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:scrollableDataTable</literal> - </entry> - <entry> Yes (except Firefox 3.6) </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>drag-drop support</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:contextMenu</literal> - </entry> - <entry> No </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:dropDownMenu</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:tree</literal> - </entry> - <entry> Yes (except Firefox 3.5) </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:modalPanel</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:paint2d</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:panel</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:panelBar</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:panelMenu</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:progressBar</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:separator</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:simpleTogglePanel</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:spacer</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:tabPanel</literal> - </entry> - <entry> Yes </entry> - <entry> Yes (except tab deletion) </entry> - </row> - <row> - <entry> - <literal>rich:togglePanel</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:toolBar</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:toolTip</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:calendar</literal> - </entry> - <entry> Yes </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:colorPicker</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:comboBox</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:editor</literal> - </entry> - <entry> No </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:fileUpload</literal> - </entry> - <entry> No </entry> - <entry> No </entry> - </row> - <row> - <entry> - <literal>rich:inplaceSelect</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:inplaceInput</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:inputNumberSpinner</literal> - </entry> - <entry> Yes (except IE7) </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:inputNumberSlider</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:suggestionBox</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:listShuttle</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:orderingList</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - <row> - <entry> - <literal>rich:pickList</literal> - </entry> - <entry> Yes </entry> - <entry> Yes </entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> - <section id="sect-Reference_Guide-Bridge_Configuration-Seam_Setup_and_Configuration_Options"> - <title>Seam Setup and Configuration Options</title> - <section id="sect-Reference_Guide-Seam_Setup_and_Configuration_Options-Configuration"> - <title>Configuration</title> - <para> - The <literal>ExceptionHandler</literal> is used to clean <application>Seam</application> contexts and transactions after errors. - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default207.xml" parse="text"/></programlisting> - </section> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default199.xml" parse="text"/></programlisting> </section> - <section id="sect-Reference_Guide-Bridge_Configuration-Portlet_2.0_Coordination"> - <title>Portlet 2.0 Coordination</title> - <note> - <title>Schema and XSD Definitions</title> - <para> - It is important to ensure, before using either of the following mechanisms, that the proper 2.0 schema and xsd are defined at the top of your <filename>portlet.xml</filename>. - </para> - </note> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default209.xml" parse="text"/></programlisting> - <section id="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events"> - <title>Sending and Receiving Events</title> - <section id="sect-Reference_Guide-Sending_and_Receiving_Events-Configuration"> - <title>Configuration</title> - <para> - Just like with any portlet 2.0 event consumer and receiver, you must define them in the <filename>portlet.xml</filename>. - </para> - <para> - You must also define the following <emphasis>init params</emphasis> in your <filename>portlet.xml</filename>. - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default210.xml" parse="text"/></programlisting> - <para> - While future versions of the 2.0 bridge will automate the dispatching and consuming of events, at the moment you must dispatch the event in the JSF or Seam backing bean. - </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default211.java" parse="text"/></programlisting> - <para> - You must also create the event handler class by implementing the <literal>BridgeEventHandler</literal> interface to process the event payload. - </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/BookingEventHandler.java" parse="text"/></programlisting> - </section> - </section> - <section id="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters"> - <title>Public Render Parameters</title> - <section id="sect-Reference_Guide-Public_Render_Parameters-Configuration"> - <title>Configuration</title> - <para> - Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet 2.0 features. Several portlets (JSF or otherwise) can share the same render parameters. This feature can be used to present a cohesive UI to the user across all portlets on the page. An example would be using an employee ID to display relative data. - </para> - <para> - The bridge maps a render parameter to a backing bean using settings in your <filename>faces-config.xml</filename> and <filename>portlet.xml</filename>. - </para> - <para> - A clear and working example can be found in the Seam Booking Demo portlet. <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.3.0.CP01.EPP521/examp..."/> - </para> - <para> - You must define the following <emphasis>init params</emphasis> in your <filename>portlet.xml</filename>. - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default212.xml" parse="text"/></programlisting> - <para> - Create a managed bean and <literal>public-parameter-mappings</literal> in your <filename>faces-config.xml</filename>. This should be a basic bean that you can bind the passed parameter to a string with <emphasis>getter</emphasis> and <emphasis>setter</emphasis>. - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default213.xml" parse="text"/></programlisting> - <para> - You must set the parameter in the JSF or Seam backing bean, if you are providing one from your portlet. - </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default214.java" parse="text"/></programlisting> - <para> - Then you must also implement the <literal>BridgePublicRenderParameterHandler</literal> interface to process any updates from the received parameter. - </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default215.java" parse="text"/></programlisting> - </section> - </section> - <section id="sect-Reference_Guide-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet"> - <title>Serving Your JSF Resources in a Portlet</title> - <section id="sect-Reference_Guide-Serving_Your_JSF_Resources_in_a_Portlet-Configuration"> - <title>Configuration</title> - <para> - We have setup a few examples to show you how to use <literal>EL</literal> and a simple bean that will allow you to use the portlet resource serving mechanism within a JSF portlet. - </para> - <para> - In <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.3.0.CP01.EPP521/examp...">ResourceBean.java</ulink>, you can see a very simple implementation of a Map object that uses the bridge to get and encode a resource URL served from the portlet application. - </para> - <para> - So, when you have the normal "<filename>/images</filename>", "<filename>/styles</filename>" and other resource folders in your web application, you can use the following <literal>EL</literal> expression to serve them in your JSF application. - </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default216.java" parse="text"/></programlisting> - <para> - Just copy the <literal>ResourceBean.java</literal> code above, and add an entry to your <filename>faces-config.xml</filename> for the bean: - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Configuration/default217.xml" parse="text"/></programlisting> - </section> - </section> - </section> </section> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -8,6 +8,48 @@ <para> This chapter demonstrates common development tasks described by the 329 specification. </para> + <section> + <title>Portlet tags</title> + <para>Portlet Bridge supports the following tags from section PLT.26 of the Portlet 2.0 Spec (JSR 286):</para> + <itemizedlist> + <listitem> + <para>actionURL</para> + </listitem> + <listitem> + <para>renderURL</para> + </listitem> + <listitem> + <para>resourceURL</para> + </listitem> + <listitem> + <para>namespace</para> + </listitem> + <listitem> + <para>param</para> + </listitem> + <listitem> + <para>property</para> + </listitem> + </itemizedlist> + <para>When using the tag library, the following namespace needs to be added to the facelet page of the application.</para> + <programlisting>xmlns:pbr="http://jboss.org/portletbridge"</programlisting> + <example> + <title>renderURL example</title> + <para>Generate a Portlet Render URL that enables switching between Portlet modes.</para> + <programlisting language="XML"><pbr:renderURL var="renderUrl" portletMode="edit"> +</pbr:renderURL> +<h:outputLink value="#{renderUrl}">Edit Mode</h:outputLink></programlisting> + </example> + <example> + <title>namespace example</title> + <para>This portlet tag is particularly useful for prefixing JavaScript functions within a given portlet. This ensures that the JavaScript function name does not clash with a name from another portlet, or from the same portlet displayed on the same page multiple times. </para> + <para>An example for defining a JavaScript method is:</para> + <programlisting language="XML"><script type='text/javascript'> + function <pbr:namespace />DoSomething() { + } +</script></programlisting> + </example> + </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Excluding_Attributes_from_the_Bridge_Request_Scope"> <title>Excluding Attributes from the Bridge Request Scope</title> <para> @@ -18,18 +60,56 @@ </para> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default223.xml" parse="text"/></programlisting> </section> + <section id="JSF_Facelet_View"> + <title>JSF facelet view</title> + <para>When creating a JSF Facelet view document, it is common to see content wrapped with the following code.</para> + <programlisting language="HTML"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "> +<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" + xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:a4j="http://richfaces.org/a4j"> + +</html></programlisting> + <para>Because a single portlet only reflects a potentially small portion of the HTML markup for a page, a JSF portlet returning the above markup for each portlet can be distracting, and potentially problematic.</para> + <para>The recommended way to wrap the content of a JSF Facelet view document for a portlet is to use the <f:view> element. Using <f:view> means that only the relevant content of the portlet mark-up is returned to the page.</para> + <programlisting language="HTML"><f:view xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" + xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:a4j="http://richfaces.org/a4j"> + +</f:view></programlisting> + <note> + <para>While not specifically relevant to portlet, it is important to include <h:head> and <h:body> elements to allow JSF to process the facelet correctly.</para> + </note> + </section> + <section id="JSF_Facelet_Error_Handling"> + <title>Error handling</title> + <para>To display error pages for specific exceptions in a JSF portlet, the following code is required in the web.xml file.</para> + <programlisting language="XML"><error-page> + <exception-type>javax.servlet.ServletException</exception-type> + <location>/faces/error.xhtml</location> +</error-page> +<error-page> + <exception-type>javax.faces.application.ViewExpiredException</exception-type> + <location>/faces/error.xhtml</location> +</error-page></programlisting> + <para>The above error page definitions are appropriate for a JSF portlet that has a FacesServlet mapping such as /faces/. </para> + <para>If the FacesServlet mapping was **.jsf, the location would be error, error.jsf or error.xhtml.</para> + <para>There is no requirement when using FacesServlet suffix mapping to append an extension, the name of the view is all that is required for the page to be found</para> + <note> + <para>Remember to add a link from any error page to the normal flow of the JSF application, otherwise the same error page will be constantly displayed.</para> + </note> + </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes"> - <title>Supporting PortletMode Changes</title> + <title>Switching Portlet Modes</title> <para> A <literal>PortletMode</literal> represents a distinct render path within an application. There are three standard modes: <emphasis>view</emphasis>, <emphasis>edit</emphasis>, and <emphasis>help</emphasis>. </para> <para> The bridge's <literal>ExternalContext.encodeActionURL</literal> recognizes the query string parameter <literal>javax.portlet.faces.PortletMode</literal> and uses this parameter's value to set the portlet mode on the underlying portlet <literal>actionURL</literal> or response. - </para> - <para> - Once processed it then removes this parameter from the query string. This means the following navigation rule causes one to render the <filename>/edit.jspx</filename> viewId in the portlet edit mode: - </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default224.xml" parse="text"/></programlisting> + + Once processed it then removes this parameter from the query string. </para> + <example> + <title>/edit.xhtml navigation rule</title> + <para>This navigation rule causes one to render the <filename>/edit.xhtml</filename> viewId in the portlet edit mode. </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default224.xml" parse="text"/></programlisting> + </example> </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId"> <title>Navigating to a mode's last viewId</title> @@ -45,7 +125,11 @@ <para> This is most easily expressed via an <literal>EL</literal> expression. For example: </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default225.xml" parse="text"/></programlisting> + <example> + <title>/register.xhtml viewId navigation rule</title> + <para><remark>BZ#856417 - added from "Portlet Mode's last viewId" Confluence section</remark>This navigation rule causes one to render the <filename>/edit.xhtml</filename> viewId in the portlet edit mode. </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default225.xml" parse="text"/></programlisting> + </example> <section id="sect-Reference_Guide-Navigating_to_a_modes_last_viewId-Note_to_Portlet_Developers"> <title>Note to Portlet Developers</title> <para> @@ -131,7 +215,7 @@ However, if these do not meet your use case or you have a different strategy, you can use one of the following methods. </para> <section id="sect-Reference_Guide-Communication_Between_Your_Portlets-Storing_Components_in_PortletSession.APPLICATION_SCOPE"> - <title>Storing Components in <parameter>PortletSession.APPLICATION_SCOPE</parameter></title> + <title>Storing Components in PortletSession.APPLICATION_SCOPE</title> <para> Sometimes it is beneficial to store your <application>Seam</application> components in the portlet <parameter>APPLICATION_SCOPE</parameter>. </para> @@ -171,33 +255,156 @@ </section> </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Linking_to_PortletJSF_Pages_Using_houtputlink"> - <title>Linking to Portlet/JSF Pages Using h:outputlink</title> - <para> - For linking to any JSF/Facelets page within your portlet web application, you can use the following. + <title>Linking to a Facelets page within the same portlet</title> + <para>To link any JSF/Facelets page within a portlet web application, use the following code. </para> + <remark>BZ#856417 - This code sample is the same in the Confluence docs.</remark> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default238.xml" parse="text"/></programlisting> </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Redirecting_to_an_External_Page_or_Resource"> - <title>Redirecting to an External Page or Resource</title> + <title>Redirecting to an external page or resource</title> <para> - To link to a non JSF view, <emphasis>jboss.org</emphasis> for example, you can use the following parameter. + To link to a non JSF view, <emphasis>jboss.org</emphasis> for example, you can use the following code. </para> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default239.xml" parse="text"/></programlisting> - <para> - Then in your backing bean, you must call a <parameter>redirect()</parameter>. + <para>In the backing bean, a <parameter>redirect()</parameter> must be called. </para> - <programlisting language="Java" role="JAVA">FacesContext.getCurrentInstance().getExternalContext().redirect("http://www.jboss.org"); -</programlisting> + <programlisting language="Java">public class YourBean { + public void yourListener() { + FacesContext.getCurrentInstance().getExternalContext().redirect("http://www.jboss.org"); + } +}</programlisting> </section> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Using_Provided_EL_Variables"> <title>Using Provided EL Variables</title> + <remark>BZ#856417 - Added the table from Confluence</remark> <para> - All <literal>EL</literal> variables found in the JSR-329 (Portlet 2.0) specification are available in the JBoss Portlet Bridge. For example, you can use the following to edit the portlet preferences on the UI: + All <literal>EL</literal> variables found in the JSR-329 (Portlet 2.0) specification are available in the JBoss Portlet Bridge. </para> + <table frame="all" pgwide="1"> + <title/> + <tgroup cols="2"> + <colspec colname="c1"/> + <colspec colname="c2"/> + <tbody> + <row> + <entry>portalConfig</entry> + <entry> + <para>Object of type javax.portlet.PortletConfig +</para> + </entry> + </row> + <row> + <entry>actionRequest</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.ActionRequest</para> + <para>(only accessible when processing an ActionRequest)</para> + </entry> + </row> + <row> + <entry>actionResponse</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.ActionResponse</para> + <para>(only accessible when processing an ActionResponse)</para> + </entry> + </row> + <row> + <entry>eventRequest</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.EventRequest</para> + <para>(only accessible when processing an EventRequest)</para> + </entry> + </row> + <row> + <entry>eventResponse</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.EventResponse</para> + <para>(only accessible when processing an EventRequest)</para> + </entry> + </row> + <row> + <entry>renderRequest</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.RenderRequest</para> + <para>(only accessible when processing an RenderResponse)</para> + </entry> + </row> + <row> + <entry>renderResponse</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.RenderResponse</para> + <para>(only accessible when processing an RenderResponse)</para> + </entry> + </row> + <row> + <entry>resourceRequest</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.ResourceRequest</para> + <para>(only accessible when processing an ResourceRequest)</para> + </entry> + </row> + <row> + <entry>resourceResponse</entry> + <entry> + <para>Object of type</para> + <para>javax.portlet.ResourceResponse</para> + <para>(only accessible when processing an ResourceResponse)</para> + </entry> + </row> + <row> + <entry>portletSession</entry> + <entry> + <para>Current PortletSession object +</para> + </entry> + </row> + <row> + <entry>portletSessionScope</entry> + <entry> + <para>Map of PortletSession attributes in PORTLET_SCOPE. JSP Expression returns immutable Map, but Faces Expression returns mutable Map.</para> + </entry> + </row> + <row> + <entry>httpSessionScope</entry> + <entry> + <para>Mutable Map of PortletSession attributes in APPLICATION_SCOPE</para> + </entry> + </row> + <row> + <entry>portletPreferences</entry> + <entry> + <para>Current PortletPreferences object</para> + </entry> + </row> + <row> + <entry>portletPreferencesValues</entry> + <entry> + <para>Immutable Map containing entries equivalent to PortletPreferences.getMap()</para> + </entry> + </row> + <row> + <entry>mutablePortletPreferencesValues</entry> + <entry> + <para>Mutable Map of type Map<String, javax.portlet.faces.preference.Preference>. This EL variable provides read/write access to each portlet preference.</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <example> + <title/> + <para>This code allows you to edit the portlet preferences on the UI </para> - <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default241.xml" parse="text"/></programlisting> - <para> - Then in your backing bean, you must call the PortletPreferences.store() method. + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default241.xml" parse="text"/></programlisting> + <para>In the backing bean, call the PortletPreferences.store() method. </para> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default242.java" parse="text"/></programlisting> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default242.java" parse="text"/></programlisting> + </example> </section> </section> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2012-09-17 03:31:58 UTC (rev 8848) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2012-09-19 06:42:19 UTC (rev 8849) @@ -1,13 +1,877 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Building_JSF_Portlets"> - <title>Building JSF Portlets</title> - <xi:include href="PortletBridge/overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="PortletBridge/gettingstarted.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="PortletBridge/configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="PortletBridge/portlet_development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <title>JBoss Portlet Bridge</title> + <section> + <title>Portlet Bridge</title> + <para>A portlet bridge is a mediator that allows non-native application frameworks to run in a portal environment, independent to the underlying portlet API, or portlet concept. This functionality provides a developer flexibility to continue writing applications in a preferred language, and allows a controlled transition to new technologies. </para> + </section> + <section> + <title>JBoss Portlet Bridge</title> + <para>The JBoss Portlet Bridge is a non-final draft implementation of the JSR-329 specification. It supports the JSF 1.2 and 2.0 runtime within a JSR 168 or 286 portlet. +The project follows the spec from JSR-301 to JSR-329, with version 3.0 of the bridge compatible with JSF 2.0 and RichFaces 4.0.</para> + <para> + JBoss Portlet Bridge allows JSF applications to run using supported JBoss frameworks such as <application>Seam</application> and <application>RichFaces</application>. + </para> + <para> + The bridge is used to execute <literal>Faces</literal> requests on behalf of the portlet. During each request, the <literal>Faces</literal> environment is setup and handled by the bridge. + </para> + <para> + Part of this implementation acts as a <literal>Faces</literal> controller, much like the FacesServlet does in the direct client request environment. + </para> + <para> + The other part of this implementation is provided by implementing a variety of (standard) <literal>Faces</literal> extensions. + </para> + </section> + <section> + <title>File Locations</title> + <remark>BZ#856417 - NEEDINFO - will we be packaging the portletbridge binaries in this folder for EPP 6? </remark> + <para>The binaries required for Portlet Bridge applications, and example applications that can be used to learn and understand JSF applications are located in in <filename>EPP_HOME/portletbridge</filename>. </para> + <para>Configuration files for Portlet Bridge are located in the following locations: </para> + <remark>BZ#856417 - NEEDINFO - basing these file paths on what I understand the structure will be using EAP 6. DOMAIN in this case refers to /managed or /standalone</remark> + <itemizedlist> + <listitem> + <para><replaceable>EPP_DIST</replaceable>/<replaceable>DOMAIN</replaceable>/conf/gatein/portlet.xml</para> + </listitem> + <listitem> + <para><replaceable>EPP_HOME</replaceable>/<replaceable>DOMAIN</replaceable>/<replaceable>portlet_name</replaceable>.war/WEB-INF/faces-config.xml</para> + </listitem> + <listitem> + <para><replaceable>EPP_HOME</replaceable>/<replaceable>DOMAIN</replaceable>/<replaceable>portlet_name</replaceable>.war/WEB-INF/web.xml</para> + </listitem> + </itemizedlist> + <para><variablelist> + <varlistentry> + <term> + <filename>portlet.xml</filename> + </term> + <listitem> + <para>Contains the primary configuration information for the portlet. Information such as the GenericFacesPortlet location, and which Java Server Faces (JSF) pages to render are stored in this file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <filename>faces-config.xml</filename> + </term> + <listitem> + <para>Contains configuration directives that are specific to JSF applications. The specific directives will be covered as needed throughout this guide.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <filename>web.xml</filename> + </term> + <listitem> + <para>Contains configuration directives that apply to the web application in general.</para> + </listitem> + </varlistentry> + </variablelist></para> + </section> + <section id="What_is_a_portlet_application"> + <title>Portlet application</title> + <para>A portlet application is defined as a single web archive (WAR). </para> + <para>All portlets that are part of the same WAR are considered to form part of the same portlet application.</para> + </section> + <section> + <title>Bridgelets</title> + <para>Bridgelets are extensions that sit on top of the portlet bridge framework. They extend the functionality of other JBoss portlet applications, and are critical in JSF portlet development. </para> + <para>Bridglets are made available in the impl development binary, located in <filename><replaceable>EPP_HOME</replaceable>/portletbridge</filename>. </para> + </section> + <section id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-Seam_Bridgelets"> + <title>Seam Bridgelet</title> + <para><literal>PortalIdentity</literal> <application>Seam</application> bridgelet allows you to implement Single Sign-On (SSO) between <application>Seam</application> and <application>JBoss Enterprise Portal Platform</application>. + </para> + <para> + This bridgelet is configured in the application's <filename>components.xml</filename> file, by specifying the following directive: </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_GettingStarted/default218.xml" parse="text"/></programlisting> + </section> + <section id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-RichFaces_Bridgelets"> + <title>RichFaces Bridgelet</title> + <para> + <application>Richfaces</application> does not account for multiple components on the same portal page by default. This following <filename>web.xml</filename> bridgelet renders all <application>RichFaces</application> component javascript portal-friendly. + </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_GettingStarted/default219.xml" parse="text"/></programlisting> + </section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="PortletBridge/configuration.xml"/> + <section> + <title>Render Policy Parameters</title> + <para>Different JSF View Declaration Languages require different behavior from the JBoss Portlet Bridge when it comes to rendering views. Instructing the Bridge on which policy to use is done using the javax.portlet.faces.RENDER_POLICY <context-param> directive in <filename>web.xml</filename>.</para> + <variablelist id="vari-Reference_Guide-web.xml-RenderPolicy_Options"> + <title>RenderPolicy Options</title> + <varlistentry> + <term>ALWAYS_DELEGATE</term> + <listitem> + <para> + Indicates the bridge should not render the view itself, but rather always delegate the rendering. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>NEVER_DELEGATE</term> + <listitem> + <para> + Indicates the bridge should always render the view itself and never delegate. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>DEFAULT</term> + <listitem> + <para> + Directs the bridge to first delegate the render. If an exception is thrown, the bridge renders the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using default behavior as it would if DEFAULT was set. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section id="sect-Reference_Guide-Core_Setup_and_Configuration-Facelets_Configuration"> + <title>Facelets Configuration</title> + <para> + The following <filename>web.xml</filename> setting is only for <literal>Facelets</literal> based applications. </para> + <section id="sect-Reference_Guide-Facelets_Configuration-web.xml"> + <title>web.xml</title> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default201.xml" parse="text"/></programlisting> + </section> + </section> + <section id="sect-Reference_Guide-Core_Setup_and_Configuration-JSP_Only_Configuration"> + <title>JSP Only Configuration</title> + <para> + The following <filename>web.xml</filename> setting is only for JSP based applications. Download the demonstration application <ulink url="http://anonsvn.jboss.org/repos/portletbridge/trunk/examples/jsf-ri/1.2-ba...">here</ulink>. + </para> + <section id="sect-Reference_Guide-JSP_Only_Configuration-web.xml"> + <title>web.xml</title> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default202.xml" parse="text"/></programlisting> + </section> + </section> + <section id="sect-Reference_Guide-Bridge_Configuration-RichFaces_Setup_and_Configuration_Options"> + <title>RichFaces Setup and Configuration Options</title> + <remark>BZ#856417 - NEEDINFO - these sections remain untouched in the EPP 6 work to date. Should they be reviewed?</remark> + <section id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-web.xml"> + <title>Richfaces web.xml settings</title> + <para><remark>BZ#856417 - NEEDINFO - Is this Richfaces configuration still relevant for PBR v3.0?</remark> + The following configuration is designated for portlets using the <application>RichFaces</application> library. These settings will vary based on your individual needs. + </para> + <para> + See <ulink url="http://docs.jboss.org/richfaces/latest_3_3_X/en/devguide/html/Architectur..."> this section</ulink> of the <application>RichFaces</application> documentation for more details. + </para> + <para> + Sometimes it is better to use the "<parameter>ALL</parameter>" load strategy in portlets so you do not need to worry about loading the "framework.pack.js" and "ui.pack.js" files manually in your portlet header. + </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default204.xml" parse="text"/></programlisting> + <note> + <para> + If you use the "<parameter>NONE</parameter>" strategy, you must include the following scripts in your portlet or portal page header. If you are using <application>JBoss Portal</application>, you can add this to the <filename>jboss-portlet.xml</filename> file. + </para> + </note> + <para> + The <literal>org.ajax4jsf.RESOURCE_URI_PREFIX</literal> configuration cross-references the path to your scripts below. These settings are required for <application>RichFaces</application> using the "<parameter>NONE</parameter>" strategy. Replace all <replaceable>richFacesPortlet</replaceable> text in the example with the actual name of the portlet resource. </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default205.xml" parse="text"/></programlisting> + <para> + <application>Seam</application> automatically configures your Ajax4JSF Filter, so if you are running a <application>Seam</application> portlet, you do not need the following Filter configuration (however, you do need the <literal>RESOURCE_URI_PREFIX</literal> no matter what). + </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default206.xml" parse="text"/></programlisting> + </section> + <section id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge"> + <title>Configure RichFaces to work with WSRP and PortletBridge</title> + <remark>BZ#856417 - NEEDINFO - Are we supporting this in EPP 6?</remark> + <para> + Use the following settings in <filename>web.xml</filename> when running WSRP portlets: + </para> + <programlisting language="XML" role="XML"><context-param> + <param-name>org.jboss.portletbridge.WRAP_SCRIPTS</param-name> + <param-value>false</param-value> + </context-param> +.... + <context-param> + <param-name>org.richfaces.LoadStyleStrategy</param-name> + <param-value>ALL</param-value> + </context-param> + <context-param> + <param-name>org.richfaces.LoadScriptStrategy</param-name> + <param-value>DEFAULT</param-value> + </context-param> +</programlisting> + <para> + The styles below must also be manually added to the facelets template header in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/portletbridge/examples/richFacesPortlet-<replaceable>VERSION</replaceable>.war:richFacesPortlet.war/templates/main.xhtml</filename> file. + </para> + <programlisting language="XML" role="XML"><link rel="stylesheet" type="text/css" href="/richFacesPortlet/faces/rfRes/org/richfaces/renderkit/html/css/basic_both.xcss"/> +<link rel="stylesheet" type="text/css" href="/richFacesPortlet/faces/rfRes/org/richfaces/renderkit/html/css/extended_both.xcss"/> +<link rel="stylesheet" type="text/css" href="/richFacesPortlet/faces/rfRes/org/richfaces/skin.xcss"/> +</programlisting> + <para> + The table below outlines the current status of RichFaces features when used in both local and remote portlets. + </para> + <table id="tabl-Reference_Guide-Configuration_needed_for_Richfaces_to_work_with_WSRP_and_PortletBridge-RichFaces_Feature_Status"> + <title>RichFaces Feature Status</title> + <tgroup cols="3"> + <thead> + <row> + <entry> Richfaces Component </entry> + <entry> Supported as Local Portlet </entry> + <entry> Supported as Remote Portlet using WSRP </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>a4j:commandButton</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:commandLink</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:jsFunction</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:push</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:poll</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:queue</literal> + </entry> + <entry> No </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>a4j:status</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:keepAlive</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:include</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:loadStyle</literal> + </entry> + <entry> No </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>a4j:loadScript</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:ajaxValidator</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:beanValidator</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:graphValidator</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:mediaOutput</literal> + </entry> + <entry> No </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:outputPanel</literal> + </entry> + <entry> Yes (except Firefox 3.5) </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>a4j:log</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:dataTable</literal> + </entry> + <entry> Yes (except Firefox 3.6 and IE8) </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>a4j:dataFilterSlider</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:dataGrid</literal> + </entry> + <entry> Yes </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:dataList</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:datascroller</literal> + </entry> + <entry> No </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:extendedDataTable</literal> + </entry> + <entry> Yes (except IE7) </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:repeat</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:scrollableDataTable</literal> + </entry> + <entry> Yes (except Firefox 3.6) </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>drag-drop support</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:contextMenu</literal> + </entry> + <entry> No </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:dropDownMenu</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:tree</literal> + </entry> + <entry> Yes (except Firefox 3.5) </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:modalPanel</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:paint2d</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:panel</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:panelBar</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:panelMenu</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:progressBar</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:separator</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:simpleTogglePanel</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:spacer</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:tabPanel</literal> + </entry> + <entry> Yes </entry> + <entry> Yes (except tab deletion) </entry> + </row> + <row> + <entry> + <literal>rich:togglePanel</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:toolBar</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:toolTip</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:calendar</literal> + </entry> + <entry> Yes </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:colorPicker</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:comboBox</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:editor</literal> + </entry> + <entry> No </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:fileUpload</literal> + </entry> + <entry> No </entry> + <entry> No </entry> + </row> + <row> + <entry> + <literal>rich:inplaceSelect</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:inplaceInput</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:inputNumberSpinner</literal> + </entry> + <entry> Yes (except IE7) </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:inputNumberSlider</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:suggestionBox</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:listShuttle</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:orderingList</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + <row> + <entry> + <literal>rich:pickList</literal> + </entry> + <entry> Yes </entry> + <entry> Yes </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + <section id="sect-Reference_Guide-Bridge_Configuration-Seam_Setup_and_Configuration_Options"> + <title>Seam Setup and Configuration Options</title> + <remark>BZ#856417 - NEEDINFO - these sections remain untouched in the EPP 6 work to date. Should they be reviewed?</remark> + <section id="sect-Reference_Guide-Seam_Setup_and_Configuration_Options-Configuration"> + <title>Configuration</title> + <para> + The <literal>ExceptionHandler</literal> is used to clean <application>Seam</application> contexts and transactions after errors. + </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default207.xml" parse="text"/></programlisting> + </section> + </section> + <section id="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events"> + <title>Sending and Receiving Events</title> + <para> + The bridge considers a portlet event a model event, which means the event is targeted to the applications data model, not its view. + </para> + <para>Because JSF events primarily concern its view, the bridge processes the portlet events manually. Provisions are made to ensure that any model changes resulting from processing the event are updated in the view. + </para> + <para>Because event payloads are arbitrarily complex however, the manual data processing is left primarily to the portlet application to support. </para> + <section> + <title>Sending Events</title> + <para>The following event configuration references the eventing implemented in the Seam Booking Demo, available for exploration in <filename><replaceable>EPP_HOME</replaceable>/portletbridge/examples/seamEAR.ear</filename>. The concepts described are the same for sending events using other event handlers. </para> + <para>Explicitly specify that the GenericFacesPortlet should override event handling and dispatch all events to the bridge by defining the autoDispatchEvents <init-param> in <filename>portlet.xml</filename>.</para> + <para>If the application is written entirely in JSF (as opposed to a mix of view technologies), this <init-param> must be set to <parameter>true</parameter>.</para> + <programlisting language="XML"><init-param> + <name>javax.portlet.faces.autoDispatchEvents</name> + <value>true</value> +</init-param></programlisting> + <para>Enable the portlet to publish an event to the portal, by defining the <supported-publishing-event> in <filename>portlet.xml</filename>. </para> + <programlisting language="XML"><supported-publishing-event> + <qname xmlns:jbp="urn:jboss:portal:samples:event">jbp:BookingEvent</qname> +</supported-publishing-event></programlisting> + <para>Define how the event namespace (<qname>) is linked to an actual type within the application by defining the <event-definition> directive in <filename>portlet.xml</filename>.</para> + <programlisting language="XML"><event-definition> + <qname xmlns:jbp="urn:jboss:portal:samples:event">jbp:BookingEvent</qname> + <value-type>org.jboss.example.booking.BookingEvent</value-type> +</event-definition></programlisting> + <para>To publish an event, define an event type that represents the actual object that will be attached to the event.</para> + <example> + <title>Event type example</title> + <para>The type requires the @XmlRootElement annotation to allow the event to be serialized into a JAXB object for publishing.</para> + <programlisting language="Java"> +@XmlRootElement +public class BookingEvent implements Serializable { + + private String id; + public static final QName QNAME = new QName("urn:jboss:portal:samples:event", "BookingEvent"); + + public BookingEvent(String id) { + this.id = id; + } + + public String getId() { + return id; + } +}</programlisting> + </example> + <para>To dispatch an event to other portlets within the portal, one approach is to use a bean method triggered by an action.</para> + <example> + <title>Dispatch event example</title> + <programlisting language="Java">Object response = FacesContext.getCurrentInstance().getExternalContext().getResponse(); + if (response instanceof StateAwareResponse) { + String id = "an id"; + StateAwareResponse stateResponse = (StateAwareResponse) response; + stateResponse.setEvent(BookingEvent.QNAME, new BookingEvent(id)); + }</programlisting> + </example> + </section> + <section> + <title>Receiving Events</title> + <para>The following event configuration references the eventing implemented in the Seam Booking Demo, available for exploration in <filename><replaceable>EPP_HOME</replaceable>/portletbridge/examples/seamEAR.ear</filename>. The concepts described are the same for receiving events using other event handlers.</para> + <para>Define that the portlet can receive an event, by specifying bridgeEventHandler as a parameter of an <init-param> directive in <filename>portlet.xml</filename>.</para> + <programlisting language="XML"><init-param> + <name>javax.portlet.faces.bridgeEventHandler</name> + <value>org.jboss.example.booking.BookingEventHandler</value> +</init-param></programlisting> + <para>Define that the portlet can also receive an event from the portal, by specifying a <supported-processing-event> directive in <filename>portal.xml</filename></para> + <programlisting language="XML"><supported-processing-event> + <qname xmlns:jbp="urn:jboss:portal:samples:event">jbp:BookingEvent</qname> +</supported-processing-event></programlisting> + <para>To process a received event within a portlet, specify in the portlet code that the event handler implements the BridgeEventHandler.</para> + <programlisting>public class BookingEventHandler implements BridgeEventHandler { + public EventNavigationResult handleEvent(FacesContext context, Event event) { + // Process event payload as appropriate + } +}</programlisting> + </section> + <section id="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters"> + <title>Public Render Parameters</title> + <para> + Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet 2.0 features. Several portlets (JSF or otherwise) can share the same PRPs. This feature can be used to present a cohesive UI to the user across all portlets on the page. An example would be using an employee ID to display relative data. + </para> + <para> + The bridge automates public render parameter processing. + </para> + <para> + A public render parameter can be mapped to an object's accessor (<literal>get</literal>/<literal>set</literal> method) designed to handle a String representation of the value through a <application>Faces</application> <literal>ValueExpression</literal>. + </para> + <para>Unlike Events, PRPs can only be used to set/get a string value, and not an object.</para> + <para> + When a new public render parameter value is received in a request, the bridge sets the value by calling the <literal>ValueExpression</literal>'s <parameter>setValue()</parameter>. + </para> + <para> + The bridge maps a render parameter to a backing bean using settings in the <filename>faces-config.xml</filename> and <filename>portlet.xml</filename> files. + </para> + <para> + At the end of a request, if the current value of any mapped public render parameter does not match the current incoming value, the bridge sets the new value in an outgoing public render parameter (if feasible in the given phase). + </para> + <section> + <title>PRP portlet configuration</title> + <para>The following PRP portlet configuration references the Seam Booking Demo, available for exploration in <filename><replaceable>EPP_HOME</replaceable>/portletbridge/examples/seamEAR.ear</filename>. The concepts described are the same for receiving PRP events in other implementations.</para> + <para>PRPs must be configured in both the portlet that sends (sets) the PRP, and the portlet that retrieves (gets) the PRP. </para> + <programlisting language="XML"><portlet> + + <supported-public-render-parameter>hotelName</supported-public-render-parameter> +</portlet> + +<public-render-parameter> + <identifier>hotelName</identifier> + <qname xmlns:j="http://jboss.org/params">j:hotelName</qname> +</public-render-parameter></programlisting> + <para>In the portlet that retrieves the PRP, a PRP handler must be specified as an <init-param> directive.</para> + <programlisting language="XML"><init-param> + +<name>javax.portlet.faces.bridgePublicRenderParameterHandler</name> + <value>org.jboss.example.booking.BookingPRPHandler</value> +</init-param></programlisting> + </section> + <section id="sect-Reference_Guide-Public_Render_Parameters-Configuration"> + <title>Application configuration</title> + <para> A public render parameter example is implemented in the Seam Booking Demo portlet, which is located in <filename><filename>EPP_HOME</filename>/portletbridge/SeamEAR.ear</filename>. Continue reading the configuration procedures to understand the configuration steps behind the SeamEAR.ear example. </para> + <section> + <title>Set Parameter</title> + <para>To set the PRP, create a Bean method for the portlet setting the parameter that is triggered from a UI action, and sets the PRP onto the response.</para> + <programlisting language="Java">Object response = FacesContext.getCurrentInstance().getExternalContext().getResponse(); +if (response instanceof StateAwareResponse) { + StateAwareResponse stateResponse = (StateAwareResponse) response; + stateResponse.setRenderParameter("hotelName", "Name of Hotel"); +}</programlisting> + </section> + <section> + <title>Retrieve parameter</title> + <para>The retrieving portlet requires a Bean with a getter/setter for the parameter, to enable Portlet Bridge to set the parameter.</para> + <programlisting language="Java">public class BookingPRP { + private String hotelName; + + public String getHotelName() { + return hotelName; + } + + public void setHotelName(String hotelName) { + this.hotelName = hotelName; + } +}</programlisting> + <para>To set the value on the bean, the Bridge needs to be informed which PRP to retrieve and which Bean to set it on. </para> + <para>If the getter/setter Bean is defined with a EL name of bookingPRP, the following configuration is required in <filename>faces-config.xml</filename>.</para> + <programlisting><application> + <application-extension> + <bridge:public-parameter-mappings> + <bridge:public-parameter-mapping> + <parameter>[bookingMapPortlet]:[hotelName]</parameter> + <model-el>#{bookingPRP.hotelName}</model-el> + </bridge:public-parameter-mapping> + </bridge:public-parameter-mappings> + </application-extension> +</application></programlisting> + <important> + <para>Specifying the portlet name restricts model updates to the specified portlet only. If the portlet name is omitted and only the render parameter specified, every portlet within the web application that supports that render parameter will have its model updated. </para> + </important> + <variablelist> + <varlistentry> + <term>[bookingMapPortlet]</term> + <listitem> + <para>The arbitrary name of the portlet, as set in <filename>portlet.xml</filename></para> + </listitem> + </varlistentry> + <varlistentry> + <term>[hotelName]</term> + <listitem> + <para>The arbitrary name of the render parameter.</para> + </listitem> + </varlistentry> + </variablelist> + <para>The handler specified in the <filename>portlet.xml</filename> requires a bean to process the updates to the model, as a result of the Public Render Parameter.</para> + <programlisting language="Java">public class BookingPRPHandler implements BridgePublicRenderParameterHandler { + public void processUpdates(FacesContext context) { + ELContext elContext = context.getELContext(); + BookingPRPBean bean = (BookingPRPBean) elContext.getELResolver().getValue(elContext, null, "bookingPRP"); + + if(null != bean) { + System.out.println("******processUpdates from BookingPRPHandler: " + bean.getHotelName()); + } + } +}</programlisting> + </section> + </section> + </section> + <section> + <title>Portlet Session</title> + <para>To share data with other portlets within the same portlet application, use name/value pairs within the PortletSession.</para> + <programlisting language="Java"> +Object objSession = FacesContext.getCurrentInstance().getExternalContext().getSession(false); + try { + if (objSession instanceof PortletSession) { + PortletSession portalSession = (PortletSession)objSession; + portalSession.setAttribute("your parameter name", "parameter value", PortletSession.APPLICATION_SCOPE); + } + }</programlisting> + <para>In the JSP or Facelets page, the value string can be retrieved using the following code.</para> + <programlisting> +#{httpSessionScope['your parameter name']}</programlisting> + </section> + </section> + <section> + <title>Resource serving</title> + <para>When using resources from a JSF portlet, it is important to ensure that they are accessed in a way that allows JBoss Portlet Bridge to construct an appropriate Portal URL to the resource being requested.</para> + <para>The correct way to reference a resource is to locate it within the web application, in the <filename>/ resources</filename> directory. This placement allows the resource to be retrieved using JSF2 resource handling.</para> + <programlisting>#{resource['/stylesheet.css']}</programlisting> + <para>In this instance, stylesheet.css would be present in the root of the <filename>/resources</filename> directory, because it does not specify a resource library. For resources that do specify a library, these must be placed in the library sub-directory.</para> + <section id="sect-Reference_Guide-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet"> + <title>Serving Your JSF Resources in a Portlet</title> + <para> + The bridge deals with portlet served resources in one of two ways: + </para> + <itemizedlist> + <listitem> + <para> + If the request is for a non-JSF resource, the bridge handles the request by acquiring a request dispatcher and forwarding the request to the named resource. + </para> + </listitem> + <listitem> + <para> + If the request is for a JSF resource, the bridge runs the full JSF life-cycle ensuring that data is processed and the resource (markup) is rendered. + </para> + </listitem> + </itemizedlist> + <section id="sect-Reference_Guide-Serving_Your_JSF_Resources_in_a_Portlet-Configuration"> + <title>Configuration</title> + <para>Some examples demonstrating how to use <literal>EL</literal> and a simple bean are provided in <filename>EPP_HOME/portletbridge/examples/richFacesPortlet.war//WEB-INF/src/org/richfaces/demo/common/ResourceBean.java</filename> </para> + <para>When you have the normal "<filename>/images</filename>", "<filename>/styles</filename>" and other resource folders in your web application, you can use the following <literal>EL</literal> expression to serve them in your JSF application. + </para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default216.java" parse="text"/></programlisting> + <para>Copy the <literal>ResourceBean.java</literal> code above, and add an entry to the <filename>faces-config.xml</filename> for the bean. + </para> + <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default217.xml" parse="text"/></programlisting> + </section> + </section> + </section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="PortletBridge/portlet_development.xml"/> </chapter> -

11 years, 7 months

1
0
0 / 0

gatein SVN: r8848 - in epp/docs/branches/6.0/Reference_Guide/en-US: modules and 2 other directories.

by do-not-reply＠jboss.org

Author: jaredmorgs Date: 2012-09-16 23:31:58 -0400 (Sun, 16 Sep 2012) New Revision: 8848 Added: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletBridge/ Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml Log: BZ#856417 - Created Portlet Bridge part in the Reference Guide to contain the information. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -5,10 +5,10 @@ ]> <bookinfo id="book-Reference_Guide-Reference_Guide"> <title>Reference Guide</title> - <subtitle>An in-depth guide to Enterprise Portal Platform 5.2, and its patch releases.</subtitle> + <subtitle>An in-depth guide to Enterprise Portal Platform 6.0, and its patch releases.</subtitle> <productname>JBoss Enterprise Portal Platform</productname> - <productnumber>5.2</productnumber> - <edition>5.2.2</edition> + <productnumber>6.0</productnumber> + <edition>6.0.0</edition> <abstract> <para> This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the JBoss Enterprise Portal Platform product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.ent 2012-09-17 03:31:58 UTC (rev 8848) @@ -5,16 +5,16 @@ <!ENTITY BOOKID "Reference Guide">  -<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 5"> +<!ENTITY BZPRODUCT "JBoss Enterprise Portal Platform 6"> <!ENTITY BZCOMPONENT "docs-Reference_Guide"> -<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&percnt;20Enterpri...'>http://bugzilla.redhat.com/</ulink>"> +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&percnt;20Enterpri...'>http://bugzilla.redhat.com/</ulink>">  <!ENTITY YEAR "2012"> <!ENTITY HOLDER "Red Hat, Inc">  -<!ENTITY VX "5"> -<!ENTITY VY "5.2"> -<!ENTITY VZ "5.2.2"> -<!ENTITY WSRP_VERSION "2.1.7-EPP522-GA"> +<!ENTITY VX "6"> +<!ENTITY VY "6.0"> +<!ENTITY VZ "6.0.0"> +<!ENTITY WSRP_VERSION "CHANGEME"> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -9,9 +9,60 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortalDevelopment.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/> + <part> + <title>Authentication and Authorization</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> + </part> + <part> + <title>Portlet Bridge</title> + <chapter> + <title><remark/>Overview</title> + <section> + <title>Portlet Bridge</title> + <para>A portlet bridge allows non-native application frameworks to run in a portal environment, independent to the underlying portlet API, or portlet concept. This functionality provides a developer flexibility to continue writing applications in a preferred language, and allows a controlled transition to new technologies. </para> + </section> + <section> + <title>JBoss Portlet Bridge</title> + <para>The JBoss Portlet Bridge is a non-final draft implementation of the JSR-329 specification which supports the JSF 1.2 and 2.0 runtime within a JSR 168 or 286 portlet and with added enhancements to support other web frameworks (such as Seam and RichFaces). + +The project follows the spec from JSR-301 to JSR-329 and now maintains an alpha version (3.0) compatible with JSF 2.0 and RichFaces 4.0.</para> + </section> + <section> + <title>File Locations</title> + <remark>BZ#856417 - NEEDINFO - Do not have the root configuration directory for Portlet Bridge. Asked Ken in email on 17th Sep.</remark> + <para>Configuration files for Portlet Bridge are located in the <DIRECTORY PATH GOES HERE>.</para> + <para><variablelist> + <varlistentry> + <term>portlet.xml</term> + <listitem> + <para>Contains the primary configuration information for the portlet. Information such as the GenericFacesPortlet location, and which Java Server Faces (JSF) pages to render are stored in this file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>faces-config.xml</term> + <listitem> + <para>Contains</para> + </listitem> + </varlistentry> + <varlistentry> + <term>web.xml</term> + <listitem> + <para/> + </listitem> + </varlistentry> + </variablelist></para> + </section> + </chapter> + <chapter> + <title>Configuration </title> + <section/> + </chapter> + </part> + <part> + <title>Web Services for Remote Portlets (WSRP)</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/> + </part> + <part/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Advanced.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/eXoJCR.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Kernel.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,148 +1,131 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-The_eXo_Kernel"> - <title>The eXo Kernel</title> - <para> - JBoss Enterprise Portal Platform is built as a set of services on top of a dependency injection kernel. The kernel provides configuration, life-cycle handling, component scopes and some core services. - </para> - <para> - The portal kernel and the JCR used in JBoss Enterprise Portal Platform use the <emphasis>Inversion of Control</emphasis> (<emphasis role="bold">IoC</emphasis>) system to control service instantiation. This method is also known as 'dependency injection'. - </para> - <para> - In this system, services are not responsible for the instantiation of the components on which they depend. It prevents objects creating the instances of any objects referenced. This task is delegated to the container. The below image illustrates this: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - <para> - There are two ways to inject a dependency : - </para> - <para> - Using a constructor: - </para> - -<programlisting language="Java" role="Java">public ServiceA(ServiceB serviceB)</programlisting> - <para> - Using setter methods: - </para> - -<programlisting language="Java" role="Java">public void setServiceB(ServiceB serviceB)</programlisting> - <para> - When a client service can not be stored in the container then the service locator pattern is used: - </para> - -<programlisting language="Java" role="Java">public ServiceA(){ + <title>eXo Kernel</title> + <para> + JBoss Enterprise Portal Platform is built as a set of services on top of a dependency injection kernel. The kernel provides configuration, life-cycle handling, component scopes and some core services. + </para> + <para> + The portal kernel and the JCR used in JBoss Enterprise Portal Platform use the <emphasis>Inversion of Control</emphasis> (<emphasis role="bold">IoC</emphasis>) system to control service instantiation. This method is also known as 'dependency injection'. + </para> + <para> + In this system, services are not responsible for the instantiation of the components on which they depend. It prevents objects creating the instances of any objects referenced. This task is delegated to the container. The below image illustrates this: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata width="444" align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="444" align="center" fileref="images/Advanced/Foundations/ioc.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + There are two ways to inject a dependency : + </para> + <para> + Using a constructor: + </para> + <programlisting language="Java" role="Java">public ServiceA(ServiceB serviceB)</programlisting> + <para> + Using setter methods: + </para> + <programlisting language="Java" role="Java">public void setServiceB(ServiceB serviceB)</programlisting> + <para> + When a client service can not be stored in the container then the service locator pattern is used: + </para> + <programlisting language="Java" role="Java">public ServiceA(){ this.serviceB =Container.getSInstance().getService(ServiceB.class); }</programlisting> - <para> - The container package is responsible of building a hierarchy of containers. Each service will then be registered in one container or the other according to the XML configuration file it is defined in. It is important to understand that there can be several PortalContainer instances that all are children of the RootContainer. - </para> - <para> - The behavior of the hierarchy is similar to a class loader one, hence when you will lookup a service that depends on another one, the container will look for it in the current container and if it cannot be found, then it will look in the parent container. That way you can load all the reusable business logic components in the same container (here the RootContainer) and differentiate the service implementation from one portal instance to the other by just loading different service implementations in two sibling PortalContainers. - </para> - <para> - Therefore, if you look at the Portal Container as a service repository for all the business logic in a portal instance, then you understand why several PortalContainers allows you to manage several portals (each one deployed as a single war) in the same server by just changing XML configuration files. - </para> - <para> - The default configuration XML files are packaged in the service jar. There are three configuration.xml files, one for each container type. In that XML file, we define the list of services and their init parameters that will be loaded in the corresponding container. - </para> - <para> - Service components exist in two scopes. The first scope is represented by the <literal>RootContainer</literal>. It contains services that exist independently of any portal, and can be accessed by all portals. - </para> - <para> - The second scope, the <literal>PortalContainer</literal>, is portal-specific. Each portal exists in an instance of the <literal>PortalContainer</literal>. This scope contains services that are common for a set of portals, and services which should not be shared by all portals. - </para> - <itemizedlist> - <listitem> - <para> - RootContainer: This is a base container. This container plays an important role during startup, but you should not use it directly. - </para> + <para> + The container package is responsible of building a hierarchy of containers. Each service will then be registered in one container or the other according to the XML configuration file it is defined in. It is important to understand that there can be several PortalContainer instances that all are children of the RootContainer. + </para> + <para> + The behavior of the hierarchy is similar to a class loader one, hence when you will lookup a service that depends on another one, the container will look for it in the current container and if it cannot be found, then it will look in the parent container. That way you can load all the reusable business logic components in the same container (here the RootContainer) and differentiate the service implementation from one portal instance to the other by just loading different service implementations in two sibling PortalContainers. + </para> + <para> + Therefore, if you look at the Portal Container as a service repository for all the business logic in a portal instance, then you understand why several PortalContainers allows you to manage several portals (each one deployed as a single war) in the same server by just changing XML configuration files. + </para> + <para> + The default configuration XML files are packaged in the service jar. There are three configuration.xml files, one for each container type. In that XML file, we define the list of services and their init parameters that will be loaded in the corresponding container. + </para> + <para> + Service components exist in two scopes. The first scope is represented by the <literal>RootContainer</literal>. It contains services that exist independently of any portal, and can be accessed by all portals. + </para> + <para> + The second scope, the <literal>PortalContainer</literal>, is portal-specific. Each portal exists in an instance of the <literal>PortalContainer</literal>. This scope contains services that are common for a set of portals, and services which should not be shared by all portals. + </para> + <itemizedlist> + <listitem> + <para> + RootContainer: This is a base container. This container plays an important role during startup, but you should not use it directly. + </para> + </listitem> + <listitem> + <para> + PortalContainer: Created at the startup of the portal web application (in the init() method of the PortalController servlet) + </para> + </listitem> + </itemizedlist> + <para> + <mediaobject> + <imageobject role="html"> + <imagedata width="444" align="center" scale="100" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="444" contentwidth="150mm" align="center" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG"/> + </imageobject> + </mediaobject> - </listitem> - <listitem> - <para> - PortalContainer: Created at the startup of the portal web application (in the init() method of the PortalController servlet) - </para> + </para> + <para> + As there can be several portal container instances per JVM. it is important to be able to configure the loaded services per instance. Therefore all the default configuration files located in the service impl jar can be overridden from the portal war. + </para> + <para> + Whenever a specific service is looked up through the <literal>PortalContainer</literal>, and the service is not available, the lookup is delegated further up to the <literal>RootContainer</literal>. + </para> + <para> + JBoss Enterprise Portal Platform can have default instances of a certain component in the <literal>RootContainer</literal>, and portal specific instances in some or all <literal>PortalContainers</literal>, that override the default instance. + </para> + <para> + Whenever your portal application has to be integrated more closely with eXo services, these services can be looked up through the <literal>PortalContainer</literal>. + </para> + <important> + <para> + Only officially documented services should be accessed this way, and used according to documentation, as most of the services are an implementation detail of eXo, and subject to change without notice. + </para> + </important> + <section id="sect-Reference_Guide-The_eXo_Kernel-Kernel_configuration_namespace"> + <title>Kernel configuration namespace</title> + <para> + To be effective, the namespace URI <uri>http://www.exoplaform.org/xml/ns/kernel_1_2.xsd</uri> must be target namespace of the XML configuration file. + </para> + <programlisting language="XML" role="XML"><configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" + xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> - </listitem> - </itemizedlist> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG" scale="100" width="444" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" contentwidth="150mm" fileref="images/Advanced/Foundations/PortalContainers.png" format="PNG" width="444" /> - </imageobject> - - </mediaobject> - - </para> - <para> - As there can be several portal container instances per JVM. it is important to be able to configure the loaded services per instance. Therefore all the default configuration files located in the service impl jar can be overridden from the portal war. - </para> - <para> - Whenever a specific service is looked up through the <literal>PortalContainer</literal>, and the service is not available, the lookup is delegated further up to the <literal>RootContainer</literal>. - </para> - <para> - JBoss Enterprise Portal Platform can have default instances of a certain component in the <literal>RootContainer</literal>, and portal specific instances in some or all <literal>PortalContainers</literal>, that override the default instance. - </para> - <para> - Whenever your portal application has to be integrated more closely with eXo services, these services can be looked up through the <literal>PortalContainer</literal>. - </para> - <important> - <para> - Only officially documented services should be accessed this way, and used according to documentation, as most of the services are an implementation detail of eXo, and subject to change without notice. - </para> - - </important> - <section id="sect-Reference_Guide-The_eXo_Kernel-Kernel_configuration_namespace"> - <title>Kernel configuration namespace</title> - <para> - To be effective, the namespace URI <uri>http://www.exoplaform.org/xml/ns/kernel_1_2.xsd</uri> must be target namespace of the XML configuration file. - </para> - -<programlisting language="XML" role="XML"><configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" - xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> - - ... </configuration></programlisting> - <note> - <para> - Any values in the configuration files can be created thanks to variables since the eXo kernel resolves them, for example the following configuration will be well interpreted: - </para> - -<programlisting language="XML" role="XML"><configuration -xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" -xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" -xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> + <note> + <para> + Any values in the configuration files can be created thanks to variables since the eXo kernel resolves them, for example the following configuration will be well interpreted: + </para> + <programlisting language="XML" role="XML"><configuration +xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" +xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> <import>${db.configuration.path}/db.xml</import> <import>${java.io.tmpdir}/bindfile.xml</import> <import>simple.xml</import> </configuration></programlisting> - <para> - The variables that are supported, are System properties and variables that are specific to your portal container, see next sections for more details. - </para> - - </note> - - </section> - - + <para> + The variables that are supported, are System properties and variables that are specific to your portal container, see next sections for more details. + </para> + </note> + </section> </section> - - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,21 +1,19 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Foundations"> - <title>Foundations</title> - <xi:include href="Foundations/Kernel.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Config_Retrieval.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Advanced_Concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Profiles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Configuring_Services.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Specific_Services.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Configuring_Containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/System_Properties.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Extensions_And_Multiple_Portals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Foundations/Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + <title>The eXo Kernel</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Kernel.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Config_Retrieval.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Advanced_Concepts.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Profiles.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Requests.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Configuring_Services.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Specific_Services.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Configuring_Containers.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/System_Properties.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Extensions_And_Multiple_Portals.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Foundations/Management.xml"/> </chapter> - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,11 +1,9 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> <part id="part-Reference_Guide-Advanced_Development"> - <title>Advanced Development</title> - <xi:include href="Advanced/Foundations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + <title>Advanced Development Foundations</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Advanced/Foundations.xml"/> </part> - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml 2012-09-17 03:18:53 UTC (rev 8847) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml 2012-09-17 03:31:58 UTC (rev 8848) @@ -1,132 +1,45 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> - <part id="part-Reference_Guide-The_Java_Content_Repository_"> - <title>The Java Content Repository</title> -  - <xi:include href="eXoJCR/jcr/intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -  -  - <xi:include href="eXoJCR/jcr/concepts/jcr-exo-implementation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -  -  -  -  -  -  -  -  -  - -  - <xi:include href="eXoJCR/jcr/configuration/exo-jcr-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/multilanguage-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/search-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - -  - - <xi:include href="eXoJCR/jcr/configuration/jdbc-data-container-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/external-value-storages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/workspace-persistence-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/configuration/rest-services-on-groovy.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - -  - <xi:include href="eXoJCR/jcr/cluster-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/jbosscache-configuration-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/lock-manager-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/query-handler-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/jbossts-transaction-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/transaction-manager-lookup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/repository-creation-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - -  - <xi:include href="eXoJCR/jcr/searching/jcr-query-usecases.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/searching/searching-repository-content.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - -  -  - - - -  - <xi:include href="eXoJCR/jcr/protocols/webdav.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/protocols/ftp.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - - -  - <xi:include href="eXoJCR/jcr/backup/exojcr-backup-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/backup/backup-client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/backup/use-external-backup-tool.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - -  - <xi:include href="eXoJCR/jcr/statistics.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <xi:include href="eXoJCR/jcr/repository-check-controller.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - -  - -  - -  - -  - - <xi:include href="eXoJCR/jcr/other/link-producer.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - -  - - <xi:include href="eXoJCR/jcr/other/jcr-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - -  - <xi:include href="eXoJCR/jcr/data-container.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -  - <xi:include href="eXoJCR/jcr/db-cleaner-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - -  - <xi:include href="eXoJCR/jcr/performance-tuning-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - -  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/exo-jcr-configuration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/multilanguage-support.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/search-configuration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/jdbc-data-container-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/external-value-storages.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/workspace-persistence-storage.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/rest-services-on-groovy.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/cluster-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/jbosscache-configuration-templates.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/lock-manager-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/query-handler-config.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/jbossts-transaction-service.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/transaction-manager-lookup.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/repository-creation-service.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/jcr-query-usecases.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/searching-repository-content.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/webdav.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/ftp.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/exojcr-backup-service.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/backup-client.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/use-external-backup-tool.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/statistics.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/repository-check-controller.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/other/link-producer.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/other/jcr-resources.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/data-container.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/db-cleaner-service.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/performance-tuning-guide.xml"/> + - - -  - - -  - <xi:include href="eXoJCR/jcr-with-gatein.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -  -  - </part> \ No newline at end of file + <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr-with-gatein.xml"/> +</part>

11 years, 7 months

1
0
0 / 0

gatein SVN: r8847 - epp/docs/branches/6.0/Draft_CSP_Maps.

by do-not-reply＠jboss.org

Author: smumford Date: 2012-09-16 23:18:53 -0400 (Sun, 16 Sep 2012) New Revision: 8847 Added: epp/docs/branches/6.0/Draft_CSP_Maps/InstallationGuide.contentspec Log: Adding contentspec for Installation Guide Added: epp/docs/branches/6.0/Draft_CSP_Maps/InstallationGuide.contentspec =================================================================== --- epp/docs/branches/6.0/Draft_CSP_Maps/InstallationGuide.contentspec (rev 0) +++ epp/docs/branches/6.0/Draft_CSP_Maps/InstallationGuide.contentspec 2012-09-17 03:18:53 UTC (rev 8847) @@ -0,0 +1,66 @@ +Title = Installation Guide +Brand = JBoss +Product = JBoss Enterprise Portal Platform +Version = 6 +Edition = 6.0.0 +Subtitle = for use with JBoss Enterprise Portal Platform 6, and its patch releases. +Pubsnumber = 1 +DTD = Docbook 4.5 +Output Style = Narrative +Copyright Holder = Red Hat, Inc +Survey Links = OFF + + +Chapter: Introducing JBoss EPP + Overview [N, Concept] + New and Changed Features [N, Reference] + +Chapter: Downloading + Downloading EPP [N, Task] + Available Downloads for EPP [N, Reference] + About the Red Hat Customer Portal [254] + +Chapter: Installation + Installation Pre-requisites for EPP [N, Reference] + Java Environments [N, Reference] + Installing OpenJDK on RHEL [301] + Installing EPP using the ZIP Download [252] + Installation Structure and Details [3371] + Running EPP as an Operating System Service [4513] + Installing EPP as a Service in RHEL [3758] + Installing EPP as a Service in Windows [3757] + Add the initial User for Management Interfaces [5750] + Start EPP as a Managed Domain [43] + Start EPP as a Standalone Server [42] + Start EPP as an Operating System Service [4513] + Test the Installation [N, Task] + +Chapter: Getting Started + Network Ports used by EPP [5377] + Configure Network Firewalls to work with EPP [4705] + Default User Security Configuration [5751] + Uninstall EPP from a Zip Installation [4546] # This seems like an odd place for uninstallation instructions + Choose a Server Profile [N, Concept] # Would this be a task? It has a verb in the title. + Adjust Memory Settings [N, Task] + Disable Pre-configured Accounts [N, Task] + +Chapter: Configuration + Database Configuration [N, Concept] + Provision JCR and IDM Databases [N, Task] + Configure the JCR Database Datasource [N, Task] + Configure the IDM Database Datasource [N, Task] + Configure Multiple JCR Database Datasources [N, Task] + Configure Multiple IDM Database Datasources [N, Task] + MySQL Server 5.1 JCR and IDM Example [N, Quickstart] + JBoss Operations Network Installation [N, Task] + Email Service Configuration Service [N, Concept] + Configure Outgoing Email Account [N, Task] + Clustering Configuration [N, Task] + HTTPS Configuration [N, Task] + Enable HTTPS Communication [N, Task] + Specify White-list and Black-list Gadget Proxy Resources [N, Task] + Validator Configuration [N, Reference] + JBoss Operations Network Plug-in [N, Concept] + Plug-in Metrics [N, Reference] + Plug-in Operation [N, Reference] + \ No newline at end of file

11 years, 7 months

1
0
0 / 0

gatein SVN: r8846 - in epp/docs/tags/EPP_5_2_2_GA/Reference_Guide: en-US and 1 other directory.

by do-not-reply＠jboss.org

Author: jaredmorgs Date: 2012-09-16 19:48:55 -0400 (Sun, 16 Sep 2012) New Revision: 8846 Modified: epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Reference_Guide.xml epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Revision_History.xml epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/publican.cfg Log: removed Remarks from document, which were erroneously tagged live Modified: epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Reference_Guide.xml 2012-09-07 04:41:40 UTC (rev 8845) +++ epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Reference_Guide.xml 2012-09-16 23:48:55 UTC (rev 8846) @@ -9,8 +9,7 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortalDevelopment.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/> - - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Advanced.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/eXoJCR.xml"/> Modified: epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Revision_History.xml 2012-09-07 04:41:40 UTC (rev 8845) +++ epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/en-US/Revision_History.xml 2012-09-16 23:48:55 UTC (rev 8846) @@ -8,6 +8,20 @@ <simpara> <revhistory> <revision> + <revnumber>5.2.2-101</revnumber> + <date>Mon Sep 17 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Minor asynchronous corrections related to 5.2.2. GA release.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>5.2.2-100</revnumber> <date>Wed Sep 05 2012</date> <author> Modified: epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/publican.cfg =================================================================== --- epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/publican.cfg 2012-09-07 04:41:40 UTC (rev 8845) +++ epp/docs/tags/EPP_5_2_2_GA/Reference_Guide/publican.cfg 2012-09-16 23:48:55 UTC (rev 8846) @@ -3,7 +3,7 @@ debug: 1 type: Book git_branch: docs-rhel-6 -show_remarks: 1 +#show_remarks: 1 # web formats turns of PDF generation, because FOP is causing builds to die. Stupid FOP. Enable when Publican 3 is released # web_formats: "epub,html,html-single"

11 years, 7 months

1
0
0 / 0

gatein SVN: r8845 - epp/docs/branches/6.0/Release_Notes/en-US.

by do-not-reply＠jboss.org

Author: jaredmorgs Date: 2012-09-07 00:41:40 -0400 (Fri, 07 Sep 2012) New Revision: 8845 Modified: epp/docs/branches/6.0/Release_Notes/en-US/5.2.2_Release_Notes.xml epp/docs/branches/6.0/Release_Notes/en-US/Book_Info.xml epp/docs/branches/6.0/Release_Notes/en-US/known.xml epp/docs/branches/6.0/Release_Notes/en-US/needinfo.xml epp/docs/branches/6.0/Release_Notes/en-US/resolved.xml Log: Updated RN to meet new BZ format requirements Modified: epp/docs/branches/6.0/Release_Notes/en-US/5.2.2_Release_Notes.xml =================================================================== --- epp/docs/branches/6.0/Release_Notes/en-US/5.2.2_Release_Notes.xml 2012-09-06 03:02:30 UTC (rev 8844) +++ epp/docs/branches/6.0/Release_Notes/en-US/5.2.2_Release_Notes.xml 2012-09-07 04:41:40 UTC (rev 8845) @@ -14,44 +14,43 @@ <para>By integrating open source frameworks such as JBoss Seam, Hibernate, Tomcat, and JBoss Cache, JBoss Enterprise Portal Platform takes advantage of innovations in the open source community. </para> <para>JBoss Enterprise Portal Platform &VZ; is fully tested and supported by Red Hat, and is certified to work on many leading enterprise hardware and software products.</para> </chapter> - <chapter id="Site_Publisher_Introduction"> - <title>What is Site Publisher</title> - <para> + <chapter id="Release_Notes-Installation"> <title>Installation</title> <para> The JBoss Enterprise Portal Platform <citetitle>Installation Guide</citetitle> contains detailed installation instructions as well as environment requirements. @@ -260,22 +259,20 @@ </formalpara> </chapter> </part> - <part> - <title>Enterprise Portal Platform</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="known.xml" encoding="XML"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="resolved.xml"/> - </part> - <part> - <title>Site Publisher plug-in</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sp_known.xml" encoding="XML"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sp_resolved.xml" encoding="XML"/> - </part> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="known.xml" encoding="XML"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="resolved.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="enhancement.xml" encoding="XML"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> Modified: epp/docs/branches/6.0/Release_Notes/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/6.0/Release_Notes/en-US/Book_Info.xml 2012-09-06 03:02:30 UTC (rev 8844) +++ epp/docs/branches/6.0/Release_Notes/en-US/Book_Info.xml 2012-09-07 04:41:40 UTC (rev 8845) @@ -2,8 +2,8 @@ <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> <bookinfo id="arti-Release_Notes-Release_Notes"> - <title>5.2.2 Release Notes</title> - <subtitle>For use with JBoss Enterprise Portal Platform &VZ;, and the Site Publisher plug-in.</subtitle> + <title>6.0 Release Notes</title> + <subtitle>For use with JBoss Enterprise Portal Platform &VZ;.</subtitle> <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.2</edition> Modified: epp/docs/branches/6.0/Release_Notes/en-US/known.xml =================================================================== --- epp/docs/branches/6.0/Release_Notes/en-US/known.xml 2012-09-06 03:02:30 UTC (rev 8844) +++ epp/docs/branches/6.0/Release_Notes/en-US/known.xml 2012-09-07 04:41:40 UTC (rev 8845) @@ -1,29 +1,6 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -]> -<chapter id="known_issues"> - <title>Known issues</title> - <para> - The following issues are known to exist in this release of JBoss Enterprise Portal Platform, and will be fixed in a subsequent release. - </para> - <variablelist> - <varlistentry> - <term> - <ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=793816">BZ#793816</ulink> - </term> - <listitem> - <para>The platform did not support JTA in previous releases. There were some problems related to it, particularly the fact that without JTA support, there was a need to obtain DB connection for IDM database for each HTTP request of logged user. In some environments, this requirement may cause problems related to a lack of DB connections and introduce performance issues. To work around the issue, it is possible to configure the platform for JTA support. Configuring JTA support may reduce the number of DB connections opened against an IDM database. JTA is disabled by default. To enable JTA support, follow the procedure in <ulink url="https://community.jboss.org/wiki/JTAIntegrationWithGateIn"/>, while observing the following caveats to the procedure: replace "gatein-idm" and "gatein-jcr" with "jdbcidm" and "jdbcjcr" respectively; step 2 (JCR configuration of DataSourceProvider) is not needed because it is enabled by default in t! he platform.</para> - </listitem> - </varlistentry> - </variablelist> +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd []> +<chapter id="known"> +<title>Known Issues</title> +<para>There are no Known issues in this release.</para> </chapter> Modified: epp/docs/branches/6.0/Release_Notes/en-US/needinfo.xml =================================================================== --- epp/docs/branches/6.0/Release_Notes/en-US/needinfo.xml 2012-09-06 03:02:30 UTC (rev 8844) +++ epp/docs/branches/6.0/Release_Notes/en-US/needinfo.xml 2012-09-07 04:41:40 UTC (rev 8845) @@ -1,10 +1,19 @@ -<?xml version='1.0' encoding='UTF-8'?> +<?xml version='1.0'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> -<chapter id="needinfo_issues"> - <title>NEEDINFO</title> - <para> + +<chapter id = "needinfo_issues"> + <title>NEEDINFO</title> + + <para> The following issues require more information from developers, or need to be processed by the lead writer before they can be approved for Release Note inclusion. </para> - <remark> These tickets will not be included in Release Notes as they currently stand. This could be because the tickets have not been docs Ack'd (still at release_note?) or the tickets have not been set to the correct resolution status (VERIFIED, CLOSED). </remark> + <remark> + These tickets will not be included in Release Notes as they currently stand. + This could be because the tickets have not been processed by the docs lead (still at required_doc_text?), + or the tickets have not been set to the correct resolution status (VERIFIED, CLOSED). + </remark> + <variablelist> + + </variablelist> </chapter> Modified: epp/docs/branches/6.0/Release_Notes/en-US/resolved.xml =================================================================== --- epp/docs/branches/6.0/Release_Notes/en-US/resolved.xml 2012-09-06 03:02:30 UTC (rev 8844) +++ epp/docs/branches/6.0/Release_Notes/en-US/resolved.xml 2012-09-07 04:41:40 UTC (rev 8845) @@ -1,314 +1,6 @@ -<?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -]> +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd []> <chapter id="resolved"> - <title>Resolved issues</title> - <para> - The following issues have been resolved in this release of JBoss Enterprise Portal Platform. - </para> - <variablelist> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=793425"> - <citetitle>BZ#793425</citetitle> - </ulink> - Creating user with user name differing only in case-sensitive case pop-ups unknown error</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - Picketlink IDM was performing case-sensitive comparison of user and group names with information stored in OpenDS. Because OpenDS does not record user and group names in a case-sensitive manner by default, cased user names such as "viLiam" were not distinguishable from the user name "viliam". This issue affected search retrieval, as well as user and group creation. The issue can be fixed by configuring Picketlink IDM to compare user and group names in a case-insensitive way. In picketlink-idm-config.xml, change the LDAPIdentityStore option "allowNotCaseSensitiveSearch" to true. Setting this option will prevent any Picketlink IDM exceptions relating to case insensitivity. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=794403"> - <citetitle>BZ#794403</citetitle> - </ulink> - Example skin looks scattered on the right side</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - An issue with the width of .UIWorkingWorkspace .UIPageBody set in the default skin was not suitable for SimpleSkin distributed with the Application Server. The incompatibility caused the right border of #UIPageBody to shift left and be hidden under the JBoss Enterprise Portal Platform banner. The fix introduces an override to the element causing the border shift, with a specific alignment rule that sets the width to auto. The border of #UIPageBody is now rendered properly, aligned with the breadcrumbs panel above it. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=795937"> - <citetitle>BZ#795937</citetitle> - </ulink> - Add SCP Documentation to Administration Guide for GateIn Management</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - Secure Copy documentation was missing from the Administration Guide. The SCP information is now present in the Administration Guide for Management Extensions and Command Line Interface chapters. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=798801"> - <citetitle>BZ#798801</citetitle> - </ulink> - Fix the sample portal data-source file.</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that the gatein-sample-portal-ds.xml file shipped with the application server was out of sync with the gatein-ds.xml file. Customers that used the sample portal data-source file experienced issues when the file was deployed together with gatein-sample-portal.ear. Errors were logged to the application server's log, and the sample portal would not correctly start. The fix re-bases gatein-sample-portal-ds.xml in line with gatein-ds.xml with the following fixes: The IDM database configuration is declared before JCR; The Hypersonic data file location is now specified under the gatein /conf directory; and the IDM datastore was changed from local-tx-datasource to no-tx-datasource. When gatein-sample-portal-ds.xml is deployed with gatein-sample-portal.ear, the sample portal starts, and can be visited using http://localhost:8080/sample-portal. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=803776"> - <citetitle>BZ#803776</citetitle> - </ulink> - Disable exposure of JMX stats for anonymous caches</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that exposing information for anonymous caches using JMX resulted in too much information being exposed. The configuration has been changed to ensure JMX stats for anonymous caches display the correct information. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=807012"> - <citetitle>BZ#807012</citetitle> - </ulink> - Remove possibly unused JARs from gatein.ear/lib</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that the gatein.ear archive contained JAR files that were not required in the enterprise version of the product. The fix removes the unnecessary JAR files. JAR files applicable to both community and enterprise builds are retained for platform stability. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=807279"> - <citetitle>BZ#807279</citetitle> - </ulink> - Support WSRP applications for Export/Import</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - When WSRP is added to a page, and a user attempts to export the page using the portal management functions, an exception displays stating WSRP is not supported. This issue is being investigated, and will be included in a future release of the portal. There is no workaround to this issue. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=809141"> - <citetitle>BZ#809141</citetitle> - </ulink> - Sample extension datasource uses local-tx-datasource type</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that the sample datasource file for portal extensions -<filename>jboss-as/docs/examples/portal/gatein-sample-portal-ds.xml</filename> specifies the incorrect datasource type for IDM. It should be no-tx-datasource for IDM and -local-tx-datasource for JCR, instead of local-tx-datasource for both directive blocks. To work around the issue, define the datasource type manually, following the guidelines in this Release Note. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=809777"> - <citetitle>BZ#809777</citetitle> - </ulink> - Improvement for the error handling of JCR index build error or node corruption</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that if the JCR index is broken, JCR stops. This caused a JCR index build error or node corruption during portal and Site Publisher start-up. The fix includes upgrades to the JCR which allows the portal to start correctly and log the data corruption, rather instead of failing to start. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=812657"> - <citetitle>BZ#812657</citetitle> - </ulink> - error when add new group the same with existing but different with lower and upper case on MySQL</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - Picketlink IDM was performing case-sensitive comparison of group names with information stored in MySQL DB. Because MySQL DB does not record group names in a case-sensitive manner by default, cased group names such as "TEST_group" were not distinguishable from the group name "test_group". This issue affected search retrieval, as well as group creation. The issue can be fixed by configuring Picketlink IDM to compare group names in case-insensitive way. In picketlink-idm-config.xml, change the HibernateIdentityStore option "allowNotCaseSensitiveSearch" to true. Setting this option will prevent any Picketlink IDM exceptions relating to case insensitivity. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=813388"> - <citetitle>BZ#813388</citetitle> - </ulink> - Special characters in a text file content is not correctly encoded after uploading.</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - An issue with the view template for text files was not displaying special characters correctly in files that were uploaded. After uploading a text file which contained "ááááá ã ã ã óóóó", displaying the text file content in ContentExplorer would reveal the following: "ááááá ã ã ã óóóó". The issue was not present in the ContentExplorer WYSIWYG editor. The fix introduces improvements to ContentExplorer that removes the double-encoding, which results in special characters being displayed correctly. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=813729"> - <citetitle>BZ#813729</citetitle> - </ulink> - EPP configuration files use multiple version of kernel XSD definition</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that several versions of kernel_1_*.xsd were referenced in XML configuration files. While no harmful consequences existed by having these obsolete templates declared, it made the XML files appear inconsistent. The fix removes all kernel_1_[^2].xsd, and replaces these references with kernel_1_2.xsd which makes the XML configuration files consistent. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=813751"> - <citetitle>BZ#813751</citetitle> - </ulink> - Portlet Bridge - NPE when loading styles via link element</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - Documentation quoted that the <link> element could be used to import Rich Faces XCSS scripts and style-sheets using the following syntax:</para> - <programlisting><link type="text/css" rel="stylesheet" href="/richFacesPortlet/faces/rfRes/org/richfaces/skin.xcss"/></programlisting> - <para>This syntax is no longer correct, and results in a NPE. To correct the issue, use a4j:loadstyle to import the scripts and style-sheets when using LoadStyleStrategy and LoadScriptStrategy of NONE:</para> - <programlisting><a4j:loadScript src="resource:////org/ajax4jsf/framework.pack.js" type="text/javascript"/> - <a4j:loadScript src="resource:////org/richfaces/ui.pack.js" type="text/javascript"/> - <a4j:loadStyle src="resource:////org/richfaces/skin.xcss"/></programlisting> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=818565"> - <citetitle>BZ#818565</citetitle> - </ulink> - Portal container name is hard-coded in the LocalizationFilter</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - A hard-coded portal container name in the LocalizationFilter caused a NPE (NULL container) if the default context path was changed. The fix introduces changes to the way the portal container name is parsed by the LocalizationFilter, which corrects the issue. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=824855"> - <citetitle>BZ#824855</citetitle> - </ulink> - Strange duplicated requests in gadget rendering</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that certain gadgets on the dashboard were sending more requests then necessary. The unnecessary requests caused a performance impact on page loading times. The fix implements changes to how gadgets are rendered. Each gadget is rendered individually, and only loads necessary data which fixes the performance issue. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=824860"> - <citetitle>BZ#824860</citetitle> - </ulink> - Error while rendering doodle gadget when source is dead</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - When the Doodle gadget was added to a dashboard, and the source website supplying the gadget metadata was unavailable, the gadget was not loaded, and a user interface error occurred. The fix introduces a more informative error message to all gadgets that require external sources, which displays in the user interface at the time the error occurs. This helps the user diagnose the problem easier, and fixes the issue. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=824863"> - <citetitle>BZ#824863</citetitle> - </ulink> - groovy template should not print "null" string when variable is null</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - If a GateIn Template file (*.gtmpl) contained an <input> directive that declared a variable as a value, and that variable resolved to null, the word "null" would be substituted for the value instead of the value parameter being present, but undefined. For example, <input class="key" type="text" name="key" value="${key}"/> resolved to <input class="key" type="text" name="key" value="null"/>, instead of <input class="key" type="text" name="key" value/>. The fix corrects the way null values are handled, and now prints undefined parameters, instead of printing null as the parameter value. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=824907"> - <citetitle>BZ#824907</citetitle> - </ulink> - Add ability to deactivate URL rewriting on WSRP producer</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - In the current WSRP implementation, the producer URL is rewritten at consumer side so it can be accessed remotely. -If users have static content at both the producer and consumer sides, they do not expect those resources to be accessed from a remote producer. In these circumstances, it was desirable to disable URL rewriting, however no such mechanism existed. The fix includes enhancements to the WSRP, with the addition of the "org.gatein.wsrp.producer.deactivateURLRewriting". If the parameter is set to true, URL rewriting is disabled. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=829885"> - <citetitle>BZ#829885</citetitle> - </ulink> - X.509 token in ws-security support in WSRP</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - It was discovered that JBossWS supports X.509 token with WSSE, however the functionality only partially worked. It was not possible to encrypt the entire message. The fix introduces improvements to this aspect of JBossWS in WSRP, and corrects the issue. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=831445"> - <citetitle>BZ#831445</citetitle> - </ulink> - WSRP is failing when including OASIS WSRP WSDL</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - OASIS changed the way HTTP WSRP WSDL requests were redirected. The requests redirected to a HTTP 302 response that included an XML document with a public ID, but no system ID. This caused an exception "SAXParseException: White spaces are required between publicId and systemId" to be raised. -The fix introduces changes to the JBossWS entity resolver, which now uses the WSDLs and XSDs placed in the unzipped folder instead of the ones from the OASIS website. -This corrects the issue, and restores expected functionality to Netunity v1 & v2. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=832089"> - <citetitle>BZ#832089</citetitle> - </ulink> - WSRP: getPortletProperties doesn't behave properly when en empty set of property names is passed</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - A problem detected with reading preferences from WLP 10.0.1 through a WSRP V1 endpoint caused the portlet properties to raise a NPE as a result of the interaction. This issue has been fixed in the affected WSRP component, and the component updated for this release. Reading the portlet properties via WSRP V1 now works as expected. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=835369"> - <citetitle>BZ#835369</citetitle> - </ulink> - WSRP: The supportedOptions element in the producers response to a getServiceDescription request is missing the supported features</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - The WSRP Producer was ignoring several optional elements when returning a service description response to the consumer, including the supportedOptions element. WSRP Consumers that were relying on these optional elements to tailor their communication with the producer could behave improperly based on wrong assumptions due to missing (though optional) information. The WSRP Producer now properly emits the supportedOptions element in its service description response, which allows Consumers to properly tailor their behavior, and results in improved interoperability with third-party consumers. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=835375"> - <citetitle>BZ#835375</citetitle> - </ulink> - Patch to enhance WSRP producers response to a getServiceDescription request</term> - <listitem> - <remark>Status: CLOSED</remark> - <para> - A number of issues were discovered: 1) WSRP: getPortletProperties doesn't behave properly when en empty set of property names is passed; 2) WSRP type factories require a lang value to create a Property even though it's optional according to XSD. This caused the requests to be rejected by the server with an IllegalArgumentException: 'Property requires a non-null, non-empty language. The fix applies a patch to the affected files which corrects the issue. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=835578"> - <citetitle>BZ#835578</citetitle> - </ulink> - Open an "Identity Transaction" only when it is necessary</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - Hibernate transactions had to be started for each HTTP request from an anonymous or authenticated user, which in turn required a new database connection from the connection pool (an expensive operation if it is not required for the request). The fix enables a new option, "lazyStartOfHibernateTransaction", which is set in gatein.ear/02portal.war/WEB-INF/conf/organization/picketlink-idm/picketlink-idm-config.xml. -</para> - <programlisting> -<option> - <name>lazyStartOfHibernateTransaction</name> - <value>false</value> - </option> -</programlisting> - <para>If the value is set to true, the Hibernate transaction is started only when required, and not for every request. The default value is false for backwards-compatibility. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=837029"> - <citetitle>BZ#837029</citetitle> - </ulink> - Change of JBC configuration - LRU algorithm + separate configuration for portal-system workspace</term> - <listitem> - <remark>Status: VERIFIED</remark> - <para> - A change made to the JBoss Cache cache algorithm caused performance issues for some configuration scenarios. The fix introduces configuration with an improved algorithm. The new algorithm references a new configuration file, which now loads correctly. This corrects the performance issues. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="https://bugzilla.redhat.com/show_bug.cgi?id=838973"> - <citetitle>BZ#838973</citetitle> - </ulink> - Dashboard pages with special characters</term> - <listitem> - <remark>Status: CLOSED</remark> - <para> - A change to how dashboard page names were validated in another issue caused dashboard page names containing special characters to no longer be considered as invalid. If a dashboard name contains a special character, it is now replaced with an underscore in the URL. This new functionality will be added to the Dashboard Portlet section of the User Guide in a future release. - </para> - </listitem> - </varlistentry> - </variablelist> +<title>Resolved Issues</title> +<para>There are no Resolved Issues in this release.</para> </chapter>

11 years, 7 months

1
0
0 / 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

gatein-commits September 2012