CVS: jcontainer/loom/site/xdocs downloads.xml,1.3,1.4 getting-started.xml,1.5,1.6 index.xml,1.6,1.7 install.xml,1.4,1.5 navigation.xml,1.14,1.15 porting-guide.xml,1.6,1.7
Peter Donald <pdonald-yCVjj/[email protected]> Wed, 3 Dec 2003 04:45:22 -0600
| Newsgroups | gmane.comp.java.jcontainer.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/jcontainer/jcontainer/loom/site/xdocs
In directory hogshead.codehaus.org:/tmp/cvs-serv21491/site/xdocs
Modified Files:
downloads.xml getting-started.xml index.xml install.xml
navigation.xml porting-guide.xml
Log Message:
Styled codebase
Index: downloads.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/site/xdocs/downloads.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- downloads.xml 10 Oct 2003 10:32:41 -0000 1.3
+++ downloads.xml 3 Dec 2003 10:44:49 -0000 1.4
@@ -6,7 +6,7 @@
<body>
<section name="Downloading Loom">
<p>
- Both distributions and jars are downloadable from the
+ Both distributions and jars are downloadable from the
<a href="http://dist.codehaus.org">
Codehaus Distribution Server</a>.
</p>
Index: getting-started.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/site/xdocs/getting-started.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- getting-started.xml 4 Aug 2003 12:44:37 -0000 1.5
+++ getting-started.xml 3 Dec 2003 10:44:49 -0000 1.6
@@ -1,111 +1,114 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<document>
- <properties>
- <title>Getting Started</title>
- <author email="jcontainer-interest-yCVjj/[email protected] ">Loom Documentation Team</author>
- <author email="[email protected]">Leo Simons</author>
- <author email="Paul_Hammant-/[email protected]">Paul Hammant</author>
- <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
- </properties>
+ <properties>
+ <title>Getting Started</title>
+ <author email="jcontainer-interest-yCVjj/[email protected] ">Loom Documentation Team</author>
+ <author email="[email protected]">Leo Simons</author>
+ <author email="Paul_Hammant-/[email protected]">Paul Hammant</author>
+ <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
+ </properties>
- <body>
-
- <section name="Introduction">
- <p>
+ <body>
+
+ <section name="Introduction">
+ <p>
This document aims to provides developers new to Loom with a few simple
- examples to help them getting started with Loom.
- </p>
- <p>
+ examples to help them getting started with Loom.
+ </p>
+ <p>
Instructions for installing Loom can be found on the
- <a href="install.html">Install</a> document.
- </p>
-
- </section>
-
- <section name="The HelloWorld demo">
-
- <p>
+ <a href="install.html">Install</a> document.
+ </p>
+
+ </section>
+
+ <section name="The HelloWorld demo">
+
+ <p>
Loom would not be a serious application if it did not have an HellWorld demo!
It will allow you to verify that you've successfully built Loom.
- </p>
- <p>
+ </p>
+ <p>
Firstly you will need to build the helloworld.sar file. A SAR file is an archive
- for Loom applications which conveniently holds all the libraries and deployment
+ for Loom applications which conveniently holds all the libraries and deployment
information the the given application. If you are familiar with J2EE EAR and WAR
- files you'll find it very similar.
- </p>
- <p>
- To build the helloworld demo
-<source>
+ files you'll find it very similar.
+ </p>
+ <p>
+ To build the helloworld demo
+ <source>
cd loom/demos/helloworld
-maven
-</source>
- The resulting artifact will be found in the target/demo-helloworld.sar.
- Copy it into apps/ directory of the Loom distribution.
- </p>
-
- <p>
+maven
+ </source>
+ The resulting artifact will be found in the target/demo-helloworld.sar.
+ Copy it into apps/ directory of the Loom distribution.
+ </p>
+
+ <p>
Then fire up Loom by simply executing the run script in the distribution bin/ directory:
-<source>
+ <source>
cd [distribution-dir]/bin
run[.bat|sh]
-</source>
- </p>
-
- <p>
+ </source>
+ </p>
+
+ <p>
Next point your favorite web browser to http://localhost:8999/,
- where localhost is the network name alias of your machine ("localhost").
+ where localhost is the network name alias of your machine ("localhost").
It should be recognised on all platforms. In the unlikely case it doesn't replace
- localhost with 127.0.0.1<br/>
+ localhost with 127.0.0.1
+ <br/>
If all goes well, you will see something like the following:
-
-<source>
+
+ <source>
Hello World!
Requests so far = 1
you are 127.0.0.1 at 127.0.0.1
-</source>
- </p>
- <p>
+ </source>
+ </p>
+ <p>
This shows that Loom has unpacked and launched the server application contained
- within the helloworld.sar file.
+ within the helloworld.sar file.
To stop Loom simply use CTRL-C on the console window. You can stop and start
as many times as you need. Once the SAR file has been unpacked in the apps/helloworld
- directory it will not attempt to unpack it again.
- So if you replace the helloworld.sar file with a new version, you must remove the
+ directory it will not attempt to unpack it again.
+ So if you replace the helloworld.sar file with a new version, you must remove the
unpacked directory for it to be redeployed.
- </p>
- <p>
- As examples go this is a fairly simple one.
+ </p>
+ <p>
+ As examples go this is a fairly simple one.
Further details can be found in the demo documentation, which is easily built:
-<source>
+ <source>
cd loom/demos/helloworld
maven xdoc
-</source>
- Then simply open <code>target/docs/index.html</code>.
- </p>
- </section>
-
- <section name="The Avalon Lifecycle demo">
- <p>The lifecycle demo shows only the calling of the Avalon lifecycle methods
+ </source>
+ Then simply open
+ <code>target/docs/index.html</code>.
+ </p>
+ </section>
+
+ <section name="The Avalon Lifecycle demo">
+ <p>The lifecycle demo shows only the calling of the Avalon lifecycle methods
under Loom control. If you are not familiar with the Avalon lifecycle, please
- refer to the
- <a href="http://avalon.apache.org/framework/reference-the-lifecycle.html">
- Avalon lifecycle</a> documentation.</p>
- <p>Do not forget that the lifecycle methods are optional. You can implement
+ refer to the
+ <a href="http://avalon.apache.org/framework/reference-the-lifecycle.html">
+ Avalon lifecycle</a> documentation.
+ </p>
+ <p>Do not forget that the lifecycle methods are optional. You can implement
all of them, as this demo does, some or none of them.</p>
- <p>
- To build the demo
-<source>
+ <p>
+ To build the demo
+ <source>
cd loom/demos/avalonlifecycle
-maven
-</source>
- The resulting artifact will be found in the target/demo-avalonlifecycle.sar.
- Copy it into apps/ directory of the Loom distribution.
- </p>
+maven
+ </source>
+ The resulting artifact will be found in the target/demo-avalonlifecycle.sar.
+ Copy it into apps/ directory of the Loom distribution.
+ </p>
- <p>This is the output that appears in the Console that Loom was started from:</p>
-<source>
+ <p>This is the output that appears in the Console that Loom was started from:</p>
+ <source>
Lifecycle1Impl.constructor() called. (You should never do too much in here)
Lifecycle1Impl.enableLogging() called.
Lifecycle1Impl.contextualize() called (things like base directory passed in here).
@@ -128,66 +131,69 @@
Lifecycle2Impl.dispose() Called
Lifecycle1Impl.stop() called.
Lifecycle1Impl.dispose() Called
-</source>
- </section>
+ </source>
+ </section>
- <section name="The distributed demo">
- <p>
+ <section name="The distributed demo">
+ <p>
This demo application could be considered a starter project for someone wanting to make a
Loom compatible application. You can start with this skeleton which has several
important features of real applications and then add in your core business logic.
- </p>
- <p>
+ </p>
+ <p>
This demo application also demonstrates that it is possible to make a server application that is dual mode.
Dual mode to us is the ability for the server application to run inside Loom and to
stand-alone from the command line. The only difference is that the app
needs to be zipped into two forms - the sar file for Loom and a jar file for standalone.
- </p>
- <p>
+ </p>
+ <p>
To build the demo
- </p>
-<source>
+ </p>
+ <source>
cd loom/demos/distributed
-maven
-</source>
- <p>
- The build setup also demostrates a typical build structure for multi-component project.
- The top-level <code>loom/demos/distributed/maven.xml</code> drives the build of the
+maven
+ </source>
+ <p>
+ The build setup also demostrates a typical build structure for multi-component project.
+ The top-level
+ <code>loom/demos/distributed/maven.xml</code> drives the build of the
of the components via a reactor, which takes into consideration any dependencies among the
components.
- </p>
-
- <p>
+ </p>
+
+ <p>
The build artifacts are:
- <ol>
- <li>server/target/demo-distributed-server.sar - the server app in Loom form</li>
- <li>server/target/demo-distributed-server-x.y.jar - the server app in standalone form</li>
- <li>client/target/demo-distributed-client-x.y.jar - the client app</li>
- </ol>
- </p>
-
- <p>
- To run the Server app in standalone mode:
-<source>
+ <ol>
+ <li>server/target/demo-distributed-server.sar - the server app in Loom form</li>
+ <li>server/target/demo-distributed-server-x.y.jar - the server app in standalone form</li>
+ <li>client/target/demo-distributed-client-x.y.jar - the client app</li>
+ </ol>
+ </p>
+
+ <p>
+ To run the Server app in standalone mode:
+ <source>
java -jar demo-distributed-server-x.y.jar
Loom Demo listening on port 7654
Ctrl-C to exit
-</source>
-
-
- To run the Server app inside Loom drop the <code>demo-distributed-server.sar</code> in the
- Loom distribution <code>apps</code> directory (as done above), and restart Loom:
-<source>
+ </source>
+
+
+ To run the Server app inside Loom drop the
+ <code>demo-distributed-server.sar</code> in the
+ Loom distribution
+ <code>apps</code> directory (as done above), and restart Loom:
+ <source>
Server started on port 1234
-</source>
-
+ </source>
+
Finally use the client application to poke the server :
-<source>
+ <source>
java -jar loom-demo-client.jar localhost 7654 HelloLonerWorld!!!
java -jar loom-demo-client.jar localhost 1234 HelloLoomWorld!!!
-</source>
+ </source>
You should see the messages appear in the console windows in which the two servers are running.
- </p>
- </section>
- </body>
+ </p>
+ </section>
+ </body>
</document>
Index: index.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/site/xdocs/index.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- index.xml 11 Oct 2003 19:34:16 -0000 1.6
+++ index.xml 3 Dec 2003 10:44:49 -0000 1.7
@@ -1,35 +1,40 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
- <properties>
- <title>Overview</title>
- </properties>
-
- <body>
- <section name="Introduction">
- <p>
- Loom is a micro-kernel designed and implemented on top of the
- <a href="http://dna.jcontainer.org">DNA</a> framework and supports components developed
- using the <a href="http://avalon.apache.org/framework/">Avalon</a>.
- In the future Loom will support DNA and <a href="http://picocontainer.org">Pico</a> components.
- </p>
- <p>
- Loom provides a number of facilities to manage the environment of Server Applications.
- Such facilities include log management, classloading, thread management and security.
- In the future it will conditionally support extra facilities such as central server management,
+ <properties>
+ <title>Overview</title>
+ </properties>
+
+ <body>
+ <section name="Introduction">
+ <p>
+ Loom is a micro-kernel designed and implemented on top of the
+ <a href="http://dna.jcontainer.org">DNA</a> framework and supports components developed
+ using the
+ <a href="http://avalon.apache.org/framework/">Avalon</a>.
+ In the future Loom will support DNA and
+ <a href="http://picocontainer.org">Pico</a> components.
+ </p>
+ <p>
+ Loom provides a number of facilities to manage the environment of Server Applications.
+ Such facilities include log management, classloading, thread management and security.
+ In the future it will conditionally support extra facilities such as central server management,
server pools, and other facilities aimed at reducing the time to market.
- </p>
- <p>
+ </p>
+ <p>
The API defines a standard method of piecing together server components and creating a server.
- </p>
- </section>
-
- <section name="Acknowledgements">
- <p>The JContainer Group would like to thank <a href="http://codehaus.org">Codehaus</a>
- for supplying resources to host the project</p>
-
- <p>This product includes software developed by the Apache Software Foundation
- (<a href="http://www.apache.org">http://www.apache.org/</a>).
- </p>
- </section>
- </body>
+ </p>
+ </section>
+
+ <section name="Acknowledgements">
+ <p>The JContainer Group would like to thank
+ <a href="http://codehaus.org">Codehaus</a>
+ for supplying resources to host the project
+ </p>
+
+ <p>This product includes software developed by the Apache Software Foundation
+ (
+ <a href="http://www.apache.org">http://www.apache.org/</a>).
+ </p>
+ </section>
+ </body>
</document>
Index: install.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/site/xdocs/install.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- install.xml 31 Jul 2003 20:29:40 -0000 1.4
+++ install.xml 3 Dec 2003 10:44:49 -0000 1.5
@@ -1,49 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<document>
- <properties>
- <title>Installation</title>
- <author email="jcontainer-interest-yCVjj/[email protected] ">Loom Documentation Team</author>
- </properties>
+ <properties>
+ <title>Installation</title>
+ <author email="jcontainer-interest-yCVjj/[email protected] ">Loom Documentation Team</author>
+ </properties>
-<body>
+ <body>
-<section name="Installation">
- <title>Installation</title>
+ <section name="Installation">
+ <title>Installation</title>
-<p>
+ <p>
Loom runs on a variety of platforms that have installed the Java 2 Virtual Machine.
-</p>
+ </p>
-<p>
+ <p>
Everything required to run Loom and develop Loom based products comes with the
distribution. If you wish to help develop Loom then it is recomended that you
obtain the full source tree from CVS or from the nightly builds.
-</p>
+ </p>
-</section>
+ </section>
-<section name="Building from source">
- <title>Building from source</title>
+ <section name="Building from source">
+ <title>Building from source</title>
-<p>
- Loom uses <a href="http://maven.apache.org">Maven</a> as the build tool.
+ <p>
+ Loom uses
+ <a href="http://maven.apache.org">Maven</a> as the build tool.
Please consult the online Mavan documentation if you are not familiar with it.
-</p>
+ </p>
-<p>
- To build Loom
-</p>
-<source>
-cd loom
-maven
-</source>
-<p>
- The <code>distribution/target/loom-[version]</code> directory will contain the
+ <p>
+ To build Loom
+ </p>
+ <source>
+cd loom
+maven
+ </source>
+ <p>
+ The
+ <code>distribution/target/loom-[version]</code> directory will contain the
distribution as it comes in the binary build.
-</p>
+ </p>
-</section>
+ </section>
-</body>
+ </body>
</document>
Index: navigation.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/site/xdocs/navigation.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- navigation.xml 17 Oct 2003 01:40:20 -0000 1.14
+++ navigation.xml 3 Dec 2003 10:44:49 -0000 1.15
@@ -5,7 +5,7 @@
<body>
<links>
- <item href="http://loom.jcontainer.org" name="Loom"/>
+ <item href="http://loom.jcontainer.org" name="Loom"/>
<item href="http://jcontainer.org" name="JContainer"/>
<item href="http://codehaus.org" name="Codehaus"/>
</links>
@@ -27,19 +27,19 @@
<item href="/guide/index.html" name="Overview"/>
<item href="/guide/architecture.html" name="Architecture"/>
<item href="/guide/roles.html" name="Development Roles">
- <item href="/guide/administrator.html" name="Administrators"/>
- <item href="/guide/deployers.html" name="Deployers"/>
- <item href="/guide/assemblers/index.html" name="Assemblers" collapse="true">
- <item href="/guide/assemblers/what-is-a-server-application.html" name="What is a Server Application"/>
- <item href="/guide/assemblers/creating-a-server-application.html" name="Creating a Server Application"/>
- </item>
- <item href="/guide/bdg/index.html" name="Block Developers" collapse="true">
- <item href="/guide/bdg/what-is-a-block.html" name="What is a Block"/>
- <item href="/guide/bdg/creating-a-block.html" name="Creating a Block"/>
- <item href="/guide/bdg/what-is-an-application-listener.html" name="What is an Application Listener"/>
- <item href="/guide/bdg/making-loom-compatible-comps.html" name="Making Compatible Components"/>
- <item href="/guide/bdg/doclet-tags.html" name="Doclet Tags"/>
- </item>
+ <item href="/guide/administrator.html" name="Administrators"/>
+ <item href="/guide/deployers.html" name="Deployers"/>
+ <item href="/guide/assemblers/index.html" name="Assemblers" collapse="true">
+ <item href="/guide/assemblers/what-is-a-server-application.html" name="What is a Server Application"/>
+ <item href="/guide/assemblers/creating-a-server-application.html" name="Creating a Server Application"/>
+ </item>
+ <item href="/guide/bdg/index.html" name="Block Developers" collapse="true">
+ <item href="/guide/bdg/what-is-a-block.html" name="What is a Block"/>
+ <item href="/guide/bdg/creating-a-block.html" name="Creating a Block"/>
+ <item href="/guide/bdg/what-is-an-application-listener.html" name="What is an Application Listener"/>
+ <item href="/guide/bdg/making-loom-compatible-comps.html" name="Making Compatible Components"/>
+ <item href="/guide/bdg/doclet-tags.html" name="Doclet Tags"/>
+ </item>
</item>
<item href="/guide/mx/index.html" name="Management Guide" collapse="true">
<item href="/guide/mx/overview.html" name="Overview"/>
Index: porting-guide.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/site/xdocs/porting-guide.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- porting-guide.xml 29 Nov 2003 07:25:14 -0000 1.6
+++ porting-guide.xml 3 Dec 2003 10:44:49 -0000 1.7
@@ -1,76 +1,78 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<document>
- <properties>
- <title>Porting Guide</title>
- </properties>
+ <properties>
+ <title>Porting Guide</title>
+ </properties>
- <body>
+ <body>
- <section name="Porting Phoenix 4.0.x applications">
- <p>
+ <section name="Porting Phoenix 4.0.x applications">
+ <p>
Loom 1.0 supports applications running in Phoenix 4.0.x releases,
provided that the sar is built using the
- <a href="/plugins/maven-sar/">Maven Sar Plugin</a>
+ <a href="/plugins/maven-sar/">Maven Sar Plugin</a>
provided by Loom and the appropriate libraries are bundles in the sar.
- </p>
- <subsection name="Creating a Loom Sar">
- <p>
+ </p>
+ <subsection name="Creating a Loom Sar">
+ <p>
Since the generation of metaclass descriptors is more generic in
Loom compared with Phoenix, but still fully compatible with it,
users can deploy applications running in Phoenix 4.0.x by simply
regenerating from the Java source the descriptors using the Maven Sar Plugin.
- </p>
- <p>
- To create a sar, using the <a href="/plugins/maven-sar/">Maven Sar Plugin</a>
+ </p>
+ <p>
+ To create a sar, using the
+ <a href="/plugins/maven-sar/">Maven Sar Plugin</a>
simply add the dependency to your Maven project
-<source>
-<![CDATA[
+ <source>
+ <![CDATA[
<dependency>
<groupId>loom</groupId>
<artifactId>maven-sar-plugin</artifactId>
<version>[plugin-version]</version>
<type>plugin</type>
</dependency>
-]]>
-</source>
+ ]]>
+ </source>
And then make sure that the sar:metagenerate is invoked after java
compilation by adding the following to a custom maven.xml.
-<source>
-<![CDATA[
+ <source>
+ <![CDATA[
<postGoal name="java:compile">
<attainGoal name="sar:metagenerate"/>
</postGoal>
-]]>
-</source>
+ ]]>
+ </source>
and execute
-<source>
+ <source>
maven sar
-</source>
- </p>
- </subsection>
- <subsection name="Comparison of libraries bundled">
- <p>
+ </source>
+ </p>
+ </subsection>
+ <subsection name="Comparison of libraries bundled">
+ <p>
Compared to the Phoenix 4.0.x distribution, in the Loom 1.0 distribution
- some of the libraries in the <code>lib/</code> directory
+ some of the libraries in the
+ <code>lib/</code> directory
have been removed as they are not used by the container.
If your app uses any of the excluded libraries,
you simply need to bundle them with the sar.
- </p>
- <p>
+ </p>
+ <p>
Loom 1.0 comes with a lean set of libraries:
-<source>
+ <source>
avalon-framework
excalibur-instrument
logkit
log4j
mx4j-jmx
phoenix-client
-</source>
- </p>
- <p>
+ </source>
+ </p>
+ <p>
Phoenix 4.0.x ships a bigger set of libraries:
-<source>
+ <source>
avalon-framework
excalibur-baxter
excalibur-cli
@@ -94,10 +96,10 @@
xalan
xercesImpl
xml-apis
-</source>
- </p>
- </subsection>
- </section>
+ </source>
+ </p>
+ </subsection>
+ </section>
- </body>
+ </body>
</document>