Author: smumford Date: 2010-07-13 21:46:03 -0400 (Tue, 13 Jul 2010) New Revision: 13959 Added: docs/enterprise/trunk/PortletBridge/publican.cfg Removed: docs/enterprise/trunk/PortletBridge/Makefile Modified: docs/enterprise/trunk/PortletBridge/en-US/Author_Group.xml docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml docs/enterprise/trunk/PortletBridge/en-US/Configuration.xml docs/enterprise/trunk/PortletBridge/en-US/Feedback.xml docs/enterprise/trunk/PortletBridge/en-US/Getting_Started.xml docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.ent docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.xml docs/enterprise/trunk/PortletBridge/en-US/Overview.xml docs/enterprise/trunk/PortletBridge/en-US/Portlet_Development.xml docs/enterprise/trunk/PortletBridge/en-US/Preface.xml docs/enterprise/trunk/PortletBridge/en-US/Revision_History.xml Log: JBEPP-376: Updated for 4.3 CP05 Release Deleted: docs/enterprise/trunk/PortletBridge/Makefile =================================================================== --- docs/enterprise/trunk/PortletBridge/Makefile 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/Makefile 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,13 +0,0 @@ -#Makefile for portletOverview - -XML_LANG = en-US -BRAND = JBoss - -#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW -OTHER_LANGS = ja-JP -# Extra Parameters start here - -# Extra Parameters stop here -COMMON_CONFIG = /usr/share/publican -include $(COMMON_CONFIG)/make/Makefile.common - Modified: docs/enterprise/trunk/PortletBridge/en-US/Author_Group.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Author_Group.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Author_Group.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,11 +1,11 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <authorgroup> <author> <firstname>Red Hat</firstname> - <surname></surname> + <surname></surname> + </author> </authorgroup> Modified: docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Book_Info.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,36 +1,38 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> +<bookinfo id="book-Overview-Overview"> + <title>JBoss Portlet Bridge Overview</title> + <subtitle>For use with JBoss Enterprise Portal Platform 4.3</subtitle> + <productname>JBoss Portlet Bridge</productname> + <productnumber>6</productnumber> + <edition>1.0</edition> + <pubsnumber>5</pubsnumber> + <pubdate>Jul, 2010</pubdate> + <abstract> + <para> + The JBoss Portlet Bridge is an implementation of the JSR-301 specification to support JSF within a portlet and with added enhancements to support other web frameworks. Currently the bridge supports any combination of JSF, Seam, and RichFaces to run inside a portlet. + </para> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" /> + </imageobject> + <textobject> + <phrase>Logo</phrase> + </textobject> -<bookinfo id="book-JBoss_Portlet_Bridge_Overview-JBoss_Portlet_Bridge_Overview"> - <title>Overview</title> - <subtitle>For use with JBoss Enterprise Portal Platform 4.3 </subtitle> - <productname>JBoss Portlet Bridge Beta</productname> - <productnumber>6</productnumber> - <edition>1.0</edition> - <pubsnumber>5</pubsnumber> - <pubdate>Jan, 2009</pubdate> - <abstract> - <para>The JBoss Portlet Bridge is an implementation of the JSR-301 -specification to support JSF within a portlet and with added -enhancements to support other web frameworks. Currently the bridge -supports any combination of JSF, Seam, and RichFaces to run inside -a portlet.</para></abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" /> - </imageobject> - <textobject> - <phrase>Logo</phrase> - </textobject> - </inlinemediaobject> - </corpauthor> - <copyright> - <year>&YEAR;</year> - <holder>&HOLDER;</holder> - </copyright> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - </bookinfo> - + </inlinemediaobject> + + </corpauthor> + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + + </copyright> + <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</bookinfo> + Modified: docs/enterprise/trunk/PortletBridge/en-US/Configuration.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Configuration.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Configuration.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,277 +1,296 @@ <?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="chap-JBoss_Portlet_Bridge_Overview-Bridge_Configuration"> +<chapter id="chap-Overview-Bridge_Configuration"> <title>Bridge Configuration</title> - <para> + <para> The 301 specification is aimed at making the developer&#39;s life as easy as possible when developing with JSF+Portlet. 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-JBoss_Portlet_Bridge_Overview-Bridge_Configuration-Core_Setup_and_Configuration"> + <section id="sect-Overview-Bridge_Configuration-Core_Setup_and_Configuration"> <title>Core Setup and Configuration</title> - <section id="sect-JBoss_Portlet_Bridge_Overview-Core_Setup_and_Configuration-portlet.xml"> + <section id="sect-Overview-Core_Setup_and_Configuration-portlet.xml"> <title>portlet.xml</title> - <para> + <para> The basic JSR-301 portlet configuration. </para> - + <programlisting role="XML"> - &lt;portlet&gt; - &lt;portlet-name&gt;yourPortletName&lt;/portlet-name&gt; - &lt;portlet-class&gt; + &#60;portlet&#62; + &#60;portlet-name&#62;yourPortletName&#60;/portlet-name&#62; + &#60;portlet-class&#62; javax.portlet.faces.GenericFacesPortlet - &lt;/portlet-class&gt; + &#60;/portlet-class&#62; - &lt;init-param&gt; - &lt;name&gt;javax.portlet.faces.defaultViewId.view&lt;/name&gt; - &lt;value&gt;/welcome.xhtml&lt;/value&gt; - &lt;/init-param&gt; + &#60;init-param&#62; + &#60;name&#62;javax.portlet.faces.defaultViewId.view&#60;/name&#62; + &#60;value&#62;/welcome.xhtml&#60;/value&#62; + &#60;/init-param&#62; - &lt;init-param&gt; - &lt;name&gt;javax.portlet.faces.defaultViewId.edit&lt;/name&gt; - &lt;value&gt;/jsf/edit.xhtml&lt;/value&gt; - &lt;/init-param&gt; + &#60;init-param&#62; + &#60;name&#62;javax.portlet.faces.defaultViewId.edit&#60;/name&#62; + &#60;value&#62;/jsf/edit.xhtml&#60;/value&#62; + &#60;/init-param&#62; - &lt;init-param&gt; - &lt;name&gt;javax.portlet.faces.defaultViewId.help&lt;/name&gt; - &lt;value&gt;/jsf/help.xhtml&lt;/value&gt; - &lt;/init-param&gt; + &#60;init-param&#62; + &#60;name&#62;javax.portlet.faces.defaultViewId.help&#60;/name&#62; + &#60;value&#62;/jsf/help.xhtml&#60;/value&#62; + &#60;/init-param&#62; </programlisting> - <para> - When preserveActionParams is set to TRUE, the bridge must maintain any request parameters assigned during the portlet&#39;s action request. The request parameters are maintained in the<emphasis role="italics">"bridge request scope"</emphasis>. When this attribute is not present or is FALSE the action&#39;s request parameters are only maintained for the duration of the <emphasis role="italics">portlet request scope</emphasis>. + <para> + When preserveActionParams is set to TRUE, the bridge must maintain any request parameters assigned during the portlet&#39;s action request. The request parameters are maintained in the<emphasis role="italics">&#34;bridge request scope&#34;</emphasis>. When this attribute is not present or is FALSE the action&#39;s request parameters are only maintained for the duration of the <emphasis role="italics">portlet request scope</emphasis>. </para> - + <programlisting role="XML"> - &lt;init-param&gt; - &lt;name&gt;javax.portlet.faces.preserveActionParams&lt;/name&gt; - &lt;value&gt;true&lt;/value&gt; - &lt;/init-param&gt; + &#60;init-param&#62; + &#60;name&#62;javax.portlet.faces.preserveActionParams&#60;/name&#62; + &#60;value&#62;true&#60;/value&#62; + &#60;/init-param&#62; </programlisting> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Core_Setup_and_Configuration-faces_config.xml"> + <section id="sect-Overview-Core_Setup_and_Configuration-faces_config.xml"> <title>faces-config.xml</title> - <para> + <para> The PortletViewHandler ensures that each JSF portlet instance is porperly namespaced. </para> - + <programlisting role="XML"> - &lt;faces-config&gt; - &lt;application&gt; - &lt;view-handler&gt; + &#60;faces-config&#62; + &#60;application&#62; + &#60;view-handler&#62; org.jboss.portletbridge.application.PortletViewHandler - &lt;/view-handler&gt; - &lt;state-manager&gt;org.jboss.portletbridge.application.PortletStateManager&lt;/state-manager&gt; - &lt;/application&gt; + &#60;/view-handler&#62; + &#60;state-manager&#62;org.jboss.portletbridge.application.PortletStateManager&#60;/state-manager&#62; + &#60;/application&#62; ... </programlisting> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Core_Setup_and_Configuration-Facelets_Configuration"> + <section id="sect-Overview-Core_Setup_and_Configuration-Facelets_Configuration"> <title>Facelets Configuration</title> - <para> + <para> The following web.xml setting is only for Facelets based applications </para> - <section id="sect-JBoss_Portlet_Bridge_Overview-Facelets_Configuration-web.xml"> + <section id="sect-Overview-Facelets_Configuration-web.xml"> <title>web.xml</title> - + <programlisting role="XML"> - &lt;web-app xmlns="http://java.sun.com/xml/ns/j2ee" - 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"&gt; + &#60;web-app xmlns=&#34;http://java.sun.com/xml/ns/j2ee&#34; + xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; + xsi:schemaLocation=&#34;http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd&#34; + version=&#34;2.4&#34;&#62; ... - &lt;!-- This is optional parameters for a facelets based application --&gt; - &lt;context-param&gt; - &lt;param-name&gt;org.ajax4jsf.VIEW_HANDLERS&lt;/param-name&gt; - &lt;param-value&gt;org.jboss.portletbridge.application.FaceletPortletViewHandler&lt;/param-value&gt; - &lt;/context-param&gt; + &#60;!-- This is optional parameters for a facelets based application --&#62; + &#60;context-param&#62; + &#60;param-name&#62;org.ajax4jsf.VIEW_HANDLERS&#60;/param-name&#62; + &#60;param-value&#62;org.jboss.portletbridge.application.FaceletPortletViewHandler&#60;/param-value&#62; + &#60;/context-param&#62; </programlisting> - + <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;javax.portlet.faces.renderPolicy&lt;/param-name&gt; - &lt;param-value&gt; + &#60;context-param&#62; + &#60;param-name&#62;javax.portlet.faces.renderPolicy&#60;/param-name&#62; + &#60;param-value&#62; ALWAYS_DELEGATE - &lt;/param-value&gt; - &lt;/context-param&gt; + &#60;/param-value&#62; + &#60;/context-param&#62; ... - &lt;/web-app&gt; + &#60;/web-app&#62; </programlisting> - <note> + <note> <title>RenderPolicy Options</title> - <itemizedlist> + <itemizedlist> <listitem> <para> <literal>ALWAYS_DELEGATE</literal> Indicates the bridge should not render the view itself but rather always delegate the rendering. </para> + </listitem> - <listitem> + <listitem> <para> <literal>NEVER_DELEGATE</literal> Indicates the bridge should always render the view itself and never delegate. </para> + </listitem> - <listitem> + <listitem> <para> <literal>DEFAULT</literal> Directs the bridge to first delegate the render and if (and only if) an Exception is thrown then to render the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using the default behavior i.e. as though DEFAULT were set. </para> + </listitem> + </itemizedlist> + </note> + </section> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Core_Setup_and_Configuration-JSP_Only_Configuration"> + <section id="sect-Overview-Core_Setup_and_Configuration-JSP_Only_Configuration"> <title>JSP Only Configuration</title> - <para> + <para> The following web.xml setting is only for JSP based applications </para> - <section id="sect-JBoss_Portlet_Bridge_Overview-JSP_Only_Configuration-web.xml"> + <section id="sect-Overview-JSP_Only_Configuration-web.xml"> <title>web.xml</title> - + <programlisting role="XML"> - &lt;web-app xmlns="http://java.sun.com/xml/ns/j2ee" - 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"&gt; + &#60;web-app xmlns=&#34;http://java.sun.com/xml/ns/j2ee&#34; + xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; + xsi:schemaLocation=&#34;http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd&#34; + version=&#34;2.4&#34;&#62; - &lt;context-param&gt; - &lt;param-name&gt;javax.portlet.faces.renderPolicy&lt;/param-name&gt; - &lt;param-value&gt; + &#60;context-param&#62; + &#60;param-name&#62;javax.portlet.faces.renderPolicy&#60;/param-name&#62; + &#60;param-value&#62; NEVER_DELEGATE - &lt;/param-value&gt; - &lt;/context-param&gt; + &#60;/param-value&#62; + &#60;/context-param&#62; ... - &lt;/web-app&gt; + &#60;/web-app&#62; </programlisting> + </section> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Core_Setup_and_Configuration-JSR_301"> + <section id="sect-Overview-Core_Setup_and_Configuration-JSR_301"> <title>JSR-301</title> - <para> + <para> The Jboss Portlet Bridge can be used with a any compatible implementation (for example, MyFaces implementation). Simply put the following into web.xml : </para> - + <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;javax.portlet.faces.BridgeImplClass&lt;/param-name&gt; - &lt;param-value&gt;org.apache.myfaces.portlet.faces.bridge.BridgeImpl&lt;/param-value&gt; - &lt;/context-param&gt; + &#60;context-param&#62; + &#60;param-name&#62;javax.portlet.faces.BridgeImplClass&#60;/param-name&#62; + &#60;param-value&#62;org.apache.myfaces.portlet.faces.bridge.BridgeImpl&#60;/param-value&#62; + &#60;/context-param&#62; </programlisting> + </section> + </section> - <!-- End 301 core setup --> - <section id="sect-JBoss_Portlet_Bridge_Overview-Bridge_Configuration-RichFaces_Setup_and_Configuration_Options"> + <!-- End 301 core setup --> <section id="sect-Overview-Bridge_Configuration-RichFaces_Setup_and_Configuration_Options"> <title>RichFaces Setup and Configuration Options</title> - <note> + <note> <para> Please be aware that RichFaces integration is a technology preview and hence is currently unsupported. </para> + </note> - <section id="sect-JBoss_Portlet_Bridge_Overview-RichFaces_Setup_and_Configuration_Options-web.xml"> + <section id="sect-Overview-RichFaces_Setup_and_Configuration_Options-web.xml"> <title>web.xml</title> - <para> + <para> The following configuration is designated for portlets using the RichFaces library. These settings will vary based on your individual needs. See <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces... this section</ulink> of the RichFaces documentation for more details. </para> - + <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;org.richfaces.LoadStyleStrategy&lt;/param-name&gt; - &lt;param-value&gt;NONE&lt;/param-value&gt; - &lt;/context-param&gt; - &lt;context-param&gt; - &lt;param-name&gt;org.richfaces.LoadScriptStrategy&lt;/param-name&gt; - &lt;param-value&gt;NONE&lt;/param-value&gt; - &lt;/context-param&gt; + &#60;context-param&#62; + &#60;param-name&#62;org.richfaces.LoadStyleStrategy&#60;/param-name&#62; + &#60;param-value&#62;NONE&#60;/param-value&#62; + &#60;/context-param&#62; + &#60;context-param&#62; + &#60;param-name&#62;org.richfaces.LoadScriptStrategy&#60;/param-name&#62; + &#60;param-value&#62;NONE&#60;/param-value&#62; + &#60;/context-param&#62; </programlisting> - <para> + <para> The <literal>org.ajax4jsf.RESOURCE_URI_PREFIX</literal> configuration cross references a setting in your <filename>jboss-portlet.xml</filename> file (see below). These settings are required for RichFaces. </para> - + <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;org.ajax4jsf.RESOURCE_URI_PREFIX&lt;/param-name&gt; - &lt;param-value&gt;rfRes&lt;/param-value&gt; - &lt;/context-param&gt; + &#60;context-param&#62; + &#60;param-name&#62;org.ajax4jsf.RESOURCE_URI_PREFIX&#60;/param-name&#62; + &#60;param-value&#62;rfRes&#60;/param-value&#62; + &#60;/context-param&#62; - &lt;filter&gt; - &lt;display-name&gt;Ajax4jsf Filter&lt;/display-name&gt; - &lt;filter-name&gt;ajax4jsf&lt;/filter-name&gt; - &lt;filter-class&gt;org.ajax4jsf.Filter&lt;/filter-class&gt; - &lt;/filter&gt; + &#60;filter&#62; + &#60;display-name&#62;Ajax4jsf Filter&#60;/display-name&#62; + &#60;filter-name&#62;ajax4jsf&#60;/filter-name&#62; + &#60;filter-class&#62;org.ajax4jsf.Filter&#60;/filter-class&#62; + &#60;/filter&#62; - &lt;filter-mapping&gt; - &lt;filter-name&gt;ajax4jsf&lt;/filter-name&gt; - &lt;servlet-name&gt;FacesServlet&lt;/servlet-name&gt; - &lt;dispatcher&gt;FORWARD&lt;/dispatcher&gt; - &lt;dispatcher&gt;REQUEST&lt;/dispatcher&gt; - &lt;dispatcher&gt;INCLUDE&lt;/dispatcher&gt; - &lt;/filter-mapping&gt; + &#60;filter-mapping&#62; + &#60;filter-name&#62;ajax4jsf&#60;/filter-name&#62; + &#60;servlet-name&#62;FacesServlet&#60;/servlet-name&#62; + &#60;dispatcher&#62;FORWARD&#60;/dispatcher&#62; + &#60;dispatcher&#62;REQUEST&#60;/dispatcher&#62; + &#60;dispatcher&#62;INCLUDE&#60;/dispatcher&#62; + &#60;/filter-mapping&#62; ... - &lt;/web-app&gt; + &#60;/web-app&#62; </programlisting> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-RichFaces_Setup_and_Configuration_Options-jboss_portlet.xml"> + <section id="sect-Overview-RichFaces_Setup_and_Configuration_Options-jboss_portlet.xml"> <title>jboss-portlet.xml</title> - <para> - To avoid scripts loading more than once from different portlet windows you can define additional scripts in jboss-portlet.xml. *Note the "rfRes" URI prefix that is mapped in the web.xml. + <para> + To avoid scripts loading more than once from different portlet windows you can define additional scripts in jboss-portlet.xml. *Note the &#34;rfRes&#34; URI prefix that is mapped in the web.xml. </para> - + <programlisting role="XML"> - &lt;portlet&gt; - &lt;portlet-name&gt;ajaxPortlet&lt;/portlet-name&gt; - &lt;header-content&gt; - &lt;script src="/faces/rfRes/org/ajax4jsf/framework.pack.js" type="text/javascript"&gt;&lt;/script&gt; - &lt;script src="/faces/rfRes/org/richfaces/ui.pack.js" type="text/javascript"&gt;&lt;/script&gt; - &lt;link rel="stylesheet" type="text/css" href="/faces/rfRes/org/richfaces/skin.xcss"/&gt; - &lt;/header-content&gt; - &lt;/portlet&gt; + &#60;portlet&#62; + &#60;portlet-name&#62;ajaxPortlet&#60;/portlet-name&#62; + &#60;header-content&#62; + &#60;script src=&#34;/faces/rfRes/org/ajax4jsf/framework.pack.js&#34; type=&#34;text/javascript&#34;&#62;&#60;/script&#62; + &#60;script src=&#34;/faces/rfRes/org/richfaces/ui.pack.js&#34; type=&#34;text/javascript&#34;&#62;&#60;/script&#62; + &#60;link rel=&#34;stylesheet&#34; type=&#34;text/css&#34; href=&#34;/faces/rfRes/org/richfaces/skin.xcss&#34;/&#62; + &#60;/header-content&#62; + &#60;/portlet&#62; </programlisting> + </section> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Bridge_Configuration-Seam_Setup_and_Configuration_Options"> + <section id="sect-Overview-Bridge_Configuration-Seam_Setup_and_Configuration_Options"> <title>Seam Setup and Configuration Options</title> - <note> + <note> <para> Please be aware that Seam integration is a technology preview and hence is currently unsupported. </para> + </note> - <section id="sect-JBoss_Portlet_Bridge_Overview-Seam_Setup_and_Configuration_Options-Configuration"> + <section id="sect-Overview-Seam_Setup_and_Configuration_Options-Configuration"> <title>Configuration</title> - <para> + <para> The ExceptionHandler is used to clean Seam contexts and transactions after errors. </para> - + <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;org.jboss.portletbridge.ExceptionHandler&lt;/param-name&gt; - &lt;param-value&gt; + &#60;context-param&#62; + &#60;param-name&#62;org.jboss.portletbridge.ExceptionHandler&#60;/param-name&#62; + &#60;param-value&#62; org.jboss.portletbridge.SeamExceptionHandlerImpl - &lt;/param-value&gt; - &lt;/context-param&gt; + &#60;/param-value&#62; + &#60;/context-param&#62; </programlisting> - <para> + <para> Earlier 2.0.x versions of Seam portlets must have the LIFECYCLE_ID set to SEAM_PORTLET in the web.xml file. This setting allows the bridge to replace the original Seam phase listener during the faces life-cycle addPhaseListeners. This setting is not needed for Seam portlets version 2.1.x and up. </para> - + <programlisting role="XML"> - &lt;context-param&gt; - &lt;param-name&gt;javax.faces.LIFECYCLE_ID&lt;/param-name&gt; - &lt;param-value&gt;SEAM_PORTLET&lt;/param-value&gt; - &lt;/context-param&gt; + &#60;context-param&#62; + &#60;param-name&#62;javax.faces.LIFECYCLE_ID&#60;/param-name&#62; + &#60;param-value&#62;SEAM_PORTLET&#60;/param-value&#62; + &#60;/context-param&#62; </programlisting> + </section> + </section> + </chapter> Modified: docs/enterprise/trunk/PortletBridge/en-US/Feedback.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Feedback.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Feedback.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,21 +1,15 @@ <?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" [ ]> - -<section id="sect-JBoss_Portlet_Bridge_Overview-We_Need_Feedback"> +<section id="sect-Overview-We_Need_Feedback"> <title>We Need Feedback!</title> - <indexterm> + <indexterm> <primary>feedback</primary> - <secondary>contact information for this manual</secondary> + <secondary>contact information for this manual</secondary> + </indexterm> - <para> - If you find a typographical error in this manual, or if you have thought of a way to make this manual - better, we would love to hear from you! Submit a report in <ulink url="http://jira.jboss.com/jira/browse/JBEPP">JIRA</ulink... - against the Version: <emphasis>&JBEPPVERS;</emphasis>, Component: <emphasis>Documentation</emphasis>. - When submitting a bug report, be sure to mention the manual's identifier: Portal_User_Guide - If you have a suggestion for improving the documentation, try to be as specific as possible when - describing it. If you have found an error, please include the section number and some of the - surrounding text so we can find it easily. + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Submit a report in <ulink url="http://jira.jboss.com/jira/browse/JBEPP">JIRA</ulink... against the Version: <emphasis>&JBEPPVERS;</emphasis>, Component: <emphasis>Documentation</emphasis>. When submitting a bug report, be sure to mention the manual&#39;s identifier: Portal_User_Guide If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. </para> </section> Modified: docs/enterprise/trunk/PortletBridge/en-US/Getting_Started.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Getting_Started.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Getting_Started.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,107 +1,121 @@ <?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="chap-JBoss_Portlet_Bridge_Overview-Getting_started_with_JBoss_Portlet_Bridge"> +<chapter id="chap-Overview-Getting_started_with_JBoss_Portlet_Bridge"> <title>Getting started with JBoss Portlet Bridge</title> - <para> + <para> JBoss Portlet Bridge not only gives you the ability to run JSF web applications in a portlet, but also gives you the benefit of running supported JBoss frameworks like Seam and RichFaces. </para> - <section id="sect-JBoss_Portlet_Bridge_Overview-Getting_started_with_JBoss_Portlet_Bridge-Bridge_Frameworks_and_Extensions"> + <section id="sect-Overview-Getting_started_with_JBoss_Portlet_Bridge-Bridge_Frameworks_and_Extensions"> <title>Bridge Frameworks and Extensions</title> - <para> + <para> The JBoss Portlet Bridge project is also actively developing extensions, or Bridgelets, that enhance or bring together features of JBoss Portal, Seam, and Richfaces. For example, the PortalIdentity seam component allows you to drop the jar in your classpath and you instantly have SSO between Seam and Portal. This extension can also be configured with additional attributes in your Seam application&#39;s components.xml file. <note> <para> Don&#39;t forget that the bridge is still in Beta and so are any extensions. If you would like to contribute to any part of this project, we encourage you to participate on the <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink> and bring issues/enhancements to our attention. </para> + </note> + </para> - <para> - <table frame="all" id="tabl-JBoss_Portlet_Bridge_Overview-Bridge_Frameworks_and_Extensions-Available_Bridgelets"> + <para> + <table frame="all" id="tabl-Overview-Bridge_Frameworks_and_Extensions-Available_Bridgelets"> <title>Available Bridgelets</title> - <tgroup align="left" cols="5" colsep="1" rowsep="1"> + <tgroup align="left" cols="5" colsep="1" rowsep="1"> <colspec colname="c1"></colspec> - <colspec colname="c2"></colspec> - <colspec colname="c3"></colspec> - <colspec colname="c5" colnum="5"></colspec> - <thead> + <colspec colname="c2"></colspec> + <colspec colname="c3"></colspec> + <colspec colname="c5" colnum="5"></colspec> + <thead> <row> <entry align="center"> Bridgelet </entry> - <entry align="center" nameend="c5" namest="c2"> + <entry align="center" nameend="c5" namest="c2"> Command </entry> + </row> + </thead> - <tbody> + <tbody> <row class="table-odd" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;"> <entry align="left"> Single Sign On </entry> - <entry align="left" nameend="c5" namest="c2"> + <entry align="left" nameend="c5" namest="c2"> <para> By including the following dependency in your web pom, you will automatically enable SSO between JBoss Portal and your Seam 2.1.1.GA application. <programlisting> -&lt;dependency&gt; - &lt;groupId&gt;org.jboss.portletbridge.extensions.seam&lt;/groupId&gt; - &lt;artifactId&gt;PortalIdentity&lt;/artifactId&gt; - &lt;version&gt;1.0.0.CR2&lt;/version&gt; -&lt;/dependency&gt; +&#60;dependency&#62; + &#60;groupId&#62;org.jboss.portletbridge.extensions.seam&#60;/groupId&#62; + &#60;artifactId&#62;PortalIdentity&#60;/artifactId&#62; + &#60;version&#62;1.0.0.CR2&#60;/version&#62; +&#60;/dependency&#62; </programlisting> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Getting_started_with_JBoss_Portlet_Bridge-Before_you_start"> + <section id="sect-Overview-Getting_started_with_JBoss_Portlet_Bridge-Before_you_start"> <title>Before you start</title> - <para> + <para> Current version and compatibility information can be easily located on the <ulink url="http://www.jboss.org/wiki/JBossPortletBridge">JBoss Portlet Bridge wiki</ulink>. Ensure you are using compatible versions of all integrated frameworks before you begin. </para> - <para> + <para> JBoss Portal provides its latest distribution with the JBoss Application Server. All of the guesswork has been eliminated so that you can unzip and run Portal with a few clicks. <ulink url="http://www.jboss.org/jbossportal/download/index.html">Get the latest version here</ulink> (ensure you choose the JBoss Portal + JBoss AS link) </para> - <para> - Next, all that&#39;s left is to download the <ulink url="http://www.jboss.org/portletbridge/download/">JBoss Portlet Bridge distribution</ulink> and configure your portlet to use the bridge. Or, you can run a provided archetype <xref linkend="sect-JBoss_Portlet_Bridge_Overview-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" /> and deploy the generated WAR in a few easy steps. This will also give you an empty project to play around with or start from scratch. + <para> + Next, all that&#39;s left is to download the <ulink url="http://www.jboss.org/portletbridge/download/">JBoss Portlet Bridge distribution</ulink> and configure your portlet to use the bridge. Or, you can run a provided archetype <xref linkend="sect-Overview-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" /> and deploy the generated WAR in a few easy steps. This will also give you an empty project to play around with or start from scratch. </para> - <para> + <para> For system requirements and setting up your JBoss Portal environment see the <ulink url="http://docs.jboss.com/jbportal/v2.6.4/referenceGuide/html_singl... guide</ulink>. </para> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes"> - <title>Maven Archetypes</title> - <para> + <section id="sect-Overview-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes"> + <title>Maven Archetypes</title> + <para> The JBPB project utilizes <ulink url="http://maven.apache.org/guides/introduction/introduction-to-arc... archetypes</ulink> which allow you get up and running with different flavors of the bridge quickly. - <table frame="all" id="tabl-JBoss_Portlet_Bridge_Overview-Maven_Archetypes-Available_Archetypes"> + <table frame="all" id="tabl-Overview-Maven_Archetypes-Available_Archetypes"> <title>Available Archetypes</title> - <tgroup align="left" cols="5" colsep="1" rowsep="1"> + <tgroup align="left" cols="5" colsep="1" rowsep="1"> <colspec colname="c1"></colspec> - <colspec colname="c2"></colspec> - <colspec colname="c3"></colspec> - <colspec colname="c5" colnum="5"></colspec> - <thead> + <colspec colname="c2"></colspec> + <colspec colname="c3"></colspec> + <colspec colname="c5" colnum="5"></colspec> + <thead> <row> <entry align="center"> Archetype </entry> - <entry align="center" nameend="c5" namest="c2"> + <entry align="center" nameend="c5" namest="c2"> Command </entry> + </row> + </thead> - <tbody> + <tbody> <row class="table-odd" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;"> <entry align="left"> JSF 1.2 Basic </entry> - <entry align="left" nameend="c5" namest="c2"> + <entry align="left" nameend="c5" namest="c2"> <programlisting>mvn archetype:generate -DarchetypeGroupId=org.jboss.portletbridge.archetypes @@ -111,13 +125,15 @@ -DartifactId=myprojectname -DarchetypeRepository=http://repository.jboss.org/maven2/ </programlisting> + </entry> + </row> - <row class="table-even" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;"> + <row class="table-even" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;"> <entry align="left"> RichFaces Basic </entry> - <entry align="left" nameend="c5" namest="c2"> + <entry align="left" nameend="c5" namest="c2"> <programlisting>mvn archetype:generate -DarchetypeGroupId=org.jboss.portletbridge.archetypes @@ -127,13 +143,15 @@ -DartifactId=myprojectname -DarchetypeRepository=http://repository.jboss.org/maven2/ </programlisting> + </entry> + </row> - <row class="table-odd" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;"> + <row class="table-odd" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;"> <entry align="left"> Seam Basic (Modular EAR) </entry> - <entry align="left" nameend="c5" namest="c2"> + <entry align="left" nameend="c5" namest="c2"> <programlisting>mvn archetype:generate -DarchetypeGroupId=org.jboss.portletbridge.archetypes @@ -143,30 +161,36 @@ -DartifactId=seamproject -DarchetypeRepository=http://repository.jboss.org/maven2/ </programlisting> + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> - <section id="sect-JBoss_Portlet_Bridge_Overview-Maven_Archetypes-Running_the_Examples"> + <section id="sect-Overview-Maven_Archetypes-Running_the_Examples"> <title>Running the Examples</title> - <para> - <emphasis role="bold">JSF 1.2 Basic, RichFaces Basic, Seam Basic, and other demos</emphasis> + <para> + <emphasis role="bold">JSF 1.2 Basic, RichFaces Basic, Seam Basic, and other demos</emphasis> </para> - <para> - Each example application is configured to download the latest version of JBoss Portal bundled with JBoss Application Server. After running the archetype <xref linkend="sect-JBoss_Portlet_Bridge_Overview-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" /> or <ulink url="http://www.jboss.org/portletbridge/download/">downloading the source code</ulink> for the example application that you are interested in, you can run one of the following Maven profiles to save time and get everything up and running with only 2 commands. + <para> + Each example application is configured to download the latest version of JBoss Portal bundled with JBoss Application Server. After running the archetype <xref linkend="sect-Overview-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" /> or <ulink url="http://www.jboss.org/portletbridge/download/">downloading the source code</ulink> for the example application that you are interested in, you can run one of the following Maven profiles to save time and get everything up and running with only 2 commands. </para> - <para> + <para> <emphasis role="bold">JBoss Portal 2.7.2.GA + JBoss AS 4.2.3 (Bundled)</emphasis> </para> - + <programlisting role="XML"> mvn install -Plocal-portal cargo:start mvn cargo:deploy -Plocal-portal visit http://localhost:8080/portal </programlisting> -<!-- + <!-- <para> <emphasis role="bold">JBoss Portlet Container 2.0 + JBoss AS 4.2.3 (Bundled)</emphasis> </para> @@ -175,15 +199,13 @@ mvn install cargo:start -Premote-portal -Dpc20 mvn cargo:deploy -Premote-portal -Dpc20 </programlisting> - --> - <para> + --> <para> <emphasis>Time Saving Tips</emphasis> </para> - <para> + <para> <emphasis role="normal">If you plan on using the cargo profiles to do active development, you can save a lot of time by not downloading the bundle each time you do a clean install. To use a locally configured server bundled with portal, use the following command line parameters. The variable for JBOSS_HOME_DIR is related to how you zip the server directory. If you zip the files under JBOSS_HOME/* then it will only be the name of your archive. But if you zip the actual folder JBOSS_HOME then JBOSS_HOME_DIR must be defined as &#39;zip file name/JBOSS_HOME folder name&#39;.</emphasis> </para> - -<!-- + <!-- <para> <emphasis role="bold">JBoss Portal 2.7.0.B1</emphasis> </para> @@ -200,10 +222,12 @@ mvn install cargo:start -Plocal-portal -DJBOSS_ZIP_HOME=/path_to_bundle_zip/Jboss-4.2.2-PC20.zip -DJBOSS_HOME_DIR=Jboss-4.2.2-PC20 mvn cargo:deploy -Plocal-portal -DJBOSS_ZIP_HOME=/path_to_bundle_zip/Jboss-4.2.2-PC20.zip -DJBOSS_HOME_DIR=Jboss-4.2.2-PC20 </programlisting> - --> + --> </section> + </section> + </chapter> Modified: docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.ent =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.ent 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.ent 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,4 +1,5 @@ -<!ENTITY PRODUCT "Documentation"> -<!ENTITY BOOKID "portletOverview"> -<!ENTITY YEAR "2008"> +<!ENTITY PRODUCT "JBoss Portlet Bridge"> +<!ENTITY BOOKID "JBoss Portlet Bridge Overview"> +<!ENTITY JBEPPVERS "4.3 CP05"> +<!ENTITY YEAR "2010"> <!ENTITY HOLDER "Red Hat Documentation Group"> Modified: docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/JBoss_Portlet_Bridge_Overview.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,14 +1,13 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - <book> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Getting_Started.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Portlet_Development.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Getting_Started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Portlet_Development.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book> Modified: docs/enterprise/trunk/PortletBridge/en-US/Overview.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Overview.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Overview.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,61 +1,48 @@ <?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="chap-JBoss_Portlet_Bridge_Overview-JBoss_Portlet_Bridge_Overview"> +<chapter id="chap-Overview-JBoss_Portlet_Bridge_Overview"> <title>JBoss Portlet Bridge Overview</title> - - <warning> - <para>As part of the support contract, only JSF applications are supported and - should be used in production. - Seam and RichFaces portlets are provided here as technology preview, at this - stage it is recommended to <emphasis role="bold">not use those in production</emphasis>. - Work is being done to support those two technologies. In the meantime it is - encouraged to try those during development to report any issue in our community - forums to help mature the integration.</para> - </warning> - - <note> - <para>This project is marked as 'Beta' since the JSR-301 specification is not final - at the time of release and because support for RichFaces and Seam need to mature. - As part of the professional support the API will not change for JSF portlets during - the lifetime of the Enterprise Portal Platform to guarantee that no issue will - arise during an upgrade. - Again JSF applications are fully supported and can be - used in production. - Also note that the Maven archetypes may download binaries that are not supported by - the support contract. - </para> + <warning> + <para> + As part of the support contract, only JSF applications are supported and should be used in production. Seam and RichFaces portlets are provided here as technology preview, at this stage it is recommended to <emphasis role="bold">not use those in production</emphasis>. Work is being done to support those two technologies. In the meantime it is encouraged to try those during development to report any issue in our community forums to help mature the integration. + </para> + + </warning> + <note> + <para> + This project is marked as &#39;Beta&#39; since the JSR-301 specification is not final at the time of release and because support for RichFaces and Seam need to mature. As part of the professional support the API will not change for JSF portlets during the lifetime of the Enterprise Portal Platform to guarantee that no issue will arise during an upgrade. Again JSF applications are fully supported and can be used in production. Also note that the Maven archetypes may download binaries that are not supported by the support contract. + </para> + </note> - - <para> + <para> To get an idea of the JBoss Portlet Bridge community, the developers, and for wiki resources, check out <ulink url="http://www.jboss.org/portletbridge/">the project page</ulink>. </para> - <para> + <para> <emphasis role="bold">What is the JBoss Portlet Bridge?</emphasis> </para> - <para> + <para> The JBoss Portlet Bridge (or JBPB for short) is an implementation of the <ulink url="http://jcp.org/en/jsr/detail?id=301">JSR-301</ulink> specification which supports JSF within a portlet and with added enhancements, offers support of other web frameworks (such as <ulink url="http://www.seamframework.org/">Seam</ulink> and <ulink url="http://www.jboss.org/jbossrichfaces/">RichFaces</ulink>). It basically allows any Java developer to get started quickly with their JSF web application running in a portal environment. The developer no longer needs to worry about the underlying portlet development, portlet concepts, or the API. </para> - <para> + <para> <emphasis role="bold">Understanding how JSF works with Portal</emphasis> </para> - <para> + <para> It is important to understand that the portlet bridge is not a portlet. Rather, it is the mediator between the two environments and allows JSF and Portal to be completely unaware of each other and live in their own seperate worlds. The bridge is used to execute Faces requests on behalf of the portlet. During each request, the Faces environment is set up and handled by the bridge. Part of this implementation acts as a Faces controller much like how the FacesServlet does for direct client requests. The other part of this implementation is provided by incorporating a variety of (standard) Faces extensions. </para> - <!-- <figure id="build.fig"> + <!-- <figure id="build.fig"> <title>Faces in Portlet Environment</title> <mediaobject> <imageobject> <imagedata align="center" fileref="images/portletbridge-basic.png"/> </imageobject> </mediaobject> - </figure> --><!-- + </figure> --><!-- <imageobject> <imagedata fileref="images/frontpage.png" format="png" align="center" valign="middle"/> </imageobject> - </para> --><!-- <para> + </para> --><!-- <para> <emphasis role="bold">JBoss Portal Resources:</emphasis> <orderedlist> <listitem> @@ -94,6 +81,6 @@ </para> </listitem> </orderedlist> - </para> --> + </para> --> </chapter> Modified: docs/enterprise/trunk/PortletBridge/en-US/Portlet_Development.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Portlet_Development.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Portlet_Development.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,103 +1,108 @@ <?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="chap-JBoss_Portlet_Bridge_Overview-Developing_Portlets_with_the_Bridge"> +<chapter id="chap-Overview-Developing_Portlets_with_the_Bridge"> <title>Developing Portlets with the Bridge</title> - <para> + <para> This chapter demonstrates common development tasks described by the 301 specification. </para> - <section id="sect-JBoss_Portlet_Bridge_Overview-Developing_Portlets_with_the_Bridge-Excluding_Attributes_from_the_Bridge_Request_Scope"> + <section id="sect-Overview-Developing_Portlets_with_the_Bridge-Excluding_Attributes_from_the_Bridge_Request_Scope"> <title>Excluding Attributes from the Bridge Request Scope</title> - <para> + <para> When your application uses request attributes on a per request basis and you do not want that particular attribute to be managed in the extended bridge request scope, you must use the following configuration in your faces-config.xml file. Below you will see that any attribute namespaced as foo.bar or any attribute beginning with foo.baz (wildcard) will be excluded from the bridge request scope and only be used per that application&#39;s request. </para> - + <programlisting role="XML"> - &lt;application&gt; - &lt;application-extension&gt; - &lt;bridge:excluded-attributes&gt; - &lt;bridge:excluded-attribute&gt;foo.bar&lt;/bridge:excluded-attribute&gt; - &lt;bridge:excluded-attribute&gt;foo.baz.*&lt;/bridge:excluded-attribute&gt; - &lt;/bridge:excluded-attributes&gt; - &lt;/application-extension&gt; - &lt;/application&gt; + &#60;application&#62; + &#60;application-extension&#62; + &#60;bridge:excluded-attributes&#62; + &#60;bridge:excluded-attribute&#62;foo.bar&#60;/bridge:excluded-attribute&#62; + &#60;bridge:excluded-attribute&#62;foo.baz.*&#60;/bridge:excluded-attribute&#62; + &#60;/bridge:excluded-attributes&#62; + &#60;/application-extension&#62; + &#60;/application&#62; </programlisting> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes"> + <section id="sect-Overview-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes"> <title>Supporting PortletMode Changes</title> - <para> + <para> A PortletMode represents a distinct render path within an application. There are three standard modes: view, edit and help. The bridge&#39;s ExternalContext.encodeActionURL recognizes the query string parameter javax.portlet.faces.PortletMode and uses this parameter&#39;s value to set the portlet mode on the underlying portlet actionURL or response. Once processed it then removes this parameter from the query string. This means the following navigation rule causes one to render the edit.jspx viewId in the portlet edit mode: </para> - + <programlisting role="XML"> - &lt;navigation-rule&gt; - &lt;from-view-id&gt;/register.jspx&lt;/from-view-id&gt; - &lt;navigation-case&gt; - &lt;from-outcome&gt;edit&lt;/from-outcome&gt; - &lt;to-view-id&gt;/edit.jspx?javax.portlet.faces.PortletMode=edit&lt;/to-view-id&gt; - &lt;/navigation-case&gt; - &lt;/navigation-rule&gt; + &#60;navigation-rule&#62; + &#60;from-view-id&#62;/register.jspx&#60;/from-view-id&#62; + &#60;navigation-case&#62; + &#60;from-outcome&#62;edit&#60;/from-outcome&#62; + &#60;to-view-id&#62;/edit.jspx?javax.portlet.faces.PortletMode=edit&#60;/to-view-id&#62; + &#60;/navigation-case&#62; + &#60;/navigation-rule&#62; </programlisting> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId"> + <section id="sect-Overview-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId"> <title>Navigating to a mode&#39;s last viewId</title> - <para> - By default, a mode change will start in the mode&#39;s default view without any (prior) existing state. One common portlet pattern when returning to the mode one left after entering another mode (e.g.. view -&gt; edit -&gt; view) is to return to the last view (and state) of this origin mode. The bridge will explicitly encode the necessary information so that when returning to a prior mode it can target the appropriate view and restore the appropriate state. The session attributes maintained by the bridge are intended to be used by developers to navigate back from a mode to the last location and state of a prior mode. As such a developer needs to describe a dynamic navigation: "from view X return to the last view of mode y". This is most easily expressed via an EL expression. E.g. + <para> + By default, a mode change will start in the mode&#39;s default view without any (prior) existing state. One common portlet pattern when returning to the mode one left after entering another mode (e.g.. view -&#62; edit -&#62; view) is to return to the last view (and state) of this origin mode. The bridge will explicitly encode the necessary information so that when returning to a prior mode it can target the appropriate view and restore the appropriate state. The session attributes maintained by the bridge are intended to be used by developers to navigate back from a mode to the last location and state of a prior mode. As such a developer needs to describe a dynamic navigation: &#34;from view X return to the last view of mode y&#34;. This is most easily expressed via an EL expression. E.g. </para> - + <programlisting role="XML"> - &lt;navigation-rule&gt; - &lt;from-view-id&gt;/edit.jspx*&lt;/from-view-id&gt; - &lt;navigation-case&gt; - &lt;from-outcome&gt;view&lt;/from-outcome&gt; - &lt;to-view-id&gt;#{sessionScope[&#39;javax.portlet.faces.viewIdHistory.view&#39;]}&lt;/to-view-id&gt; - &lt;/navigation-case&gt; - &lt;/navigation-rule&gt; + &#60;navigation-rule&#62; + &#60;from-view-id&#62;/edit.jspx*&#60;/from-view-id&#62; + &#60;navigation-case&#62; + &#60;from-outcome&#62;view&#60;/from-outcome&#62; + &#60;to-view-id&#62;#{sessionScope[&#39;javax.portlet.faces.viewIdHistory.view&#39;]}&#60;/to-view-id&#62; + &#60;/navigation-case&#62; + &#60;/navigation-rule&#62; </programlisting> - <note> + <note> <para> <emphasis>Note to Portlet Developers</emphasis> Depending on the bridge implementation, when using values from these session scoped attributes or any viewIds which may contain query string parameters it may be necessary to use the wildcard syntax when identifying the rule target. For example, the above -<programlisting>&lt;to-view-id&gt; +<programlisting>&#60;to-view-id&#62; </programlisting> expression returns a viewId of the form <programlisting>/viewId?javax.portlet.faces.PortletMode=view&amp;.... </programlisting> Without wildcarding, when a subsequent navigation occurs from this new view, the navigation rules wouldn&#39;t resolve because there wouldn&#39;t be an exact match. Likewise, the above edit.jspx -<programlisting>&lt;from-view-id&gt; +<programlisting>&#60;from-view-id&#62; </programlisting> is wildcarded because there are navigation rules that target it that use a query string ( -<programlisting>&lt;to-view-id&gt; /edit.jspx?javax.portlet.faces.PortletMode=edit &lt;/to-view-id&gt; +<programlisting>&#60;to-view-id&#62; /edit.jspx?javax.portlet.faces.PortletMode=edit &#60;/to-view-id&#62; </programlisting> ). Developers are encouraged to use such wildcards to ensure they execute properly in the broadest set of bridge implementations. </para> + </note> + </section> - <section id="sect-JBoss_Portlet_Bridge_Overview-Developing_Portlets_with_the_Bridge-Custom_Ajax_Error_Handling"> + <section id="sect-Overview-Developing_Portlets_with_the_Bridge-Custom_Ajax_Error_Handling"> <title>Custom Ajax Error Handling</title> - <para> + <para> By default, error handling is sent to a standard servlet page for Ajax requests. To handle the error inside the portlet, use the following javascript: </para> - + <programlisting role="XML"> - &lt;script type="text/javascript"&gt; + &#60;script type=&#34;text/javascript&#34;&#62; A4J.AJAX.onError = function(req,status,message){ - window.alert("Custom onError handler "+message); + window.alert(&#34;Custom onError handler &#34;+message); } A4J.AJAX.onExpired = function(loc,expiredMsg){ - if(window.confirm("Custom onExpired handler "+expiredMsg+" for a location: "+loc)){ + if(window.confirm(&#34;Custom onExpired handler &#34;+expiredMsg+&#34; for a location: &#34;+loc)){ return loc; } else { return false; } } - &lt;/script&gt; + &#60;/script&#62; </programlisting> + </section> + </chapter> Modified: docs/enterprise/trunk/PortletBridge/en-US/Preface.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Preface.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Preface.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,12 +1,11 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - -<preface id="pref-JBoss_Portlet_Bridge_Overview-Preface"> +<preface id="pref-Overview-Preface"> <title>Preface</title> - <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - </xi:fallback> - </xi:include> + <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> + </xi:include> </preface> Modified: docs/enterprise/trunk/PortletBridge/en-US/Revision_History.xml =================================================================== --- docs/enterprise/trunk/PortletBridge/en-US/Revision_History.xml 2010-07-09 02:29:28 UTC (rev 13958) +++ docs/enterprise/trunk/PortletBridge/en-US/Revision_History.xml 2010-07-14 01:46:03 UTC (rev 13959) @@ -1,26 +1,31 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> - -<appendix id="appe-JBoss_Portlet_Bridge_Overview-Revision_History"> +<appendix id="appe-Overview-Revision_History"> <title>Revision History</title> - <simpara> + <simpara> <revhistory> <revision> - <revnumber>1.0</revnumber> - <date></date> - <author> - <firstname></firstname> - <surname></surname> - <email></email> + <revnumber>1.1</revnumber> + <date>Wed 14 Jul 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> - <revdescription> + <revdescription> <simplelist> - <member></member> + <member>Updated for 4.3 CP05 Release</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> </appendix> Added: docs/enterprise/trunk/PortletBridge/publican.cfg =================================================================== --- docs/enterprise/trunk/PortletBridge/publican.cfg (rev 0) +++ docs/enterprise/trunk/PortletBridge/publican.cfg 2010-07-14 01:46:03 UTC (rev 13959) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Wed Jul 14 11:15:41 2010 + +debug: 1 +xml_lang: en-US +brand: JBoss +