Author: mmcallis
Date: 2008-02-13 20:02:56 -0500 (Wed, 13 Feb 2008)
New Revision: 9959
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
5.2.1.5. Building your Portlet
5.2.1.6. Deploying your Portlet
revising and fixing up the spelling errors I
introduced
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-14
00:37:37 UTC (rev 9958)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-14
01:02:56 UTC (rev 9959)
@@ -142,7 +142,7 @@
<title>Introduction</title>
<para>
This section details deploying your first portlet in JBoss Portal. Before
proceeding, download the <ulink
-
url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles...
from <ulink
url="http://labs.jboss.com/portletswap/">JBoss
PortletSwap</ulink>.
+
url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles...
from <ulink
url="http://labs.jboss.com/portletswap/">JBoss
PortletSwap</ulink>.
</para>
</sect3>
<sect3>
@@ -521,7 +521,7 @@
<sect3 id="first_portlet_build">
<title>Building your Portlet</title>
<para>
- A pre-compiled
<filename>HelloWorldPortlet/helloworldportlet.war</filename> file is created
after extracting the <filename>HelloWorldPorlet.zip</filename> file. To
manually build the <filename>helloworldportlet.war</filename> file:
+ A pre-compiled
<filename>HelloWorldPortlet/helloworldportlet.war</filename> file is created
after extracting the <filename>HelloWorldPortlet.zip</filename> file. To
manually build the <filename>helloworldportlet.war</filename> file:
</para>
<para>
<orderedlist>
@@ -545,7 +545,7 @@
</orderedlist>
</para>
<para>
- Expanding the <filename>helloworldportlet.war</filename> allows you to
deploy the portlet as an expanded directory, which makes development easier. As well, it
gives you access to the XML descriptors, resource files, JSF, and JSP pages. To expand the
<filename>helloworldportlet.war</filename> file:
+ Expanding the <filename>helloworldportlet.war</filename> file allows
you to deploy the portlet as an expanded directory, which makes development easier. As
well, it gives you access to the XML descriptors, resource files, JSF, and JSP pages. To
expand the <filename>helloworldportlet.war</filename> file:
</para>
<para>
<orderedlist>
@@ -583,26 +583,49 @@
</para>
</sect3>
<sect3>
- <title>Deploying your portlet</title>
+ <title>Deploying your Portlet</title>
<para>
- Deploying a portlet is as simple as copying/moving
<literal>helloworldportlet.war</literal>
- to your server <literal>deploy</literal> directory. Doing this
on a running instance of JBoss Portal and
- application server, will trigger a
<emphasis>hot-deploy</emphasis> of your portlet:
- <programlisting><![CDATA[18:25:56,366 INFO [Server] JBoss (MX
MicroKernel) [4.2.2.GA (build:
- CVSTag=JBoss_4_0_5_GA date=2006000000)] Started in 1m:3s:688ms
-18:26:21,147 INFO [TomcatDeployer] deploy, ctxPath=/helloworldportlet,
-
warUrl=.../tmp/deploy/tmp35219helloworldportlet-exp.war/]]></programlisting>
- Pointing your browser to <ulink
url="http://localhost:8080/portal/">http://localhost:8080/portal/</ulink>,
- should yield a view of our HelloWorldPortlet, added to the default page of
Portal:
-
- <!-- Touching the <filename>web.xml</filename> file will let any
live JBoss AS instance know that it needs to hot re-deploy the web application. -->
+ If you did not expand the <filename>helloworldportlet.war</filename>
file, copy the <filename>HelloWorldPortlet/helloworldportlet.war</filename>
file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename>
directory. If you expanded the <filename>helloworldportlet.war</filename>
file, copy the
<filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename>
directory into the correct JBoss AS or JBoss EAP <filename>deploy/</filename>
directory. For example, if you are using JBoss AS, copy the file or directory into the
<filename>$JBOSS_HOME/server/default/deploy/</filename> directory.
+ </para>
+ <para>
+ Performing this step on a running instance of JBoss AS or JBoss EAP, and JBoss
Portal, will trigger a hot-deploy of the portlet:
+ </para>
+ <para>
+<screen><![CDATA[
+INFO [TomcatDeployer] deploy, ctxPath=/helloworldportlet,
+ warUrl=.../tmp/deploy/tmp35219helloworldportlet-exp.war/]]>
+</screen>
+ </para>
+ <para>
+ To see the HelloWorldPortlet, navigate to <ulink
url="http://localhost:8080/portal/">http://localhost:8080/portal/</ulink>,
or, if the main JBoss Portal page is already open, refresh the page. The HelloWorldPortlet
is added to the default page of JBoss Portal:
+ </para>
+ <para>
<mediaobject>
<imageobject>
<imagedata align="center"
fileref="images/tutorials/first_portlet/output.png"
valign="middle"/>
</imageobject>
</mediaobject>
</para>
- </sect3>
+ <para>
+ To re-deploy the portlet, for example, if you have made changes to any of the XML
descriptors, touch the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml</filename>
file. On Linux, run the following command to re-deploy the HelloWorldPortlet:
+ </para>
+ <para>
+<screen>
+touch
$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml
+</screen>
+ </para>
+ <para>
+ Re-deploying the HelloWorldPortlet will produce the following output on the JBoss AS
or JBoss EAP console:
+ </para>
+ <para>
+<screen><![CDATA[
+INFO [TomcatDeployer] undeploy, ctxPath=/helloworldportlet,
+warUrl=.../deploy/helloworldportlet.war/
+INFO [TomcatDeployer] deploy, ctxPath=/helloworldportlet,
+warUrl=.../deploy/helloworldportlet.war/]]>
+</screen>
+</para>
+</sect3>
</sect2>
<sect2>
<title>A Simple JSP Portlet</title>