You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ha...@apache.org on 2002/04/02 20:56:22 UTC
cvs commit: jakarta-avalon-phoenix/src/xdocs making-phoenix-compatible-comps.xml administrator-guide.xml afuture.xml assemblers-guide.xml assembly-xml-specification.xml block-developers-guide.xml blockinfo-specification.xml book.xml changes.xml config-xml-specification.xml creating-a-block.xml creating-a-server-application.xml deployers-guide.xml environment-xml-specification.xml example-configuration.xml features.xml getting-started.xml index.xml install.xml phoenix.uris todo.xml what-is-a-block-listener.xml what-is-a-block.xml what-is-a-server-application.xml what-is-an-application-listener.xml
hammant 02/04/02 10:56:22
Modified: src/xdocs administrator-guide.xml afuture.xml
assemblers-guide.xml assembly-xml-specification.xml
block-developers-guide.xml
blockinfo-specification.xml book.xml changes.xml
config-xml-specification.xml creating-a-block.xml
creating-a-server-application.xml
deployers-guide.xml
environment-xml-specification.xml
example-configuration.xml features.xml
getting-started.xml index.xml install.xml
phoenix.uris todo.xml what-is-a-block-listener.xml
what-is-a-block.xml
what-is-a-server-application.xml
what-is-an-application-listener.xml
Added: src/xdocs making-phoenix-compatible-comps.xml
Log:
revised words for getting started and new page
Revision Changes Path
1.2 +2 -3 jakarta-avalon-phoenix/src/xdocs/administrator-guide.xml
Index: administrator-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/administrator-guide.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- administrator-guide.xml 1 Mar 2001 13:44:44 -0000 1.1
+++ administrator-guide.xml 2 Apr 2002 18:56:21 -0000 1.2
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Avalon Phoenix Administrator Documentation</title>
- <subtitle>Introduction</subtitle>
+ <title>Phoenix - Administrator Documentation</title>
<authors>
<person name="Berin Loritsch" email="bloritsch@apache.org"/>
</authors>
@@ -30,7 +29,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.1 $ $Date: 2001/03/01 13:44:44 $
+ $Revision: 1.2 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.2 +2 -2 jakarta-avalon-phoenix/src/xdocs/afuture.xml
Index: afuture.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/afuture.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- afuture.xml 3 Dec 2001 09:03:08 -0000 1.1
+++ afuture.xml 2 Apr 2002 18:56:21 -0000 1.2
@@ -4,13 +4,13 @@
<document>
<header>
- <title>A future</title>
+ <title>Phoenix - A future</title>
<authors>
<person name="Paul Hammant" email="Paul_Hammant@yahoo.com"/>
</authors>
</header>
<body>
- <s1 title="Overview">
+ <s1 title="Introduction">
<p>
A long term aim of Phoenix is to provide a platform that hosts multiple third party applications written only in Java within a single virtual machine. The Phoenix platform is currently hosted on an Operating System such as Unix, Windows or Mac. It could function directly on top of a Java Operating System. A CPU combined with a suitable amount of memory, a basic BIOS, a Kernal, a suitable JVM and runtime library, could mount Phoenix and hosted server applications.
</p>
1.5 +2 -3 jakarta-avalon-phoenix/src/xdocs/assemblers-guide.xml
Index: assemblers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/assemblers-guide.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- assemblers-guide.xml 10 Nov 2001 21:03:57 -0000 1.4
+++ assemblers-guide.xml 2 Apr 2002 18:56:21 -0000 1.5
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Server Assemblers Guide</title>
- <subtitle>Introduction</subtitle>
+ <title>Phoenix Server Assemblers Guide - Preface</title>
<authors>
<person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
</authors>
@@ -56,7 +55,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.4 $ $Date: 2001/11/10 21:03:57 $
+ $Revision: 1.5 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.7 +2 -3 jakarta-avalon-phoenix/src/xdocs/assembly-xml-specification.xml
Index: assembly-xml-specification.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/assembly-xml-specification.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- assembly-xml-specification.xml 19 Nov 2001 12:21:32 -0000 1.6
+++ assembly-xml-specification.xml 2 Apr 2002 18:56:21 -0000 1.7
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Server Assemblers Guide</title>
- <subtitle>Specification of assembly.xml </subtitle>
+ <title>Phoenix Server Assembler's Guide - Specification of assembly.xml </title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
</authors>
@@ -58,7 +57,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.6 $ $Date: 2001/11/19 12:21:32 $
+ $Revision: 1.7 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.3 +3 -3 jakarta-avalon-phoenix/src/xdocs/block-developers-guide.xml
Index: block-developers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/block-developers-guide.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- block-developers-guide.xml 12 Nov 2001 06:45:39 -0000 1.2
+++ block-developers-guide.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Block Developers Guide</title>
- <subtitle>Preface</subtitle>
+ <title>Phoenix Block Developer's Guide - Preface</title>
<authors>
<person name="Berin Loritsch" email="bloritsch@apache.org"/>
</authors>
@@ -43,6 +42,7 @@
<ol>
<li><link href="what-is-a-block.html">What is a block?</link></li>
<li><link href="what-is-a-block-listener.html">What is a block listener?</link></li>
+ <li><link href="what-is-an-application-listener.html">What is an application listener?</link></li>
<li><link href="creating-a-block.html">How do I create a block?</link></li>
<li><link href="blockinfo-specification.html">BlockInfo specification</link></li>
</ol>
@@ -51,7 +51,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.2 $ $Date: 2001/11/12 06:45:39 $
+ $Revision: 1.3 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.8 +2 -3 jakarta-avalon-phoenix/src/xdocs/blockinfo-specification.xml
Index: blockinfo-specification.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/blockinfo-specification.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- blockinfo-specification.xml 22 Dec 2001 13:04:16 -0000 1.7
+++ blockinfo-specification.xml 2 Apr 2002 18:56:21 -0000 1.8
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Block Developers Guide</title>
- <subtitle>The BlockInfo Specification</subtitle>
+ <title>Phoenix Block Developer's Guide - The BlockInfo Specification</title>
<version>3.0</version>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
@@ -98,7 +97,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.7 $ $Date: 2001/12/22 13:04:16 $
+ $Revision: 1.8 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.12 +3 -2 jakarta-avalon-phoenix/src/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/book.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- book.xml 2 Feb 2002 12:20:24 -0000 1.11
+++ book.xml 2 Apr 2002 18:56:21 -0000 1.12
@@ -11,6 +11,7 @@
<menu-item label="Features" href="features.html"/>
<menu-item type="external" id="downloads" label="Download" href="http://jakarta.apache.org/builds/jakarta-avalon/release/phoenix"/>
<menu-item label="Getting Started" href="getting-started.html"/>
+ <menu-item label="Making compatible components" href="making-phoenix-compatible-comps.html"/>
<menu-item label="Installation" href="install.html"/>
<menu-item label="A Future" href="afuture.html"/>
<menu-item label="Todo" href="todo.html"/>
@@ -26,7 +27,7 @@
<menu-item label="Overview" href="deployers-guide.html"/>
</menu>
- <menu label="Assemblers Guide">
+ <menu label="Assembler's Guide">
<menu-item label="Overview" href="assemblers-guide.html"/>
<menu-item label="What is a Server Application?" href="what-is-a-server-application.html"/>
<menu-item label="Creating a Server Application" href="creating-a-server-application.html"/>
@@ -35,7 +36,7 @@
<menu-item label="environment.xml Specification" href="environment-xml-specification.html"/>
</menu>
- <menu label="Block Developers Guide">
+ <menu label="Block Developer's Guide">
<menu-item label="Overview" href="block-developers-guide.html" />
<menu-item label="What is a Block?" href="what-is-a-block.html" />
<menu-item label="What is a Block Listener?" href="what-is-a-block-listener.html" />
1.9 +1 -1 jakarta-avalon-phoenix/src/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/changes.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- changes.xml 19 Nov 2001 12:21:32 -0000 1.8
+++ changes.xml 2 Apr 2002 18:56:21 -0000 1.9
@@ -2,7 +2,7 @@
<!DOCTYPE changes SYSTEM "dtd/changes-v10.dtd">
-<changes title="Avalon/Phoenix History of Changes">
+<changes title="Phoenix - History of Changes">
<devs>
<person name="Federico Barbieri" email="fede@apache.org" id="FB"/>
<person name="Berin Loritsch" email="bloritsch@apache.org" id="BL"/>
1.3 +2 -3 jakarta-avalon-phoenix/src/xdocs/config-xml-specification.xml
Index: config-xml-specification.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/config-xml-specification.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- config-xml-specification.xml 19 Nov 2001 12:21:32 -0000 1.2
+++ config-xml-specification.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Server Assemblers Guide</title>
- <subtitle>Specification of config.xml </subtitle>
+ <title>Phoenix Server Assembler's Guide - Specification of config.xml </title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
</authors>
@@ -45,7 +44,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.2 $ $Date: 2001/11/19 12:21:32 $
+ $Revision: 1.3 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.5 +3 -4 jakarta-avalon-phoenix/src/xdocs/creating-a-block.xml
Index: creating-a-block.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/creating-a-block.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- creating-a-block.xml 22 Dec 2001 13:04:16 -0000 1.4
+++ creating-a-block.xml 2 Apr 2002 18:56:21 -0000 1.5
@@ -4,14 +4,13 @@
<document>
<header>
- <title>Block Developers Guide</title>
- <subtitle>Creating a Block</subtitle>
+ <title>Phoenix Block Developer's Guide - Creating a Block</title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
</authors>
</header>
<body>
- <s1 title="Creating your first Block">
+ <s1 title="Introduction">
<p>
This document will describe the process for creating your first block. There
are essentially three steps that must be completed before your block is ready
@@ -70,7 +69,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.4 $ $Date: 2001/12/22 13:04:16 $
+ $Revision: 1.5 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.6 +3 -4 jakarta-avalon-phoenix/src/xdocs/creating-a-server-application.xml
Index: creating-a-server-application.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/creating-a-server-application.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- creating-a-server-application.xml 19 Nov 2001 12:21:32 -0000 1.5
+++ creating-a-server-application.xml 2 Apr 2002 18:56:21 -0000 1.6
@@ -4,14 +4,13 @@
<document>
<header>
- <title>Server Assemblers Guide</title>
- <subtitle>Creating a Server Application</subtitle>
+ <title>Phoenix Server Assembler's Guide - Creating a Server Application</title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
</authors>
</header>
<body>
- <s1 title="Creating a Server Application">
+ <s1 title="Introduction">
<p>
This document will describe the process for assembling your first Server
Application. There is a number of steps in creating a Server Application.
@@ -75,7 +74,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.5 $ $Date: 2001/11/19 12:21:32 $
+ $Revision: 1.6 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.3 +2 -3 jakarta-avalon-phoenix/src/xdocs/deployers-guide.xml
Index: deployers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/deployers-guide.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- deployers-guide.xml 19 Nov 2001 12:21:32 -0000 1.2
+++ deployers-guide.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Deployers Guide</title>
- <subtitle>Introduction</subtitle>
+ <title>Phoenix - Deployers Guide</title>
<authors>
<person name="Peter Donald" email="peter@apache.org"/>
</authors>
@@ -30,7 +29,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.2 $ $Date: 2001/11/19 12:21:32 $
+ $Revision: 1.3 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.5 +2 -3 jakarta-avalon-phoenix/src/xdocs/environment-xml-specification.xml
Index: environment-xml-specification.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/environment-xml-specification.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- environment-xml-specification.xml 13 Mar 2002 16:29:05 -0000 1.4
+++ environment-xml-specification.xml 2 Apr 2002 18:56:21 -0000 1.5
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Server Assemblers Guide</title>
- <subtitle>Specification of environment.xml</subtitle>
+ <title>Phoenix Server Assembler's Guide - Specification of environment.xml</title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
</authors>
@@ -105,7 +104,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.4 $ $Date: 2002/03/13 16:29:05 $
+ $Revision: 1.5 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.2 +1 -1 jakarta-avalon-phoenix/src/xdocs/example-configuration.xml
Index: example-configuration.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/example-configuration.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example-configuration.xml 16 Nov 2001 10:43:21 -0000 1.1
+++ example-configuration.xml 2 Apr 2002 18:56:21 -0000 1.2
@@ -4,7 +4,7 @@
<document>
<header>
- <title>Example Configuration</title>
+ <title>Phoenix - Example Configuration</title>
<authors>
<person name="Stephen McConnell" email="mcconnell@osm.net"/>
<person name="Gerhard Froehlich" email="g-froehlich@gmx.de"/>
1.3 +2 -2 jakarta-avalon-phoenix/src/xdocs/features.xml
Index: features.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/features.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- features.xml 13 Mar 2001 20:41:05 -0000 1.2
+++ features.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -5,7 +5,7 @@
<document>
<header>
- <title>Features</title>
+ <title>Phoenix - Features</title>
<authors>
<person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
</authors>
@@ -13,7 +13,7 @@
<body>
-<s1 title="Features">
+<s1 title="Introduction">
<p>
This document will list the features of Phoenix. It is yet to be completed ;)
1.3 +82 -7 jakarta-avalon-phoenix/src/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/getting-started.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- getting-started.xml 13 Mar 2001 20:41:05 -0000 1.2
+++ getting-started.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -3,16 +3,17 @@
<document>
<header>
- <title>Phoenix Getting Started</title>
+ <title>Phoenix - Getting Started</title>
<authors>
<person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
<person name="Leo Simons" email="email@leosimons.com"/>
+ <person name="Paul Hammant" email="Paul_Hammant@yahoo.com"/>
</authors>
</header>
<body>
-<s1 title="Getting Started">
+<s1 title="Introduction">
<p>
This document provides developers with simple documentation for getting
@@ -49,12 +50,20 @@
</p>
</s1>
-<s1 title="Run the examples">
+<s1 title="Run the HelloWorld example">
<p>
After you have successfully built Phoenix, you can verify that it
- has compiled correctly by running the demo Service Application. To
- do so, fire up phoenix with the following command:
+ has compiled correctly by running the HelloWorld demo Service Application.
+</p>
+<p>
+ Firstly you will need to get the demo-helloword.sar file and drop it into
+ the apps directory of Phoenix. Get it from <link href="TODO">TODO</link> or build
+ it from its CVS - <link href="http://cvs.apache.org/viewcvs/jakarta-avalon-apps/demo/">
+ http://cvs.apache.org/viewcvs/jakarta-avalon-apps/demo/</link>.
+</p>
+<p>
+ Then fire up phoenix with the following command:
<source><![CDATA[
@@ -72,13 +81,79 @@
<source><![CDATA[
Hello World!
- Requests so far = 9
+ Requests so far = 1
you are 127.0.0.1 at 127.0.0.1
]]></source>
</p>
-
+<p>
+ This shows that Phoenix has unpacked and launched the server application contained
+ within the demo-helloworld.sar file. If you close and relaunch Phoenix, it should
+ restart the application.
+</p>
+<p>
+ As examples go this is a fairly simple one. You should ignore the altrmihelloworldserver,
+ rmihelloworldserver and soaphelloworldserver packages as they are retrofitting the
+ helloworld demo with remote capability using three technologies. HelloWorld uses
+ connection management from the Avalon-Cornerstone project, which is good as it allows us to
+ share connection pooling across multiple servers.
+</p>
</s1>
+<s1 title="The Phoenix Developer Kit - A different example">
+<p>
+ This self contained kit could be considered a starter project for someone wanting to make a
+ Phoenix compatible application. The idea is that you start with this skeleton including
+ Ant build script and then add in more and more as your se code to copy from elsewhere.
+</p>
+<p>
+ This 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 Phoenix and to
+ stand-alone from the command line. It is a little bit of a sleight of hand as the codebase
+ would be zipped into two forms - the sar file for phoenix and a jar file for standalone.
+</p>
+<p>
+ The Phoenix development kit originates in Phoenix's CVS, but for convenience is downloadable
+ from <link href="TODO">TODO</link>. When you have that file, unzip it and immediately launch
+ ant to make the jars and sars. There are four:
+ <ol>
+ <li>phoenix-demo.sar - the server app in Phoenix form</li>
+ <li>phoenix-demo-block.sar - used inside the sar</li>
+ <li>phoenix-demo-client.sar - a client app to test the server</li>
+ <li>phoenix-demo-server.sar - the server app in standalone form</li>
+ </ol>
+
+ The Server app in standalone mode after being tested with the client app(see below):
+
+ <source><![CDATA[
+java -jar phoenix-demo-server.jar
+PDK Demo listening on port 7654
+Ctrl-C to exit
+String passed = Hello!!!!!
+ ]]></source>
+
+ The Server app running inside Phoenix and after being tested with the client app (see below):
+
+ <source><![CDATA[
+Phoenix 4.0a4
+Server started on port 1234
+String passed = Hello!!!!!
+ ]]></source>
+
+ The client application being used to poke the server :
+
+ <source><![CDATA[
+java -jar phoenix-demo-client.jar localhost 7654 Hello!!!!!
+ ]]></source>
+
+ (Change the port to 1234 from 7654 to poke the in-Phoenix server).
+
+</p>
+<p>
+ Note - because of the need to make this dual mode, the PDK does not use Cornerstone
+ components. We normally recommend that people should reuse components from cornerstone as
+ the potential for sharing will be much higher.
+</p>
+</s1>
</body>
</document>
1.6 +2 -3 jakarta-avalon-phoenix/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/index.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.xml 22 Dec 2001 13:04:16 -0000 1.5
+++ index.xml 2 Apr 2002 18:56:21 -0000 1.6
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Phoenix Developer Documentation</title>
- <subtitle>Introduction</subtitle>
+ <title>Phoenix - Overview</title>
<authors>
<person name="Berin Loritsch" email="bloritsch@apache.org"/>
<person name="Peter Donald" email="peter@apache.org"/>
@@ -91,7 +90,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.5 $ $Date: 2001/12/22 13:04:16 $
+ $Revision: 1.6 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.3 +1 -1 jakarta-avalon-phoenix/src/xdocs/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/install.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- install.xml 13 Mar 2001 20:41:06 -0000 1.2
+++ install.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -5,7 +5,7 @@
<document>
<header>
- <title>Avalon Installation</title>
+ <title>Phoenix - Installation</title>
<authors>
<person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
</authors>
1.10 +1 -0 jakarta-avalon-phoenix/src/xdocs/phoenix.uris
Index: phoenix.uris
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/phoenix.uris,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- phoenix.uris 2 Feb 2002 12:20:24 -0000 1.9
+++ phoenix.uris 2 Apr 2002 18:56:21 -0000 1.10
@@ -19,6 +19,7 @@
blockinfo-specification.html
creating-a-block.html
example-configuration.html
+making-phoenix-compatible-comps.html
afuture.html
images/add.jpg
images/fix.jpg
1.9 +1 -1 jakarta-avalon-phoenix/src/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/todo.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- todo.xml 22 Dec 2001 13:04:16 -0000 1.8
+++ todo.xml 2 Apr 2002 18:56:21 -0000 1.9
@@ -5,7 +5,7 @@
<document>
<header>
- <title>Phoenix Todo</title>
+ <title>Phoenix - Todo</title>
<authors>
<person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
</authors>
1.4 +2 -3 jakarta-avalon-phoenix/src/xdocs/what-is-a-block-listener.xml
Index: what-is-a-block-listener.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/what-is-a-block-listener.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- what-is-a-block-listener.xml 1 Feb 2002 11:25:13 -0000 1.3
+++ what-is-a-block-listener.xml 2 Apr 2002 18:56:21 -0000 1.4
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Block Developers Guide</title>
- <subtitle>What is a Block Listener?</subtitle>
+ <title>Phoenix Block Developer's Guide - What is a Block Listener?</title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
<person id="PH" name="Paul Hammant" email="Paul_Hammant@yahoo.com"/>
@@ -61,7 +60,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.3 $ $Date: 2002/02/01 11:25:13 $
+ $Revision: 1.4 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.2 +2 -3 jakarta-avalon-phoenix/src/xdocs/what-is-a-block.xml
Index: what-is-a-block.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/what-is-a-block.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- what-is-a-block.xml 1 Mar 2001 13:44:44 -0000 1.1
+++ what-is-a-block.xml 2 Apr 2002 18:56:21 -0000 1.2
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Block Developers Guide</title>
- <subtitle>What is a Block?</subtitle>
+ <title>Phoenix Block Developer's Guide - What is a Block?</title>
<authors>
<person id="FB" name="Federico Barbieri" email="fede@apache.org"/>
</authors>
@@ -40,7 +39,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.1 $ $Date: 2001/03/01 13:44:44 $
+ $Revision: 1.2 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.3 +3 -4 jakarta-avalon-phoenix/src/xdocs/what-is-a-server-application.xml
Index: what-is-a-server-application.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/what-is-a-server-application.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- what-is-a-server-application.xml 19 Nov 2001 12:21:32 -0000 1.2
+++ what-is-a-server-application.xml 2 Apr 2002 18:56:21 -0000 1.3
@@ -4,15 +4,14 @@
<document>
<header>
- <title>Server Assemblers Guide</title>
- <subtitle>What is a Server Application?</subtitle>
+ <title>Phoenix Server Assembler's Guide - What is a Server Application?</title>
<authors>
<person id="PD" name="Peter Donald" email="peter@apache.org"/>
<person id="BL" name="Berin Loritsch" email="bloritsch@apache.org"/>
</authors>
</header>
<body>
- <s1 title="What is a Server Application?">
+ <s1 title="Introduction">
<p>
In Phoenix, a Server Application is a set of Blocks that act in concert
to provide a unified user service. Example Server Applications include a Mail
@@ -32,7 +31,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.2 $ $Date: 2001/11/19 12:21:32 $
+ $Revision: 1.3 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.2 +2 -3 jakarta-avalon-phoenix/src/xdocs/what-is-an-application-listener.xml
Index: what-is-an-application-listener.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/what-is-an-application-listener.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- what-is-an-application-listener.xml 2 Feb 2002 12:20:24 -0000 1.1
+++ what-is-an-application-listener.xml 2 Apr 2002 18:56:21 -0000 1.2
@@ -4,8 +4,7 @@
<document>
<header>
- <title>Block Developers Guide</title>
- <subtitle>What is an Application Listener?</subtitle>
+ <title>Phoenix Block Developer's Guide - What is an Application Listener?</title>
<authors>
<person id="PH" name="Paul Hammant" email="Paul_Hammant@yahoo.com"/>
</authors>
@@ -44,7 +43,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.1 $ $Date: 2002/02/02 12:20:24 $
+ $Revision: 1.2 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
1.1 jakarta-avalon-phoenix/src/xdocs/making-phoenix-compatible-comps.xml
Index: making-phoenix-compatible-comps.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
<document>
<header>
<title>Phoenix - Making components that are Phoenix compatible</title>
<authors>
<person name="Paul Hammant" email="hammant@apache.org"/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>
Quite often reusable components are made elsewhere. Apache has a number
of places where this activity is going on. While we get it right most of
the time, some components developer elsewhere are harder to use in Phoenix
</p>
</s1>
<s1 title="Things to remember">
<p>
There are a number of common sense things to remember when making or
adapting a Java component to be reusable in Phoenix as block.
</p>
<s2 title="Beanification">
<p>
<ul>
<li>Have a public empty constructor for your main class</li>
<li>Have setters for its configuration.</li>
<li>Do not assume that the File is where dependancies are - people may reuse this in jars, applets etc.</li>
<li>Divorce your main method (if appl) from your main class - Phoenix does not call main methods.</li>
<li>Consider that the setup and initialization of the bean does not happen in the
constructor - as a convenience to the user, have an initialize() method</li>
<li>If the comp has start/stop functinality consider having start() and stop() methods.</li>
<li>Try to avoid Singleton concepts. There could be multiple blocks in one sar using differnt (by design) instances of your bean</li>
</ul>
</p>
</s2>
<s2 title="Inversion of Control Pattern">
The IoC pattern is described <link href="http://jakarta.apache.org/avalon/framework/inversion-of-control.html">
here</link>. This means for Phoenix avoiding static concepts including loggers.
</s2>
<s2 title="Sepearation of interface and implementation">
<p>
The separation of interface/impl pattern is described <link href="http://jakarta.apache.org/avalon/framework/separation-of-interface-and-implementation.html">here</link>.
For Phoenix is means we can (if done completely) mount the implementation jar in place where hosted client compoennts (beans, servlets etc) can use the API, bit not see the implementation. We can also reimplement or wrap
bits of the implementation. For example we could write a pluggable implementation that could, for a certain API
journal some methods, but still delegate to the real impl. Which pluggable impl is used by Phoenix when it
boots is determined in assembly.xml of course.
</p>
</s2>
<s2 title="Opening up the API">
<p>
Given that you have divided into interface and impl, there are probably plenty of methods you
can put method in the interface you never though might be used. For example if you are making JDBC
compliant relational database, and it is a bean, you could easily think that the only use would be
clients via JDBC over sockets. Well, given that Phoenix can now mount the RDBMS block, it might want
to be reused by other blocks that other people have developed inside the the same SAR file. In that case
have beanlike methods of ...
<ol>
<li>Database createDatabase(String name)</li>
<li>Database cloneDatabase(String name)</li>
</ol>
.. might be useful. Just because you can only see a ServerSocket interface does not mean that others do.
</p>
</s2>
</s1>
<s1 title="Example compatible comp">
<p>
Below are an interface and implemmentation that are suitably separated, are beanlike and is in accordance
with the IoC pattern...
<source>
package examplecomp;
public interface StockQuoteService {
Quote getQuote(String symbol);
}
package examplecomp;
public class Quote {
public final BigDecimal ...
public Quote(...);
public BigDecimal getXXX() {
...
}
}
package examplecomp.impl;
public class DefaultStockQuoteService implements StockQuoteService {
public DefaultStockQuoteService() {
// whatever.
}
public void setConfiguration(Properties props) {
// not very beanlike but OK for reuse.
}
public void initialize() {
// whatever.
}
public Quote getQuote(String symbol) {
// whatever.
return new Quote(...);
}
}
</source>
The interface is from the clients reuse point of view. The setConfiguration(..) and intialize(..)
are something that the container will do after instantiating the bean abd are implementation specific.
This is the IoC pattern at work - the bean is instantiated then decorated with additonal stuff
until it is instructed to go.
</p>
</s1>
<s1 title="Misconceptions">
<p>
The following are worth stating:
<ul>
<li>You do not have to implement any Avalon interfaces to be reusable inside Avalon.</li>
<li>Being Phoenix compatible is just as useful for whole servers as it is for small components.</li>
<li>Being Phoenix compatible can be for tools that are intended for client-side as well as server use.</li>
</ul>
</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/04/02 18:56:21 $
</legal>
</footer>
</document>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>