Author: julien(a)jboss.com Date: 2008-03-31 05:08:19 -0400 (Mon, 31 Mar 2008) New Revision: 10427 Added: modules/portlet/trunk/docs/user-guide/en/images/debugger1.png modules/portlet/trunk/docs/user-guide/en/images/debugger2.png Modified: modules/portlet/trunk/build/distrib/distrib.xml modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml modules/portlet/trunk/portal/pom.xml modules/portlet/trunk/portal/src/assemble/simple-portal-jboss42.xml modules/portlet/trunk/portal/src/assemble/simple-portal-tomcat60.xml modules/portlet/trunk/portal/src/main/resources/simple-portal-war/layouts/nav/main.jsp modules/portlet/trunk/samples/src/main/java/org/jboss/portal/portlet/samples/basic/RandomEventPortlet.java Log: added event debugger documentation Modified: modules/portlet/trunk/build/distrib/distrib.xml =================================================================== --- modules/portlet/trunk/build/distrib/distrib.xml 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/build/distrib/distrib.xml 2008-03-31 09:08:19 UTC (rev 10427) @@ -1,4 +1,4 @@ -<project default="all" name="JBoss Portlet Container"> +im<project default="all" name="JBoss Portlet Container"> <property name="source.dir" value="../.."/> <property name="src.docs.dir" value="${source.dir}/docs"/> @@ -86,7 +86,7 @@ <!-- Simple portal --> <copy todir="${pc.build.bin.as42}/server/default/deploy/simple-portal"> <fileset - dir="${source.dir}/portal/target/portlet-portal-${maven.version}-simple-portal-jboss42.dir/simple-portal"/> + dir="${source.dir}/portal/target/simple-portal-jboss42.dir/simple-portal"/> </copy> <!-- Taglib integration --> @@ -124,12 +124,12 @@ <!-- --> <copy todir="${pc.build.bin.tomcat6}/lib"> <fileset - dir="${source.dir}/portal/target/portlet-portal-${maven.version}-simple-portal-tomcat60.dir/simple-portal/lib" + dir="${source.dir}/portal/target/simple-portal-tomcat60.dir/simple-portal/lib" includes="**/*.jar"/> </copy> <jar file="${pc.build.bin.tomcat6}/webapps/simple-portal.war"> <fileset - dir="${source.dir}/portal/target/portlet-portal-${maven.version}-simple-portal-tomcat60.dir/simple-portal/simple-portal.war" + dir="${source.dir}/portal/target/tomcat60.dir/simple-portal/simple-portal.war" includes="**"/> </jar> Added: modules/portlet/trunk/docs/user-guide/en/images/debugger1.png =================================================================== (Binary files differ) Property changes on: modules/portlet/trunk/docs/user-guide/en/images/debugger1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/portlet/trunk/docs/user-guide/en/images/debugger2.png =================================================================== (Binary files differ) Property changes on: modules/portlet/trunk/docs/user-guide/en/images/debugger2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml =================================================================== --- modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/docs/user-guide/en/modules/simpleportal.xml 2008-03-31 09:08:19 UTC (rev 10427) @@ -509,7 +509,44 @@ </sect1> <sect1> <title>Portlet debugging</title> - <para>todo</para> + <para>The Portlet 2.0 specification provides a new eventing feature for coordinating several portlets. + This long awaited feature is very powerful but can sometime lead to complex scenarios when multiple + events are consumed and fired by multiple portlets on the same page.</para> + <para>The simple portal provides a visual debugger that can be used to understand what happens during the + event phase orchestrated by the portal. It comes as a portlet that you can place on any page and it shows + a tree of events that were produced and consumed during the event phase.</para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/debugger1.png" format="PNG" + valign="middle"/> + </imageobject> + <caption> + <para>Event debugger portlet.</para> + </caption> + </mediaobject> + <para>The event debugger displays a tree of events produced and consumed by portlets. The nodes of the + tree don't represent events, they rather represent event routings from a source portlet to + a destination portlet. By default it shows the name of the portlet that published the event, + the event name and the destination of the event that was chosen by the simple portal during + the event distribution phase. Hovering the mouse on a node shows more information.</para> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/debugger2.png" format="PNG" + valign="middle"/> + </imageobject> + <caption> + <para>Event debugger portlet.</para> + </caption> + </mediaobject> + <para>When hovering the mouse on a node you can see the optional event payload represented by + the string returned when invoked its <code>toString()</code> method and the state of the portlet + after the event phase. The state of the portlet consist in its portlet mode, its window state and the + set of its render parameters. Adding the event debugger to a page is easy.</para> + <example> + <title>Adding the event debugger to a portal page</title> + <programlisting><![CDATA[ +...<xportal:portlet name="DebuggerPortlet" applicationName="simple-portal"/>...]]></programlisting> + </example> </sect1> <sect1> <title>Administration</title> Modified: modules/portlet/trunk/portal/pom.xml =================================================================== --- modules/portlet/trunk/portal/pom.xml 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/portal/pom.xml 2008-03-31 09:08:19 UTC (rev 10427) @@ -185,6 +185,7 @@ <plugin> <artifactId>maven-assembly-plugin</artifactId> <configuration> + <finalName>simple-portal</finalName> <descriptors> <descriptor>src/assemble/simple-portal-jboss42.xml</descriptor> <descriptor>src/assemble/simple-portal-tomcat60.xml</descriptor> Modified: modules/portlet/trunk/portal/src/assemble/simple-portal-jboss42.xml =================================================================== --- modules/portlet/trunk/portal/src/assemble/simple-portal-jboss42.xml 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/portal/src/assemble/simple-portal-jboss42.xml 2008-03-31 09:08:19 UTC (rev 10427) @@ -1,5 +1,5 @@ <assembly> - <id>simple-portal-jboss42</id> + <id>jboss42</id> <formats> <format>dir</format> </formats> Modified: modules/portlet/trunk/portal/src/assemble/simple-portal-tomcat60.xml =================================================================== --- modules/portlet/trunk/portal/src/assemble/simple-portal-tomcat60.xml 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/portal/src/assemble/simple-portal-tomcat60.xml 2008-03-31 09:08:19 UTC (rev 10427) @@ -1,5 +1,5 @@ <assembly> - <id>simple-portal-tomcat60</id> + <id>tomcat60</id> <formats> <format>dir</format> </formats> Modified: modules/portlet/trunk/portal/src/main/resources/simple-portal-war/layouts/nav/main.jsp =================================================================== --- modules/portlet/trunk/portal/src/main/resources/simple-portal-war/layouts/nav/main.jsp 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/portal/src/main/resources/simple-portal-war/layouts/nav/main.jsp 2008-03-31 09:08:19 UTC (rev 10427) @@ -30,7 +30,7 @@ <a href="${pageContext.request.contextPath}/demo/demo3.jsp" class="${fn:substringAfter(pageContext.request.servletPath, 'demo/') == 'demo3.jsp' ? 'selected' : ''}">Demo3</a> </li> <li> - <a href="${pageContext.request.contextPath}/demo/demo4.jsp" class="${fn:substringAfter(pageContext.request.servletPath, 'demo/') == 'demo4.jsp' ? 'selected' : ''}">Demo3</a> + <a href="${pageContext.request.contextPath}/demo/demo4.jsp" class="${fn:substringAfter(pageContext.request.servletPath, 'demo/') == 'demo4.jsp' ? 'selected' : ''}">Demo4</a> </li> </ul> <br class="clear"/> Modified: modules/portlet/trunk/samples/src/main/java/org/jboss/portal/portlet/samples/basic/RandomEventPortlet.java =================================================================== --- modules/portlet/trunk/samples/src/main/java/org/jboss/portal/portlet/samples/basic/RandomEventPortlet.java 2008-03-31 05:53:27 UTC (rev 10426) +++ modules/portlet/trunk/samples/src/main/java/org/jboss/portal/portlet/samples/basic/RandomEventPortlet.java 2008-03-31 09:08:19 UTC (rev 10427) @@ -113,22 +113,22 @@ } // - if (repeat > 0) - { - publishState(resp, repeat - 1); - } + publishState(resp, repeat - 1); } private void publishState(StateAwareResponse resp, int repeat) { - QName name = pickQName(); - resp.setEvent(name, repeat); + if (repeat > 0) + { + QName name = pickQName(); + resp.setEvent(name, repeat); - // - resp.setRenderParameter(pickValue(PARAM_NAMES), pickValue(PARAM_VALUES)); + // + resp.setRenderParameter(pickValue(PARAM_NAMES), pickValue(PARAM_VALUES)); - // - System.out.println("Portlet " + getPortletConfig().getPortletName() + " generated the event (" + name + "," + repeat + ")"); + // + System.out.println("Portlet " + getPortletConfig().getPortletName() + " generated the event (" + name + "," + repeat + ")"); + } } public void render(RenderRequest req, RenderResponse resp) throws PortletException, IOException @@ -137,9 +137,16 @@ // PrintWriter writer = resp.getWriter(); - writer.println("<form action=\"" + actionURL + "\" method=\"post\">"); - writer.println("<input type=\"text\" name=\"repeat\" value=\"2\"/>"); + + // + writer.println("<p>The random event portlet generates and consumes randomly generated events during the event " + + "phase of a portlet. It is used to show a complex eventing scenario and how the event debugger portlet " + + "can be useful to understand how the events were distributed during the event phase.</p>"); + + // + writer.println("<p><form action=\"" + actionURL + "\" method=\"post\">"); + writer.println("Number maximum of event phases: <input type=\"text\" name=\"repeat\" value=\"3\"/>"); writer.println("<input type=\"submit\"/>"); - writer.println("</form>"); + writer.println("</form></p>"); } }