User: vladimir
Date: 01/02/10 16:57:39
Modified: src/docs jbossdocs.xml jbossintro.xml
Log:
new "driver" for jboss documentation + modified version of jbossintro.xml
Revision Changes Path
1.2 +42 -9 manual/src/docs/jbossdocs.xml
Index: jbossdocs.xml
===================================================================
RCS file: /products/cvs/ejboss/manual/src/docs/jbossdocs.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jbossdocs.xml 2001/02/11 00:04:53 1.1
+++ jbossdocs.xml 2001/02/11 00:57:38 1.2
@@ -1,28 +1,61 @@
<!DOCTYPE book
PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"docbookx/docbookx.dtd" [
+<!ENTITY preface.xml SYSTEM "preface.xml">
<!ENTITY jbossintro.xml SYSTEM "jbossintro.xml">
-<!ENTITY jbossapi.xml SYSTEM "jbossapi.xml">
+<!ENTITY cmp.xml SYSTEM "cmp.xml">
+<!ENTITY customizingjaws.xml SYSTEM "customizingjaws.xml">
+<!ENTITY advconfig.xml SYSTEM "advconfig.xml">
+<!ENTITY jdbc-database.xml SYSTEM "jdbc-database.xml">
+<!ENTITY designnotes.xml SYSTEM "designnotes.xml">
+<!ENTITY howtotomcat.xml SYSTEM "howtotomcat.xml">
+<!ENTITY howtormhexamples.xml SYSTEM "howtormhexamples.xml">
+<!ENTITY howtojmx.xml SYSTEM "howtojmx.xml">
+<!ENTITY howtotimer.xml SYSTEM "howtotimer.xml">
+<!ENTITY howtoj2eedeployer.xml SYSTEM "howtoj2eedeployer.xml">
+<!ENTITY howtojaas.xml SYSTEM "howtojaas.xml">
+<!ENTITY howtojavamail.xml SYSTEM "howtojavamail.xml">
+<!ENTITY howtojbuilderdebug.xml SYSTEM "howtojbuilderdebug.xml">
+<!ENTITY howtoejx.xml SYSTEM "howtoejx.xml">
+<!ENTITY howtojca.xml SYSTEM "howtojca.xml">
+<!ENTITY basicconfiguration.xml SYSTEM "basicconfiguration.xml">
+
]>
+
<book>
<bookinfo>
-<title>JBoss 2.0 Documentation</title>
-<copyright><year>2000</year><year>2001</year>
+ <title>JBoss 2.0 documentation</title>
+ <copyright>
+ <year>2000</year>
+ <year>2001</year>
<holder>JBoss Organization</holder>
</copyright>
</bookinfo>
-
+&preface.xml;
&jbossintro.xml;
-<!--
+&basicconfiguration.xml;
+&jdbc-database.xml;
&cmp.xml;
&customizingjaws.xml;
&advconfig.xml;
-&j2eedeployer.xml;
-&jbossfinal.xml;
--->
-&jbossapi.xml;
+&designnotes.xml;
+<chapter><title>Howto</title>
+&howtotomcat.xml;
+&howtormhexamples.xml;
+&howtojmx.xml;
+&howtotimer.xml;
+&howtoj2eedeployer.xml;
+&howtojaas.xml;
+&howtojavamail.xml;
+&howtojbuilderdebug.xml;
+&howtoejx.xml;
+&howtojca.xml;
+</chapter>
</book>
+
+
+
1.2 +102 -9 manual/src/docs/jbossintro.xml
Index: jbossintro.xml
===================================================================
RCS file: /products/cvs/ejboss/manual/src/docs/jbossintro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jbossintro.xml 2001/02/11 00:04:53 1.1
+++ jbossintro.xml 2001/02/11 00:57:38 1.2
@@ -1,7 +1,94 @@
<chapter>
- <title>Installing JBoss</title>
+ <title>First steps</title>
+<para>Author:
+ <author><firstname>Kevin</firstname><surname>Boone</surname></author>
+ <email>[EMAIL PROTECTED]</email>
+</para>
+
+<section><title>Introduction</title>
+<section>
+ <title>What this article is about</title>
+
+<para>
+This article presensts 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
+introductory articles on Sun's JavaSoft Web site. Although the description is
+based on the use of a Linux server, most of the issues discussed in
+this article will also apply to other platforms. If you are using a Windows
+platform you will need to pay attention to the directory names, which
+will be different from the one's I've assumed.
+</para>
+</section>
+
+<section>
+ <title>About JBoss</title>
+
+<para>
+JBoss is an implementation of the EJB 1.1 specification, that is, it is a
+server and container for Enterprise JavaBeans. In this it is similar to Sun's
+`J2SDK Enterprise Edition' (J2EE), but JBoss is much more single-minded than
+J2EE. JBoss provides only an EJB server; it does not include
+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
+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
+footprint, JBoss starts up about 10 times faster than J2EE.
+There is a built-in SQL database server for handling persistent beans, and
+this starts up automatically with the server (J2EE ships with the
+CloudScape SQL server, which has to be started separately).
+</para>
+
+<para>
+ One of the nicest features of JBoss is its support for `hot'
+deployment. What this means is that deploying a Bean is a simple as copying its
+JAR file into the deployment directory. If this is done while the Bean is
+already loaded, JBoss automatically unloads it, then loads the new
+version. Contrast this with the rigmarole that J2EE makes us go through...
+JBoss is distributed under the GNU public licence, which means that
+it's free, even for commercial work, and is likely to remain that way. You get
+no support, of course.
+</para>
+
+<para>
+ The main weakness of JBoss is its documentation. There is, essentially,
+none. There is a mailing list, and you will almost certainly need
+recourse to it at some point. This article hopes to remedy this deficiency, to
+a small degree, by describing step-by-step how a simple EJB can
+be created, deployed and tested on the JBoss server.
+</para>
+</section>
+
+<section>
+ <title>Pre-requisites</title>
+
+<para>
+JBoss is written entirely in Java, and requires a Java system compatible with
+JDK 1.3. This is essential, not optional. Trust me on this; I've tried
+it with JDK 1.2.2 and the `hot' deployment facility simply doesn't work. Since
+it is now possible to get Linux JDKs directly from Sun, there's
+little reason not to upgrade if you're using an earlier version. A word of
+warning: although Sun provide an RPM distribution as well as the
+traditional gzipped tar, the RPM version does not unpack, so don't waste time
+downloading the 34 megabytes it requires. Use the tar version
+and un-tar it as normal. </para>
+
+<para>
+I will assume that you are basically familiar with EJBs (and know, for
+example, what a `home interface' is) and know how to compile Java
+classes.
+</para>
+
+</section>
+</section>
+
+
-<section><title>Introduction</title>
+<section><title>Installing JBoss</title>
<para>Before installing and running the server, you should check that your JDK
installation is working. (Step-by-step instructions are available.) You will
need the JDK binaries directory in your PATH (this is essential: see below)
@@ -160,7 +247,8 @@
<title>Coding the classes</title>
<para>We need three classes: the remote interface, the Bean, and the home
-interface. All the .java files will go in the subdirectory
./com/web_tomorrow/interest.
+interface. All the .java files will go in the subdirectory
+./com/web_tomorrow/interest.
The remote interface in this example is very simple.
</para>
@@ -285,7 +373,8 @@
<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
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/lib/ext/ejb.jarcom/web_tomorrow/interest/*.java</command>
</para>
<para>
@@ -400,7 +489,8 @@
<para>jboss.xml: ()</para>
-<figure><title>The JBoss XML descriptor. (Optional, this file is provided by the
Bean deployer)</title>
+<figure><title>The JBoss XML descriptor. (Optional, this file is provided by
+the Bean deployer)</title>
<literallayout> <![CDATA[
<jboss>
<enterprise-beans>
@@ -482,13 +572,15 @@
[Container factory] Deploying Interest
[Container factory] Started: Interest
[Container factory] Bound Interest to interest/Interest
-[Container factory] Deployed application: file:/usr/local/jboss/deploy/interest.jar
+[Container factory] Deployed application:
+file:/usr/local/jboss/deploy/interest.jar
</computeroutput></literallayout>
<para>If you see a message like this: </para>
<literallayout><computeroutput>
[Container factory] Deploying:file:/usr/local/jboss/deploy/interest.jar
-[Container factory] Deployed application file:/usr/local/jboss/deploy/interest.jar
+[Container factory] Deployed application
+file:/usr/local/jboss/deploy/interest.jar
</computeroutput></literallayout>
<para>then no Beans have been deployed -- the server always reports the Beans
@@ -664,7 +756,8 @@
this:</para>
<literallayout>
-<computeroutput>javax.naming.CommunicationException [Root exception is
java.lang.ClassNotFoundException: com.web_tomorrow.interest.InterestHome]
+<computeroutput>javax.naming.CommunicationException [Root exception is
+java.lang.ClassNotFoundException: com.web_tomorrow.interest.InterestHome]
</computeroutput></literallayout>
<para>A 'communication exception' is the exception that represents any error
@@ -725,7 +818,7 @@
drop me a line at [EMAIL PROTECTED]; if there's enough response I may
be persuaded to produce some more sophisticated tutorials.</para>
</section>
-
</chapter>
+
