portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dlest...@apache.org
Subject svn commit: r349331 - in /portals/jetspeed-2/trunk: components/cm/xdocs/ components/deploy-tool/xdocs/ components/deploy-tool/xdocs/images/ components/prefs/xdocs/ xdocs/guides/
Date Sun, 27 Nov 2005 23:21:30 GMT
Author: dlestrat
Date: Sun Nov 27 15:21:22 2005
New Revision: 349331

URL: http://svn.apache.org/viewcvs?rev=349331&view=rev
Log:
http://issues.apache.org/jira/browse/JS2-414

Docs continued.  Deploy tool docs added.

Added:
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/app-server-mgr-c.gif   (with
props)
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-event-listener-c.gif
  (with props)
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-assembly.gif
  (with props)
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-c.gif   (with
props)
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/jetspeed-deploy-c.gif   (with
props)
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/index.xml
Modified:
    portals/jetspeed-2/trunk/components/cm/xdocs/index.xml
    portals/jetspeed-2/trunk/components/deploy-tool/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
    portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml
    portals/jetspeed-2/trunk/xdocs/guides/index.xml

Modified: 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=349331&r1=349330&r2=349331&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/cm/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/cm/xdocs/index.xml Sun Nov 27 15:21:22 2005
@@ -17,6 +17,9 @@
 <document>
     <properties>
         <title>Jetspeed-2 Component Manager</title>
+        <authors>
+            <person name="David Le Strat" email="dlestrat@apache.org" />
+        </authors>
     </properties>
     <body>
         <section name="Component Manager Overview">

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml?rev=349331&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml (added)
+++ portals/jetspeed-2/trunk/components/deploy-tool/xdocs/deploy-tools.xml Sun Nov 27 15:21:22
2005
@@ -0,0 +1,87 @@
+<?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 Deploy Tools</title>
+        <authors>
+            <person name="David Le Strat" email="dlestrat@apache.org" />
+        </authors>
+    </properties>
+    <body>
+        <section name="The Role of Jetspeed-2 Deploy Tools">
+        	<subsection name="JetspeedDeploy and the DeploymentManager">
+        	<p>
+        	<code>JetspeedDeploy</code> prepares portlet applications for deployment
within Jetspeed-2. When a new
+        	portlet deployment event is registered, the <code>DeployPortletAppEventListener</code>
invokes <code>JetspeedDeploy</code>
+        	to prepare the portlet application for deployment.
+        	<pre>
+    new JetspeedDeploy(event.getPath(), toFile.getAbsolutePath(), stripLoggers);</pre>
+        	</p>
+        	<p>
+        	<code>JetspeedDeploy</code> copies the web application archives (.war)
from the input directory to the
+        	output directory and parses the <code>web.xml</code>, <code>portlet.xml</code>,
and <code>context.xml</code>
+        	to ensure their compliance with the Jetspeed-2 portal engine. 
+        	</p>
+        	<p>
+            <img src="images/jetspeed-deploy-c.gif" border="0"/><br/><br/>
+            </p>
+            <p>
+            <code>JetspeedDeploy</code> invokes the <code>JetspeedWebApplicationRewriter</code>
to infuse the <code>web.xml</code>
+            with the <code>JetspeedContainer</code> servlet if it does not already
exist:
+            <pre>
+  &lt;servlet&gt;
+    &lt;servlet-name&gt;JetspeedContainer&lt;/servlet-name&gt;
+    &lt;display-name&gt;Jetspeed Container&lt;/display-name&gt;
+    &lt;description&gt;MVC Servlet for Jetspeed Portlet Applications&lt;/description&gt;
+    &lt;servlet-class&gt;org.apache.jetspeed.container.JetspeedContainerServlet&lt;/servlet-class&gt;
+    &lt;init-param&gt;
+      &lt;param-name&gt;contextName&lt;/param-name&gt;
+      &lt;param-value&gt;${portlet-application-name}&lt;/param-value&gt;
+    &lt;/init-param&gt;
+    &lt;load-on-startup&gt;0&lt;/load-on-startup&gt;
+  &lt;/servlet&gt;
+  ...
+  &lt;servlet-mapping&gt;
+    &lt;servlet-name&gt;JetspeedContainer&lt;/servlet-name&gt;
+    &lt;url-pattern&gt;/container/*&lt;/url-pattern&gt;
+  &lt;/servlet-mapping&gt;</pre>
+            </p>
+            <p>
+            In the same fashion, the <code>JetspeedDeploy</code> invokes the
<code>JetspeedContextRewriter</code> to manipulate
+            a portlet application <code>context.xml</code> file.  For more information
about Tomcat <code>context.xml</code>, 
+            see <a href="http://tomcat.apache.org/tomcat-5.0-doc/deployer-howto.html#Context%20descriptors">tomcat's
documentation</a>.
+            </p>
+        	</subsection>
+            <subsection name="JetspeedDeploy Standalone Usage">
+            <p>
+            <code>JetspeedDeploy</code> can also be invoke through the command
line:
+            <pre>
+    java -jar jetspeed-deploy-tools-&lt;version&gt;.jar -s inputWarPath outputWarPath
+            </pre>
+            where:
+            <ul>
+            <li><code>-s</code>: flag indicating whether or not to strip
to loggers from the application. When the flag is present, the
+            loggers available in the application will be removed.</li>
+            <li><code>inputWarPath</code>: the path of the war to process.</li>
+            <li><code>outputWarPath</code>: the path of the processed war.</li>
+            </ul>
+            </p>  
+            </subsection>
+        </section>
+    </body>
+</document>
+

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/app-server-mgr-c.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/app-server-mgr-c.gif?rev=349331&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/app-server-mgr-c.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-event-listener-c.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-event-listener-c.gif?rev=349331&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-event-listener-c.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-assembly.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-assembly.gif?rev=349331&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-assembly.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-c.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-c.gif?rev=349331&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/deployment-mgr-c.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/jetspeed-deploy-c.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/jetspeed-deploy-c.gif?rev=349331&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/images/jetspeed-deploy-c.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/index.xml?rev=349331&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/components/deploy-tool/xdocs/index.xml (added)
+++ portals/jetspeed-2/trunk/components/deploy-tool/xdocs/index.xml Sun Nov 27 15:21:22 2005
@@ -0,0 +1,86 @@
+<?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 Deploy Tools</title>
+        <authors>
+            <person name="David Le Strat" email="dlestrat@apache.org" />
+        </authors>
+    </properties>
+    <body>
+        <section name="Jetspeed-2 Deployment Overview">
+        	<subsection name="Deploying Portlets in Jetspeed-2: An End User View">
+        	<p>
+        	Deploying custom portlets in Jetspeed-2 is simple.  Portlets are very similar to
servlets.
+        	They require a deployment descriptor, <code>portlet.xml</code> which
goes in <code>WEB-INF</code>
+            and need to be packaged in a war-like format. You can find quite a few example
<code>portlet.xml</code> files within the Jetspeed-2 source tree.
+            For starters take a look at the one under <code>/portal/src/webapp/WEB-INF</code>.
 In order to deploy a portlet, Jetspeed-2 requires the user
+            to follow those steps:
+            <ol>
+            <li>Build you portlet as a portlet application just as you would a web
application.</li>
+            <li>Package your portlet application into a .war file.</li>
+            <li>Copy the .war file to Jetspeed's deployment directory, by default this
is <code>WEB-INF/deploy</code>.
+            Jetspeed will take care of automatically deplying the portlet into the portlet
registry and will also deploy the portlet
+            as a web application into the app server Jetspeed is deployed to.</li>
+            <li>The easiest way to view your portlet is to add an entry to the <code>default-page.psml</code>
under <code>jetspeed/WEB-INF/pages</code>.
+            The id for the portlet fragment uses a unique combination of <code>${portlet.application.id}::${portlet.name}</code>
+            where <code>${portlet.application.id}</code> is the actual name of
the war file (minus the ".war") that contains your portlet app and
+            <code>${portlet.name}</code> needs to be the value in the portlet
name tags, <code>&lt;portlet-name&gt;MyPortlet&lt;/portlet-name&gt;</code>.
+            Changes to the psml will be picked up automatically and you should now be able
to view your portlet!
+            </li>
+            </ol>
+			</p>        	
+        	</subsection>
+        	<subsection name="Portlet Deployment: How Does it Work?">
+        	<p>
+        	The component hierarchy below describes the assembly dependencies supporting Jetspeed-2
deployment functionality.
+        	</p>
+        	<p>
+            <img src="images/deployment-mgr-assembly.gif" border="0"/><br/><br/>
+            </p>
+        	<p>
+        	The <code>DeploymentManager</code> is configured with the properties
specified in
+        	<code>WEB-INF/conf/jetspeed.properties</code>:
+        	<ul>
+        	<li><code>autodeployment.staging.dir</code>: The directory scanned
for autodeployment.</li>
+        	<li><code>autodeployment.delay</code>: The frequency of the deploy
directory scanning.</li>
+        	</ul>
+        	The <code>DeploymentManager</code> is also configured with 2 types of
<code>DeploymentEventListener</code>:
+        	</p>
+        	<p>
+            <img src="images/deployment-event-listener-c.gif" border="0"/><br/><br/>
+            </p>
+            <p>
+            <ul>
+            <li>The <code>DeployPortletAppEventListener</code> handles
the hot deployment of portlet applications.</li>
+            <li>The <code>DeployDecoratorEventListener</code>: handles
the hot deployment of decorators. See 
+            <a href="../../guides/guide-decorators.html">guide to decorators</a>
for more information.</li>
+            </ul>
+            </p>
+        	<p>
+        	Jetspeed-2 provides a <code>StandardDeploymentManager</code>.  The <code>StandardDeploymentManager</code>
leverages
+        	a <code>FileSystemScanner</code> to scan for new assets to deploy. 
It leverages Jetspeed-2 
+        	<a href="deploy-tools.html">deploy tools</a> to prepare portlet applications
prior to deployment.
+            </p>
+            <p>
+            <img src="images/deployment-mgr-c.gif" border="0"/><br/><br/>
+            </p>
+            </subsection>
+        </section>
+    </body>
+</document>
+

Modified: portals/jetspeed-2/trunk/components/deploy-tool/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/deploy-tool/xdocs/navigation.xml?rev=349331&r1=349330&r2=349331&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/deploy-tool/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/deploy-tool/xdocs/navigation.xml Sun Nov 27 15:21:22
2005
@@ -17,9 +17,15 @@
 <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-deploy-tools.pdf" img="../../images/pdf.gif"
/>
         </links>
+    	<menu name="Jetspeed-2 Deploy Tools Documentation">
+    	    <item name="Jetspeed-2 Deployment Overview" href="index.html" />
+    		<item name="Deploy Tools Overview" href="deploy-tools.html" />
+    	    <item name="Tasks" href="tasks.html" />
+        </menu>
     </body>
 </project>

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=349331&r1=349330&r2=349331&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml (original)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml Sun Nov 27 15:21:22 2005
@@ -17,6 +17,9 @@
 <document>
     <properties>
         <title>Jetspeed-2 Preferences</title>
+        <authors>
+            <person name="David Le Strat" email="dlestrat@apache.org" />
+        </authors>
     </properties>
     <body>
         <section name="Preferences Overview">

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=349331&r1=349330&r2=349331&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml Sun Nov 27 15:21:22 2005
@@ -84,6 +84,25 @@
             <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><br/>
+		<table>
+          <tr>
+          	<th colspan="2">Jetspeed-2 Deploy Tools - Artifact Id: jetspeed-deploy-tools</th>
+          </tr>
+          <tr>
+            <th>Component Name</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td><a href="../multiproject/jetspeed-deploy-tools/deploy-tools.html"><code>JetspeedDeploy</code></a></td>
+            <td><code>JetspeedDeploy</code> prepares portlet applications
prior to being deployed in Jetspeed-2.  More information can be found in the 
+            <a href="../multiproject/jetspeed-deploy-tools/deploy-tools.html"><code>JetspeedDeploy</code>
documentation</a>.</td>
+          </tr>
+          <tr>
+            <td><a href="../multiproject/jetspeed-deploy-tools/index.html"><code>DeploymentManager</code></a></td>
+            <td>The <code>DeploymentManager</code> listens for new portal
assets (portlets, decorators) to be deployed.  An overview of how deployment
+            works in Jetspeed-2 can be found <a href="../multiproject/jetspeed-deploy-tools/index.html">here</a>.</td>
+          </tr>
 		</table>
 		</subsection>
 		</section>

Modified: portals/jetspeed-2/trunk/xdocs/guides/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/guides/index.xml?rev=349331&r1=349330&r2=349331&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/index.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/index.xml Sun Nov 27 15:21:22 2005
@@ -62,6 +62,7 @@
 		<subsection name="Guides to Jetspeed-2 Tools">
 		<ul>
 			<li><a href="guide-jpt.html">Guide to Jetspeed-2 Power Tools</a></li>
+			<li><a href="../multiproject/jetspeed-deploy-tools/index.html">Guide to Jetspeed-2
Portlet Application Deployment</a></li>
 			<li><a href="../j2-maven-plugin.html">Guide to Jetspeed-2 Maven Plugin</a></li>
		
 		</ul>
 		</subsection>



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org


Mime
View raw message