Author: dlestrat
Date: Tue Dec 6 12:45:07 2005
New Revision: 354542
URL: http://svn.apache.org/viewcvs?rev=354542&view=rev
Log:
http://issues.apache.org/jira/browse/JS2-414#action_12359466
Pipeline docs + start of portal component
Added:
portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-assembly.gif
(with props)
portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-c.gif
(with props)
portals/jetspeed-2/trunk/components/portal/xdocs/images/valve-c.gif (with
props)
portals/jetspeed-2/trunk/components/portal/xdocs/index.xml
portals/jetspeed-2/trunk/components/portal/xdocs/pipeline.xml
portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml
portals/jetspeed-2/trunk/xdocs/guides/images/j2-overview.gif (with props)
Modified:
portals/jetspeed-2/trunk/components/portal/xdocs/navigation.xml
portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
portals/jetspeed-2/trunk/xdocs/guides/index.xml
Added:
portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-assembly.gif
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-assembly.gif?rev=354542&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-assembly.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-c.gif
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-c.gif?rev=354542&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
portals/jetspeed-2/trunk/components/portal/xdocs/images/pipeline-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/trunk/components/portal/xdocs/images/valve-c.gif
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/portal/xdocs/images/valve-c.gif?rev=354542&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/trunk/components/portal/xdocs/images/valve-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/trunk/components/portal/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/portal/xdocs/index.xml?rev=354542&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/components/portal/xdocs/index.xml (added)
+++ portals/jetspeed-2/trunk/components/portal/xdocs/index.xml Tue Dec 6
12:45:07 2005
@@ -0,0 +1,38 @@
+<?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 Portal</title>
+ <authors>
+ <person name="David Le Strat" email="[EMAIL PROTECTED]" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Portal Overview">
+ <p>
+ The core portal components are:
+ <ul>
+ <li>The portal engine</li>
+ <li>The <a href="pipeline.html">request pipeline</a></li>
+ <li>The aggregation engine</li>
+ <li>The portlet container engine integration</li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
+
Modified: portals/jetspeed-2/trunk/components/portal/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/portal/xdocs/navigation.xml?rev=354542&r1=354541&r2=354542&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/portal/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/portal/xdocs/navigation.xml Tue Dec 6
12:45:07 2005
@@ -17,9 +17,14 @@
<project>
<body>
<links>
- <item name="Jetspeed 2" href="../../index.html" />
+ <item name="Components Guide"
href="../../guides/guide-components.html" />
+ <item name="Jetspeed 2" href="../../index.html" />
<!-- Cannot access ${pom.id}... Hard coding pdf name. -->
<item name="PDF Documentation" href="/jetspeed-portal.pdf"
img="../../images/pdf.gif" />
</links>
+ <menu name="Jetspeed-2 Portal Documentation">
+ <item name="Portal Overview" href="index.html" />
+ <item name="Request Pipeline" href="pipeline.html" />
+ </menu>
</body>
</project>
Added: portals/jetspeed-2/trunk/components/portal/xdocs/pipeline.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/portal/xdocs/pipeline.xml?rev=354542&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/components/portal/xdocs/pipeline.xml (added)
+++ portals/jetspeed-2/trunk/components/portal/xdocs/pipeline.xml Tue Dec 6
12:45:07 2005
@@ -0,0 +1,88 @@
+<?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 Portal</title>
+ <authors>
+ <person name="David Le Strat" email="[EMAIL PROTECTED]" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Request Pipeline">
+ <p>
+ In Jetspeed-2, a request pipeline perform individual operations to
the request.
+ </p>
+ <subsection name="Pipeline Concepts">
+ <p>
+ A <code>Pipeline</code> is made of <code>Value</code> chained
together in a chain of reponsiblity pattern.
+ The <code>JetspeedPipeline</code> implementation assembles a
ordered list of <code>Valves</code> that are
+ processed sequentially.
+ <br/><br/>
+ <img src="images/pipeline-c.gif" border="0"/><br/><br/>
+ <img src="images/pipeline-assembly.gif" border="0"/>
+ </p>
+ </subsection>
+ <subsection name="Jetspeed-2 Valves">
+ <p>
+ Jetspeed-2 provides various type of <code>Valve</code> as
illustrated below:<br/><br/>
+ <img src="images/valve-c.gif" border="0"/><br/>
+ The above valves serve the following purpose:
+ <table>
+ <tr>
+ <th>Valve Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>ActionValve</td>
+ <td>Check if <code>PortletAction</code> needs to be
processed and process it, if required.
+ Used in the portlet pipeline.</td>
+ </tr>
+ <tr>
+ <td>AggregateValve</td>
+ <td>Invokes all Layout components in render mode to
aggregate the generated contents and
+ send the result to the client.</td>
+ </tr>
+ <tr>
+ <td>CapabilityValve</td>
+ <td>Identifies the browser and adds a
<code>CapabilityMap</code> to the <code>RequestContext</code>.</td>
+ </tr>
+ <tr>
+ <td>CleanupValve</td>
+ <td>Look for JSP pages that were pushed onto the
<code>org.apache.jetspeed.renderStack</code>
+ request attribute, and attempts to
include them.</td>
+ </tr>
+ <tr>
+ <td>LoginValidationValve</td>
+ <td>Checks if a login attempt failed and determines the
cause.</td>
+ </tr>
+ <tr>
+ <td>PasswordCredentialValve</td>
+ <td>Checks the PasswordCredential (only once) after a
User is logged in and redirects to a
+ change password page if necessary.</td>
+ </tr>
+ <tr>
+ <td>SecurityValve</td>
+ <td>Authenticates the user or redirects to Login if
necessary, add
+ authenticated Subject to the
<code>RequestContext</code>.</td>
+ </tr>
+ </table>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
+
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml?rev=354542&r1=354541&r2=354542&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml Tue Dec 6
12:45:07 2005
@@ -121,6 +121,20 @@
</table><br/>
<table>
<tr>
+ <th colspan="2">Jetspeed-2 Portal - Artifact Id:
jetspeed-portal</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-portal/pipeline.html"><code>Pipeline</code></a></td>
+ <td>The <code>Pipeline</code> orchestrates the <code>Valve</code>
that are performing atomic operation on a
+ Jetspeed-2 request.</td>
+ </tr>
+ </table><br/>
+ <table>
+ <tr>
<th colspan="2">Jetspeed-2 Preferences - Artifact Id:
jetspeed-prefs</th>
</tr>
<tr>
Added: portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml?rev=354542&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml (added)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml Tue Dec 6
12:45:07 2005
@@ -0,0 +1,39 @@
+<?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 Pipeline</title>
+ <subtitle>Documentation for Jetspeed-2 Pipeline</subtitle>
+ <authors>
+ <person name="David Le Strat" email="[EMAIL PROTECTED]"
/>
+ </authors>
+ </properties>
+ <body>
+ <section name="Jetspeed-2 Pipeline">
+ <p>As described below, one of key component of the
Jetspeed-2 portal engine is its request pipeline.
+ <br/><br/>
+ <img src="images/j2-overview.gif" border="0"/>
+ <br/>
+ In Jetspeed-2 request are processed through a series of
<code>Valve</code> assembled together as a
+ pipeline. For detailed information about Jetspeed-2
pipeline,
+ <a
href="../multiproject/jetspeed-portal/pipeline.html">click here</a>.
+ </p>
+ </section>
+
+ </body>
+</document>
+
Added: portals/jetspeed-2/trunk/xdocs/guides/images/j2-overview.gif
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/images/j2-overview.gif?rev=354542&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/trunk/xdocs/guides/images/j2-overview.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: portals/jetspeed-2/trunk/xdocs/guides/index.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/index.xml?rev=354542&r1=354541&r2=354542&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/index.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/index.xml Tue Dec 6 12:45:07 2005
@@ -33,6 +33,7 @@
</subsection>
<subsection name="Guides to Portal Concepts">
<ul>
+ <li><a href="guide-pipeline.html">Guide to Jetspeed-2
pipeline</a></li>
<li><a href="guide-decorators.html">Guide to
decorators</a></li>
<li><a href="guide-layouts.html">Guide to
layouts</a></li>
</ul>
@@ -56,6 +57,7 @@
<li><a href="guide-psml.html">Guide to PSML</a></li>
<li><a href="guide-site.html">Guide to working with a
Jetspeed-2 site</a></li>
<li><a href="guide-l10n.html">Guide to localization
with Jetspeed-2</a></li>
+ <li><a href="guide-simple-portlet.html">Guide to a very
simple portlet with Jetspeed-2</a></li>
<li><a href="guide-portlet-bridges.html">Guide to
portlet bridges</a></li>
</ul>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
