Author: dlestrat
Date: Sun Nov 27 08:55:47 2005
New Revision: 349257
URL: http://svn.apache.org/viewcvs?rev=349257&view=rev
Log:
http://issues.apache.org/jira/browse/JS2-414
Docs continued. Component guide and CM docs.
Added:
portals/jetspeed-2/trunk/components/cm/xdocs/images/spring-component-manager-c.gif
(with props)
portals/jetspeed-2/trunk/components/cm/xdocs/index.xml
Modified:
portals/jetspeed-2/trunk/components/cm/xdocs/navigation.xml
portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml
portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml
portals/jetspeed-2/trunk/maven.xml
portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
Added:
portals/jetspeed-2/trunk/components/cm/xdocs/images/spring-component-manager-c.gif
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/cm/xdocs/images/spring-component-manager-c.gif?rev=349257&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
portals/jetspeed-2/trunk/components/cm/xdocs/images/spring-component-manager-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/trunk/components/cm/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/cm/xdocs/index.xml?rev=349257&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/components/cm/xdocs/index.xml (added)
+++ portals/jetspeed-2/trunk/components/cm/xdocs/index.xml Sun Nov 27 08:55:47
2005
@@ -0,0 +1,43 @@
+<?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 Component Manager</title>
+ </properties>
+ <body>
+ <section name="Component Manager Overview">
+ <p>
+ The <code>ComponentManager</code> provides a layer of abstraction
on top of the component framework that
+ will be used by Jetspeed-2. This provides a flexible architecture
where the component framework used can
+ easily be "swapped". By default Jetspeed-2 uses the <a
href="http://www.springframework.com";>spring
+ framework</a>.
+ </p>
+ <subsection name="Component Manager with Spring">
+ <p>
+ The <code>ComponentManager</code> delegates the initialization of
the component framework engine
+ to an implementation specific to the component framework as
illustrated below. The <code>SpringComponentManager</code>
+ is responsible for initializing the spring engine and calls to
spring components within the Jetspeed-2 engines are wrapped
+ behind generic methods such as <code>getComponent()</code>.
+ </p>
+ <p>
+ <img src="images/spring-component-manager-c.gif"
border="0"/><br/><br/>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
+
Modified: portals/jetspeed-2/trunk/components/cm/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/cm/xdocs/navigation.xml?rev=349257&r1=349256&r2=349257&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/cm/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/cm/xdocs/navigation.xml Sun Nov 27
08:55:47 2005
@@ -17,11 +17,13 @@
<project>
<body>
<links>
+ <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-cm.pdf"
img="../../images/pdf.gif" />
</links>
- <menu name="Misc.">
+ <menu name="Jetspeed-2 Component Manager Documentation">
+ <item name="Component Manager Overview" href="index.html" />
<item name="Tasks" href="tasks.html" />
</menu>
</body>
Modified: portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml?rev=349257&r1=349256&r2=349257&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml Sun Nov 27
08:55:47 2005
@@ -16,7 +16,7 @@
-->
<document>
<properties>
- <title>Jetspeed 2 Preferences</title>
+ <title>Jetspeed-2 Preferences</title>
</properties>
<body>
<section name="Preferences Overview">
Modified: portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml?rev=349257&r1=349256&r2=349257&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml Sun Nov 27
08:55:47 2005
@@ -17,11 +17,12 @@
<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-prefs.pdf"
img="../../images/pdf.gif" />
</links>
- <menu name="Misc.">
+ <menu name="Jetspeed-2 Preferences Documentation">
<item name="Preferences Overview" href="index.html" />
<item name="Tasks" href="tasks.html" />
</menu>
Modified: portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml?rev=349257&r1=349256&r2=349257&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml Sun Nov
27 08:55:47 2005
@@ -17,11 +17,12 @@
<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-security.pdf"
img="../../images/pdf.gif" />
</links>
- <menu name="Jetspeed 2 Security Documentation">
+ <menu name="Jetspeed-2 Security Documentation">
<item name="Overview" href="index.html" />
<item name="Architecture Overview" href="arch.html" />
<item name="Authentication" href="atn.html">
Modified: portals/jetspeed-2/trunk/maven.xml
URL:
http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/maven.xml?rev=349257&r1=349256&r2=349257&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/maven.xml (original)
+++ portals/jetspeed-2/trunk/maven.xml Sun Nov 27 08:55:47 2005
@@ -146,6 +146,8 @@
<fileset dir="${basedir}/xdocs/style"/>
</copy>
<copy toDir="${directory}/images">
+ <fileset file="${basedir}/xdocs/images/h3.jpg"/>
+ <fileset file="${basedir}/xdocs/images/h5.jpg"/>
<fileset file="${basedir}/xdocs/images/breadcrumbs.jpg"/>
</copy>
</j:forEach>
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=349257&r1=349256&r2=349257&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml Sun Nov 27
08:55:47 2005
@@ -54,16 +54,37 @@
<img src="images/jetspeedservlet-c.gif" border="0"/>
</p>
<p>
- The <i>JetspeedServlet</i> is configured is the portal
application <i>web.xml</i> to load at startup. The
<i>initializeComponentManager</i>
- method loads the <a
href="guide-portal-assembly.html">assembly</a> for the given component
framework. The <i>JetspeedEngine</i> is then
+ The <code>JetspeedServlet</code> is configured in the portal
application <i>web.xml</i> to load at startup. The
<code>initializeComponentManager</code>
+ method loads the <a
href="guide-portal-assembly.html">assembly</a> for the given component
framework. The default implementation
+ of <code>initializeComponentManager</code> supports the <a
href="http://www.springframework.com";>spring framework</a> as a component
framework
+ and assembles the xml files located under
<code>WEB-INF/assembly</code> to initialize the spring engine. The
<i>JetspeedEngine</i> is then
constructed with the proper component manager.
<pre>
engine = new JetspeedEngine(properties, applicationRoot, config,
initializeComponentManager(config,
applicationRoot, properties));
</pre>
</p>
+ <p>
+ In order to support another component framework, developers
should override the <code>initializeComponentManager</code> implementation.
+ </p>
</subsection>
<subsection name="Jetspeed-2 Core Components">
+ <table>
+ <tr>
+ <th colspan="2">Jetspeed-2 Component Manager - Artifact Id:
jetspeed-cm</th>
+ </tr>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a
href="../multiproject/jetspeed-cm/index.html"><code>ComponentManager</code></a></td>
+ <td>The <code>ComponentManager</code> provides a generic layer of
abstraction on top of the component framework
+ being used. The default <code>ComponentManager</code>
implementation in Jetspeed-2 is the
+ <code>SpringComponentManager</code>. More information can be
found in the
+ <a
href="../multiproject/jetspeed-cm/index.html"><code>ComponentManager</code>
documentation</a>.</td>
+ </tr>
+ </table>
</subsection>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
