Author: taylor
Date: Wed Feb 14 22:24:57 2007
New Revision: 507831

URL: http://svn.apache.org/viewvc?view=rev&rev=507831
Log:
start of aggregation guide, just needed to gather some notes as i go along
will update this more before final release

Added:
    portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml
Modified:
    portals/jetspeed-2/trunk/xdocs/guides/index.xml

Added: portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml
URL: 
http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml?view=auto&rev=507831
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml (added)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml Wed Feb 14 
22:24:57 2007
@@ -0,0 +1,134 @@
+<?xml version="1.0"?>
+<!--
+       Copyright 2004 The Apache Software Foundation
+       
+       Licensed under the Apache License, Version 2.0 (the "License");
+       you may not use this file except in compliance with the License.
+       You may obtain a copy of the License at
+       
+       http://www.apache.org/licenses/LICENSE-2.0
+       
+       Unless required by applicable law or agreed to in writing, software
+       distributed under the License is distributed on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+       See the License for the specific language governing permissions and
+       limitations under the License.
+-->
+<document>
+       <properties>
+               <title>Jetspeed 2 Aggregation</title>
+               <subtitle>Guide to Jetspeed Aggregation</subtitle>
+               <authors>
+                       <person name="David Sean Taylor" email="[EMAIL 
PROTECTED]" />
+               </authors>
+       </properties>
+       <body>
+               <section name="What is Aggregation?">
+                       <p>
+                       The portal provides a consolidated view of multiple 
content sources, or portlets, in a single browser display.
+                       The process of consolidating and rendering this content 
together is known as aggregation.       
+                       In Jetspeed, the aggregator is made up of several 
pluggable Spring components that plug into the Jetspeed engine.        
+                       </p>
+               </section>
+        <section name='Supported Aggregators'> 
+        <p>List of Aggregators:</p>
+        <table>
+            <tr>
+                <th>Component Name</th>
+                <th>Description</th>                
+                <th>Multithreaded?</th>
+                <th>JSR-168 Caching?</th>
+            </tr>
+            <tr>
+                <td>PageAggregator</td>
+                <td>Given a PSML page, aggregates the content of all portlets 
on that page.</td>                
+                <td>no</td>
+                <td>yes</td>
+            </tr>
+            <tr>
+                <td>AsyncPageAggregator</td>
+                <td>A multi-threaded, asynchronous PSML page aggregator.</td>
+                <td>yes</td>
+                <td>yes</td>
+            </tr>
+            <tr>
+                <td>PortletAggregator</td>
+                <td>Renders the content of one single portlet.</td>
+                <td>no*</td>
+                <td>yes</td>
+            </tr>
+        </table>            
+        <i>* multi-threading is accomplished with the Jetspeed Desktop 
combined with the PortletAggregator</i>
+        </section>
+               <section name="Aggregator Spring Configuration">
+                       <p>
+                       </p>
+                       <source test="">
+                               <![CDATA[
+        <!-- Default portlet timeout in milliseconds:
+        Zero means no portlet timeout option by default.
+        -->
+        <constructor-arg>
+            <value>0</value>
+        </constructor-arg>                             
+]]>
+                       </source>
+                       <p>
+                       </p>
+
+               </section>
+        
+               <section name="Changing the Page Aggregator to Multithreaded">
+                       <p>
+                       The default aggregator is single-threaded. To switch to 
multi-threaded,
+                       edit the <b>pipelines.xml</b> spring configuration file:
+                       </p>
+                       <source test="">
+                               <![CDATA[
+<!-- Before -->
+  <bean id="aggregatorValve"
+        class="org.apache.jetspeed.aggregator.AggregatorValve"
+        init-method="initialize"
+
+   <constructor-arg>
+       <ref bean="org.apache.jetspeed.aggregator.PageAggregator"/>
+   </constructor-arg>
+  </bean> 
+
+  <!-- After -->
+  <bean id="aggregatorValve"
+        class="org.apache.jetspeed.aggregator.AggregatorValve"
+        init-method="initialize"
+
+   <constructor-arg>
+       <ref bean="org.apache.jetspeed.aggregator.AsyncPageAggregator"/>
+   </constructor-arg>
+  </bean> 
+]]>
+                       </source>
+                       <p>
+                       </p>
+
+               </section>
+               <section name="jetspeed-portlet.xml Parameters">
+                       <p>
+                       For the multithreaded aggregator, you can override the 
default setting
+                       for rendering timeout for a specific portlet. This 
value is set in milliseconds
+                       and represents the timeout value that Jetspeed will 
give the portlet to complete 
+                       rendering before it gives up. 
+                       </p>
+                       <source test="">
+                               <![CDATA[
+<portlet>
+        <portlet-name>PickANumberPortlet</portlet-name>
+        <js:metadata name="timeout">3000</js:metadata>
+</portlet>
+]]>
+                       </source>
+                       <p>
+                       </p>
+
+               </section>
+
+       </body>
+</document>

Modified: portals/jetspeed-2/trunk/xdocs/guides/index.xml
URL: 
http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/index.xml?view=diff&rev=507831&r1=507830&r2=507831
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/index.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/index.xml Wed Feb 14 22:24:57 2007
@@ -48,8 +48,8 @@
                        <li><a href="guide-sso.html">Guide to using Jetspeed-2 
single sign-on</a></li>
                        <li><a href="guide-user-attributes.html">Guide to 
defining user attributes (PLT.17 user information configuration)</a></li>
                        <li><a href="guide-profiler.html">Guide to using 
profilers</a></li>
-                       <li><a href="guide-migration.html">Guide to Data 
Migration from 2.0 to 2.1</a></li>
-                       
+                       <li><a href="guide-aggregation.html">Guide to 
Aggregation</a></li>
+                       <li><a href="guide-migration.html">Guide to Data 
Migration from 2.0 to 2.1</a></li>                     
                </ul>
                </subsection>
                <subsection name="Portal Development Guides">



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to