7:12 p.m.
Author: pete.muir(a)jboss.org
Date: 2008-12-18 20:12:08 -0500 (Thu, 18 Dec 2008)
New Revision: 561
Modified:
doc/en/modules/intro.xml
Log:
Much more in depth docs for RI
Modified: doc/en/modules/intro.xml
===================================================================
--- doc/en/modules/intro.xml 2008-12-19 00:05:00 UTC (rev 560)
+++ doc/en/modules/intro.xml 2008-12-19 01:12:08 UTC (rev 561)
@@ -537,57 +537,130 @@
<title>Using the Web Beans Reference Implementation</title>
<para>
- The Web Beans RI currently comes with a two examples,
+ The Web Beans RI comes with a two examples,
<literal>webbeans-numberguess</literal> (a war example, containing
only
simple beans) and <literal>webbeans-translator</literal> (an ear
example,
containing enterprise beans).
</para>
+
+ <para>
+ Currently, the Web Beans RI only runs on JBoss Application Server 5.
+ You'll need to download JBoss AS 5.0.0.GA from
+ <ulink
url="http://www.jboss.org/jbossas/downloads/">jboss.org</...;,
+ and unzip it. For example:
+ </para>
+
+ <programlisting><![CDATA[$ cd /Applications
+$ unzip ~/jboss-5.0.0.GA.zip]]></programlisting>
<para>
- To run the example on JBoss AS 5.0.0.GA, you need to add the Web Beans RI
- deployer to JBoss 5, and update JBoss EJB3. First, set the path to
- JBoss 5 in <literal>build.properties</literal>. Make sure you have the
- <literal>ANT_HOME</literal> environment variable set, and pointing to
your
- ant install. Then, run <literal>ant install-jboss5</literal>.
+ Next, download the Web Beans RI from
+ <ulink
url="http://seamframework.org/WebBeans">seamframework.org<...;,
+ and unzip it. For example
</para>
+
+ <programlisting><![CDATA[$ cd ~/
+$ unzip ~/webbeans-1.0.0.ALPHA1.zip]]></programlisting>
<para>
- To deploy the example to JBoss AS 5, change into
- <literal>examples/numberguess</literal> directory or the
- <literal>examples/translator</literal> directory and choose between:
+ As Web Beans is a new piece of software, you need to update JBoss AS to
+ run the Web Beans RI. Future versions of JBoss AS will include these
+ updates, and this step won't be necessary.
</para>
+
+ <info>
+ <para>
+ Currently, two updates are needed. Firstly, a new deployer,
+ <literal>webbeans.deployer</literal> is added. This adds supports
for
+ Web Bean archives to JBoss AS, and allows the Web Beans RI to query the
+ EJB3 container and discover which EJBs are installed in your
+ application. Secondly, an update to JBoss EJB3 is needed.
+ </para>
+ </info>
+
+ <para>
+ To install the update, you'll need ant 1.7.0 installed, and the
+ <literal>ANT_HOME</literal> environment variable set. For example:
+ </para>
+
+ <programlisting>$ unzip apache-ant-1.7.0.zip
+$ export ANT_HOME=~/apache-ant-1.7.0</programlisting>
- <itemizedlist>
- <listitem>
- <para>
- <literal>ant restart</literal> - deploy the example in exploded
- format
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>ant explode</literal> - update an exploded example,
without
- restarting the deployment
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>ant deploy</literal> - deploy the example in compressed
jar format
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>ant undeploy</literal> - remove the example from the
server
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>ant clean</literal> - clean the example
- </para>
- </listitem>
- </itemizedlist>
+ <para>
+ Then, you can install the update. The update script will use Maven to
+ download the Web Beans and EJB3 automatically.
+ </para>
+ <programlisting>$ cd webbeans-1.0.0.ALPHA1
+$ ant install-jboss5-update</programlisting>
+ <para>
+ Now, you're ready to deploy your first example!
+ </para>
+
+ <para>
+ To deploy the numberguess example:
+ </para>
+
+ <programlisting>$ cd examples/numberguess
+ant deploy</programlisting>
+
+ <para>
+ Wait for the application to deploy, and enjoy hours of fun at
+ <ulink url="http://localhost:8080/webbeans-numberguess" />!
+ </para>
+
+ <para>
+ The Web Beans RI includes a second simple example that will translate your text
+ into Latin. The numberguess example is a war example, and uses only simple
+ beans; the translator example is an ear example, and includes enterprise
+ beans, packaged in an EJB module. To try it out:
+ </para>
+
+ <programlisting>$ cd examples/traslator
+ant deploy</programlisting>
+
+ <para>
+ Wait for the application to deploy, and visit
+ <ulink url="http://localhost:8080/webbeans-translator" />!
+ </para>
+
+ <info>
+ <para>
+ The build scripts for the examples offer a number of targets, these
+ are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>ant restart</literal> - deploy the example in
exploded
+ format
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ant explode</literal> - update an exploded example,
without
+ restarting the deployment
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ant deploy</literal> - deploy the example in
compressed jar format
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ant undeploy</literal> - remove the example from the
server
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ant clean</literal> - clean the example
+ </para>
+ </listitem>
+ </itemizedlist>
+ </info>
+
</section>
</chapter>
\ No newline at end of file