User: tobias
Date: 01/03/11 17:04:15
Modified: src/docs jbossintro.xml
Log:
included win instructions
changed download pointer to download directory
Revision Changes Path
1.5 +37 -37 manual/src/docs/jbossintro.xml
Index: jbossintro.xml
===================================================================
RCS file: /products/cvs/ejboss/manual/src/docs/jbossintro.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- jbossintro.xml 2001/02/23 16:22:19 1.4
+++ jbossintro.xml 2001/03/12 01:04:15 1.5
@@ -7,10 +7,10 @@
<section><title>Introduction</title>
<section>
- <title>What this article is about</title>
+ <title>What this section is about</title>
<para>
-This article presensts a step-by-step tutorial on how to set up `JBoss', the
+This section presents a step-by-step tutorial on how to set up `JBoss', the
free Enterprise JavaBean (EJB) server, and create your first
Enterprise JavaBean and client. It doesn't explain what Enterprise JavaBeans
are, or how they are used; there are a number of good
@@ -33,7 +33,7 @@
support for JSP, SSL, and all the other protocols that the Sun product can
handle. This means that it is smaller in memory and in disk space.
JBoss will run very effectively on a machine with 64 megabytes of RAM, and
-requires only 4 megabytes of disk (including source code!). Sun's
+requires only some megabytes of disk (including source code!). Sun's
J2EE requires a minimum of 128 megabytes of RAM, and 31 megabytes of disk
space. That's not to criticise the Sun product; it is a
heavyweight offering providing a host of services. Because of its small memory
@@ -78,7 +78,7 @@
and un-tar it as normal. </para>
<para>
-I will assume that you are basically familiar with EJBs (and know, for
+I will assume that you are basically familiar with EJBs (and roughly know, for
example, what a `home interface' is) and know how to compile Java
classes.
</para>
@@ -122,7 +122,12 @@
Download - Binary section. Place it in a temporary directory and use your
favorite unziper to decompress it to the place where you want JBoss
installed. Start the "command line" from "Accessories" menu and change to
-the directory to which you just decompressed the binary package.
+the directory to which you just decompressed the binary package. In
+the following descriptions you will need to replace /usr/local/jboss/
+with the path you selected to install JBoss to (e.g. c:\jboss\ ). Also
+note that Windows is not using a colon <quote>:</quote> but a
+semicolon <quote>;</quote> to separate
+multiple entries in paths (e.g. the CLASSPATH).
</para></formalpara>
<formalpara><title>Installation of binary package for Linux:</title>
@@ -168,19 +173,12 @@
<para>
In this step we will write and compile a simple Enterprise JavaBean. You can
-download the source code interestEJB.tar.gz for this example; you will need to
-unpack it into an empty directory.</para>
+download the source code for this example; according to which unpacker
+(WinZIP, unzip, tar) you have available either download
+interestEJB.zip or interestEJB.tar.gz from the file section in the
+documentation section on www.jboss.org . You will need to
+unpack the archive into an empty directory.</para>
-<literallayout><command>cd /usr/local/jboss
-mkdir examples
-cd examples
-lynx -source http://jboss.org/newsite/documentation/interestEJB.tar.gz >
interestEJB.tar.gz
-gunzip interestEJB.tar.gz
-tar xf interestEJB.tar
-rm -rf interestEJB.tar
-
-</command></literallayout>
-
<para>The example -- which is called `Interest' -- is about as simple as an
EJB can get: it is a `stateless session bean'. Its job is to calculate the
amount of compound interest payable on a sum of money borrowed over a
@@ -196,9 +194,10 @@
web_tomorrow
interest
{java source and class files here}
+
</literallayout>
-If you unpack the archive interestEJB.tar.gz it will create this
-structure automatically. </para>
+If you unpack the interestEJB-archive it will create a subdirectory
+called "interest" and the needed structure automatically below it.</para>
</section>
<section><title>EJBs: review</title>
@@ -238,6 +237,7 @@
META-INF
ejb-jar.xml
jboss.xml (optional)
+
</literallayout>
</para>
@@ -379,18 +379,15 @@
anything in this case.</para>
<para>If you haven't already done so, you should create these .java files in
-the directory ./com/web_tomorrow/interest (or unpack the archive with them
+the directory com/web_tomorrow/interest (or unpack the archive with them
in). Then you can compile them using the command
-<command>javac
--classpath/usr/local/jboss/lib/ext/ejb.jarcom/web_tomorrow/interest/*.java</command>
+<command>javac -classpath /usr/local/jboss/client/ejb.jar
com/web_tomorrow/interest/*.java</command>
</para>
<para>
-substituting the correct path to the JBoss class EJB library if you haven't
+Substituting the correct path to the JBoss class EJB library if you haven't
installed JBoss in /usr/local/jboss. This should create three class files:
-InterestBean.class, Interest.class, and InterestHome.class. If you have `make'
-on your system, and you have unpacked the archive, you can build all the
-classes just be running make in the same directory as the Makefile.
+InterestBean.class, Interest.class, and InterestHome.class.
With the classes compiled, it's time to create the deployment
descriptor.</para>
@@ -435,7 +432,8 @@
<para>The deployment descriptor must be called ejb-jar.xml and it must be in
the directory ./META-INF. A common mistake is to name this directory
-`META_INF' (with an underscore, rather than a dash), which won't work.</para>
+`META_INF' (with an underscore, rather than a dash) or write it lower
+case, which won't work.</para>
<para> In principle what we deploy on the server is an application, not a
Bean. In this example our application consists of exactly one Bean, so it
@@ -562,8 +560,9 @@
</literallayout>
<para>Note that the directory structure must be exactly like this, or it won't
-work. Again a common mistake is to do a META_INF (underscore) instead of
-META-INF, be careful with this one</para>
+work. Again a common mistake is to do a META_INF (underscore) or meta-inf
+(lower case) instead of
+META-INF, be careful with this one.</para>
<para>To deploy the Bean on the server, all that's necessary is to copy the
.jar file to the `deploy' directory on the server, e.g.,
@@ -589,7 +588,8 @@
[Container factory] Deploying:file:/usr/local/jboss/deploy/interest.jar
[Container factory] Deployed application
file:/usr/local/jboss/deploy/interest.jar
-</computeroutput></literallayout>
+</computeroutput>
+</literallayout>
<para>then no Beans have been deployed -- the server always reports the Beans
that it detects. This usually means that the deployment descriptor ejb-jar.xml
@@ -702,7 +702,7 @@
"localhost:1099"); </programlisting></para>
<para>There are several other ways to do this, which you may see described in
-other articles. In this case, the server is on the same machine as the client
+other sections. In this case, the server is on the same machine as the client
(`localhost') and the default naming port is `1099' for JBoss (other servers
may use different port numbers). If you run the client and the server on
different machines, you will need to change these settings.</para>
@@ -736,7 +736,7 @@
find the EJB classes which are in the directories beneath it. </para>
-<para><command>javac -classpath usr/lib/jboss/lib/ext/ejb.jar:.
+<para><command>javac -classpath /usr/local/jboss/client/ejb.jar:.
InterestClient.java</command></para>
<para>This generates InterestClient.class in the current directory. </para>
@@ -779,10 +779,11 @@
Bean classes below it, then we can run it like this:</para>
<literallayout><command>
-java -classpath $$CLASSPATH:\
-/usr/local/jboss/lib/ext/ejb.jar:/usr/local/jboss/client/jboss-client.jar \
-InterestClient </command></literallayout>
+java -classpath $CLASSPATH:\
+/usr/local/jboss/client/ejb.jar:/usr/local/jboss/client/jboss-client.jar \
+InterestClient</command>
+</literallayout>
<para>Once again, this needs to go in a shell script or a Makefile; you won't
want to type it more than once.</para>
@@ -791,8 +792,7 @@
and the EJB classes as well as the standard classpath (if any).
If all is well, the test client produces the following output: </para>
-<literallayout>
-<computeroutput>
+<literallayout><computeroutput>
Got context
Got reference
Interest on 1000 units, at 10% per period, compounded over 2 periods is:
