You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by vk...@apache.org on 2008/10/28 11:07:55 UTC
svn commit: r708500 - in /portals/jetspeed-2/portal/trunk/xdocs/components:
jetspeed-capability/images/ jetspeed-deploy-tools/
jetspeed-deploy-tools/images/
Author: vkumar
Date: Tue Oct 28 03:07:54 2008
New Revision: 708500
URL: http://svn.apache.org/viewvc?rev=708500&view=rev
Log:
Moving components jetspeed-deploy-tools xdoc document to new location
Added:
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-c.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-db.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/deploy-tools.xml (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/app-server-mgr-c.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-event-listener-c.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-assembly.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-c.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/jetspeed-deploy-c.gif (with props)
portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/index.xml (with props)
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-c.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-db.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-db.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-capability/images/capabilities-db.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/deploy-tools.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/deploy-tools.xml?rev=708500&view=auto
==============================================================================
--- portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/deploy-tools.xml (added)
+++ portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/deploy-tools.xml Tue Oct 28 03:07:54 2008
@@ -0,0 +1,89 @@
+<?xml version="1.0" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+ <source>
+ new JetspeedDeploy(event.getPath(), toFile.getAbsolutePath(), stripLoggers);
+ </source>
+ </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:
+ <source>
+ <servlet>
+ <servlet-name>JetspeedContainer</servlet-name>
+ <display-name>Jetspeed Container</display-name>
+ <description>MVC Servlet for Jetspeed Portlet Applications</description>
+ <servlet-class>org.apache.jetspeed.container.JetspeedContainerServlet</servlet-class>
+ <init-param>
+ <param-name>contextName</param-name>
+ <param-value>${portlet-application-name}</param-value>
+ </init-param>
+ <load-on-startup>0</load-on-startup>
+ </servlet>
+ ...
+ <servlet-mapping>
+ <servlet-name>JetspeedContainer</servlet-name>
+ <url-pattern>/container/*</url-pattern>
+ </servlet-mapping>
+ </source>
+ </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:
+ <source>
+ java -jar jetspeed-deploy-tools-<version>.jar -s inputWarPath outputWarPath
+ </source>
+ 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>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/deploy-tools.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/app-server-mgr-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/app-server-mgr-c.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/app-server-mgr-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-event-listener-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-event-listener-c.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-event-listener-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-assembly.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-assembly.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-assembly.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-c.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/deployment-mgr-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/jetspeed-deploy-c.gif
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/jetspeed-deploy-c.gif?rev=708500&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/images/jetspeed-deploy-c.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/index.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/index.xml?rev=708500&view=auto
==============================================================================
--- portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/index.xml (added)
+++ portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/index.xml Tue Oct 28 03:07:54 2008
@@ -0,0 +1,86 @@
+<?xml version="1.0" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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><portlet-name>MyPortlet</portlet-name></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>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/trunk/xdocs/components/jetspeed-deploy-tools/index.xml
------------------------------------------------------------------------------
svn:keywords = Id
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org