leosimons 2003/01/29 07:35:13 Modified: site/phoenix getting-started.html index.html Log: fix import conflicts. Revision Changes Path 1.2 +424 -1 jakarta-avalon-site/site/phoenix/getting-started.html Index: getting-started.html =================================================================== RCS file: /home/cvs/jakarta-avalon-site/site/phoenix/getting-started.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- getting-started.html 27 Jan 2003 19:51:38 -0000 1.1 +++ getting-started.html 29 Jan 2003 15:35:13 -0000 1.2 @@ -1 +1,424 @@ -<html><head><title>Resource not Found</title><STYLE><!--H1{font-family : sans-serif,Arial,Tahoma;color : white;background-color : #0086b2;} BODY{font-family : sans-serif,Arial,Tahoma;color : black;background-color : white;} B{color : white;background-color : #0086b2;} HR{color : #0086b2;} --></STYLE> </head><body><h1>Cocoon 2 - Resource not Found</h1><hr size="1" noshade="noshade"/><p><b>type</b> resource-not-found</p><p><b>message</b> <u>Page Not Available.</u></p><p><b>description</b> <u>The requested resource couldn't be found.</u></p><p><b>sender</b> org.apache.cocoon.Main</p><p><b>source</b> Cocoon commandline (Main.java)</p><p><b>request-uri</b><pre>phoenix/getting-started.html</pre></p><p><b>missing-file</b><pre>site\phoenix\getting-started.html</pre></p><hr size="1" noshade="true"/></body></html> \ No newline at end of file +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<link rel="stylesheet" href="skin/tigris.css" type="text/css"> +<link rel="stylesheet" href="skin/site.css" type="text/css"> +<link media="print" rel="stylesheet" href="skin/print.css" type="text/css"> +<title>Getting Started</title> +</head> +<body bgcolor="white" class="composite" marginheight="0" marginwidth="0"> +<!--================= start Banner ==================--> +<div id="banner"> +<table width="100%" cellpadding="8" cellspacing="0" border="0"> +<tbody> +<tr> +<!--================= start Group Logo ==================--> +<td align="left"> +<div class="groupLogo"> +<a href="http://jakarta.apache.org/"><img border="0" class="logoImage" alt="Apache Jakarta" src="images/jakarta-logo.gif"></a> +</div> +</td> +<!--================= end Group Logo ==================--> +<!--================= start Project Logo ==================--><td align="right"> +<div class="projectLogo"> +<a href="http://jakarta.apache.org/avalon/phoenix/"><img border="0" class="logoImage" alt="Avalon Phoenix" src="images/header.gif"></a> +</div> +</td> +<!--================= end Project Logo ==================--> +</tr> +</tbody> +</table> +</div> +<!--================= end Banner ==================--> +<!--================= start Main ==================--> +<table width="100%" cellpadding="0" cellspacing="0" border="0" id="breadcrumbs"> +<tbody> +<!--================= start Status ==================--> +<tr class="status"> +<td> +<!--================= start BreadCrumb ==================--><a href="http://www.apache.org/">Apache Main</a> | <a href="http://jakarta.apache.org/avalon">Avalon Main</a> | <a href="...html">Up</a> +<!--================= end BreadCrumb ==================--></td><td id="tabs"> +<!--================= start Tabs ==================--> +<div class="tab"> +<span class="unselectedTab"><a href="http://avalon.apache.org/">Avalon Home</a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/framework/">Framework</a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/phoenix/components/">Components</a></span> | <span class="selectedTab"><a href="index.html"><font color="#000000">Phoenix</font></a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/seca/">SECA</a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/apps/">Apps</a></span> +</div> +<!--================= end Tabs ==================--> +</td> +</tr> +</tbody> +</table> +<!--================= end Status ==================--> +<table id="main" width="100%" cellpadding="8" cellspacing="0" border="0"> +<tbody> +<tr valign="top"> +<!--================= start Menu ==================--> +<td id="leftcol"> +<div id="navcolumn"> +<div class="menuBar"> +<div class="menu"> +<span class="menuLabel">Essentials</span> + +<div class="menuItem"> +<a href="index.html">Overview</a> +</div> + +<div class="menuItem"> +<a href="features.html">Features</a> +</div> + +<div class="menuItem"> +<span class="menuSelected">Getting started</span> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/builds/jakarta-avalon-phoenix">Download</a> +</div> + +<div class="menuItem"> +<a href="install.html">Install</a> +</div> + +</div> +<div class="menu"> +<span class="menuLabel">Guide</span> + +<div class="menuItem"> +<a href="guide-architecture.html">Architectural Overview</a> +</div> + +<div class="menuItem"> +<a href="guide-roles.html">Development Roles</a> +</div> + +<div class="menuItem"> +<a href="guide-administrator.html">for Administrators</a> +</div> + +<div class="menuItem"> +<a href="guide-deployers.html">for Deployers</a> +</div> + +<div class="menuItem"> +<a href="assemblers/index.html">for Assemblers</a> +</div> + +<div class="menuItem"> +<a href="bdg/index.html">for Block Developers</a> +</div> + +<div class="menuItem"> +<a href="mx/index.html">Management Guide</a> +</div> + +<div class="menuItem"> +<a href="guide-example-configuration.html">Example configuration</a> +</div> + +<div class="menuItem"> +<a href="guide-punit.html">PUnit unit testing</a> +</div> + +</div> +<div class="menu"> +<span class="menuLabel">Reference</span> + +<div class="menuItem"> +<a href="http://avalon.apache.org/api/">API Docs</a> +</div> + +<div class="menuItem"> +<a href="assemblers/config-xml-specification.html">config.xml Specification</a> +</div> + +<div class="menuItem"> +<a href="assemblers/assembly-xml-specification.html">assembly.xml Specification</a> +</div> + +<div class="menuItem"> +<a href="assemblers/environment-xml-specification.html">environment.xml Specification</a> +</div> + +<div class="menuItem"> +<a href="bdg/blockinfo-specification.html">BlockInfo Specification</a> +</div> + +</div> +<div class="menu"> +<span class="menuLabel">For Developers</span> + +<div class="menuItem"> +<a href="changes.html">Changes</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/avalon/code-standards.html">Coding standards</a> +</div> + +<div class="menuItem"> +<a href="for-developers-project-structure.html">Project Structure</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/site/cvsindex.html">CVS Repositories</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a> +</div> + +<div class="menuItem"> +<a href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&product=Avalon&component=Phoenix">TODO</a> +</div> + +<div class="menuItem"> +<a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Avalon&component=Phoenix">Bug Database</a> +</div> + +<div class="menuItem"> +<a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Avalon&component=Phoenix&bug_severity=Enhancement">Enhancement Requests</a> +</div> + +<div class="menuItem"> +<a href="for-developers-alternate-kernel.html">Alternate Kernels</a> +</div> + +</div> +</div> +</div> +</td> +<!--================= end Menu ==================--> +<!--================= start Content ==================--><td> +<div id="bodycol"> +<div class="app"> +<div align="center"> +<h1>Getting Started</h1> +<h2></h2> +</div> +<div class="h3"> + + + + + + +<div class="h3"> +<h3>Introduction</h3> +</div> + + +<p> + This document provides developers with simple documentation for getting + started with Phoenix. For information about the overall structure of + Avalon Framework (on which Phoenix is based), please refer to the + <a href="http://jakarta.apache.org/avalon/framework/index.html">Framework documentation</a>. +</p> + + +<p> + Instructions for downloading and installing Phoenix can be found on the + <a href="install.html">Install</a> document. +</p> + + +<p> + More detailed instructions will be added to this document in the future. Feel free + to send in patches ;) +</p> + + + + +<div class="h3"> +<h3>View Detailed API Documentation</h3> +</div> + + +<p> + To generate a full set of detailed API documentation for Avalon, go to the base + directory of source distribution and run the appropriate build script for your + platform with the parameter 'javadocs'. + + <span class="codefrag"> + + > build.[bat|sh] javadocs + +</span> + + +</p> + + + +<div class="h3"> +<h3>Run the HelloWorld example</h3> +</div> + + +<p> + After you have successfully built Phoenix, you can verify that it + has compiled correctly by running the HelloWorld demo Service Application. +</p> + +<p> + Firstly you will need to get the demo-helloworld.sar file and drop it into + the apps directory of Phoenix. Currently it needs to be built from CVS - + <a href="http://cvs.apache.org/viewcvs/jakarta-avalon-apps/demo/"> + http://cvs.apache.org/viewcvs/jakarta-avalon-apps/demo/</a>. +</p> + +<p> + Then fire up phoenix with the following command: + + <span class="codefrag"> + + > bin/run.[bat|sh] + + </span> + +</p> + + +<p> + Next, fire up your favorite webbrowser and point it to http://localhost:8999/, + where localhost is the network name of your machine ("localhost") should + work on all windows platforms.<br> + If all goes well, you will see something like the following: + + <span class="codefrag"> + + Hello World! + Requests so far = 1 + you are 127.0.0.1 at 127.0.0.1 + + </span> + +</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> + + +<div class="h3"> +<h3>The Phoenix Developer Kit - A different example</h3> +</div> + +<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. When you have that file, unzip it + and immediately launch ant to make the jars and sars. There are four: + </p> +<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> +<p> + + The Server app in standalone mode after being tested with the client app(see below): + + <span class="codefrag"> +java -jar phoenix-demo-server.jar +PDK Demo listening on port 7654 +Ctrl-C to exit +String passed = Hello!!!!! + </span> + + The Server app running inside Phoenix and after being tested with the client app (see below): + + <span class="codefrag"> +Phoenix 4.0a4 + +Server started on port 1234 +String passed = Hello!!!!! + </span> + + The client application being used to poke the server : + + <span class="codefrag"> +java -jar phoenix-demo-client.jar localhost 7654 Hello!!!!! + </span> + + (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> + + + +<div id="authors" align="right">by Phoenix Documentation Team, Leo Simons, Paul Hammant</div> +</div> +</div> +</div> +</td> +<!--================= end Content ==================--> +</tr> +</tbody> +</table> +<!--================= end Main ==================--> +<!--================= start Footer ==================--> +<div id="footer"> +<table summary="footer" cellspacing="0" cellpadding="4" width="100%" border="0"> +<tbody> +<tr> +<!--================= start Copyright ==================--> +<td colspan="2"> +<div align="center"> +<div class="copyright"> + Copyright © 2002 The Apache Software Foundation.. All rights reserved. + </div> +</div> +</td> +<!--================= end Copyright ==================--> +</tr> +<tr> +<td align="left"> +<!--================= start Host ==================--> +<!--================= end Host ==================--></td><td align="right"> +<!--================= start Credits ==================--> +<div align="right"> +<div class="credit"></div> +</div> +<!--================= end Credits ==================--> +</td> +</tr> +</tbody> +</table> +</div> +<!--================= end Footer ==================--> +</body> +</html> 1.2 +252 -21 jakarta-avalon-site/site/phoenix/index.html Index: index.html =================================================================== RCS file: /home/cvs/jakarta-avalon-site/site/phoenix/index.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- index.html 27 Jan 2003 19:51:38 -0000 1.1 +++ index.html 29 Jan 2003 15:35:13 -0000 1.2 @@ -2,10 +2,10 @@ <html> <head> <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<link rel="stylesheet" href="../skin/tigris.css" type="text/css"> -<link rel="stylesheet" href="../skin/site.css" type="text/css"> -<link media="print" rel="stylesheet" href="../skin/print.css" type="text/css"> -<title>Apache Avalon project</title> +<link rel="stylesheet" href="skin/tigris.css" type="text/css"> +<link rel="stylesheet" href="skin/site.css" type="text/css"> +<link media="print" rel="stylesheet" href="skin/print.css" type="text/css"> +<title>Overview</title> </head> <body bgcolor="white" class="composite" marginheight="0" marginwidth="0"> <!--================= start Banner ==================--> @@ -16,13 +16,13 @@ <!--================= start Group Logo ==================--> <td align="left"> <div class="groupLogo"> -<a href="http://www.apache.org/"><img border="0" class="logoImage" alt="Apache" src="../images/group-logo.gif"></a> +<a href="http://jakarta.apache.org/"><img border="0" class="logoImage" alt="Apache Jakarta" src="images/jakarta-logo.gif"></a> </div> </td> <!--================= end Group Logo ==================--> <!--================= start Project Logo ==================--><td align="right"> <div class="projectLogo"> -<a href="http://avalon.apache.org/"><img border="0" class="logoImage" alt="Apache Avalon" src="../images/project-logo.gif"></a> +<a href="http://jakarta.apache.org/avalon/phoenix/"><img border="0" class="logoImage" alt="Avalon Phoenix" src="images/header.gif"></a> </div> </td> <!--================= end Project Logo ==================--> @@ -37,11 +37,11 @@ <!--================= start Status ==================--> <tr class="status"> <td> -<!--================= start BreadCrumb ==================--><a href=""></a><a href=""></a><a href=""></a> +<!--================= start BreadCrumb ==================--><a href="http://www.apache.org/">Apache Main</a> | <a href="http://jakarta.apache.org/avalon">Avalon Main</a> | <a href="...html">Up</a> <!--================= end BreadCrumb ==================--></td><td id="tabs"> <!--================= start Tabs ==================--> <div class="tab"> -<span class="unselectedTab"><a href="../index.html">Home</a></span> | <span class="unselectedTab"><a href="../framework/index.html">Framework</a></span> | <span class="unselectedTab"><a href="../components/index.html">Components</a></span> | <span class="selectedTab"><a href="index.html"><font color="#000000">Phoenix</font></a></span> | <span class="unselectedTab"><a href="../seca/index.html">SECA</a></span> | <span class="unselectedTab"><a href="../apps/index.html">Apps</a></span> +<span class="unselectedTab"><a href="http://avalon.apache.org/">Avalon Home</a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/framework/">Framework</a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/phoenix/components/">Components</a></span> | <span class="selectedTab"><a href="index.html"><font color="#000000">Phoenix</font></a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/seca/">SECA</a></span> | <span class="unselectedTab"><a href="http://avalon.apache.org/apps/">Apps</a></span> </div> <!--================= end Tabs ==================--> </td> @@ -58,11 +58,131 @@ <div class="menuBar"> <div class="menu"> <span class="menuLabel">Essentials</span> - + <div class="menuItem"> -<span class="menuSelected">Index</span> +<span class="menuSelected">Overview</span> </div> - + +<div class="menuItem"> +<a href="features.html">Features</a> +</div> + +<div class="menuItem"> +<a href="getting-started.html">Getting started</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/builds/jakarta-avalon-phoenix">Download</a> +</div> + +<div class="menuItem"> +<a href="install.html">Install</a> +</div> + +</div> +<div class="menu"> +<span class="menuLabel">Guide</span> + +<div class="menuItem"> +<a href="guide-architecture.html">Architectural Overview</a> +</div> + +<div class="menuItem"> +<a href="guide-roles.html">Development Roles</a> +</div> + +<div class="menuItem"> +<a href="guide-administrator.html">for Administrators</a> +</div> + +<div class="menuItem"> +<a href="guide-deployers.html">for Deployers</a> +</div> + +<div class="menuItem"> +<a href="assemblers/index.html">for Assemblers</a> +</div> + +<div class="menuItem"> +<a href="bdg/index.html">for Block Developers</a> +</div> + +<div class="menuItem"> +<a href="mx/index.html">Management Guide</a> +</div> + +<div class="menuItem"> +<a href="guide-example-configuration.html">Example configuration</a> +</div> + +<div class="menuItem"> +<a href="guide-punit.html">PUnit unit testing</a> +</div> + +</div> +<div class="menu"> +<span class="menuLabel">Reference</span> + +<div class="menuItem"> +<a href="http://avalon.apache.org/api/">API Docs</a> +</div> + +<div class="menuItem"> +<a href="assemblers/config-xml-specification.html">config.xml Specification</a> +</div> + +<div class="menuItem"> +<a href="assemblers/assembly-xml-specification.html">assembly.xml Specification</a> +</div> + +<div class="menuItem"> +<a href="assemblers/environment-xml-specification.html">environment.xml Specification</a> +</div> + +<div class="menuItem"> +<a href="bdg/blockinfo-specification.html">BlockInfo Specification</a> +</div> + +</div> +<div class="menu"> +<span class="menuLabel">For Developers</span> + +<div class="menuItem"> +<a href="changes.html">Changes</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/avalon/code-standards.html">Coding standards</a> +</div> + +<div class="menuItem"> +<a href="for-developers-project-structure.html">Project Structure</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/site/cvsindex.html">CVS Repositories</a> +</div> + +<div class="menuItem"> +<a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a> +</div> + +<div class="menuItem"> +<a href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&product=Avalon&component=Phoenix">TODO</a> +</div> + +<div class="menuItem"> +<a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Avalon&component=Phoenix">Bug Database</a> +</div> + +<div class="menuItem"> +<a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Avalon&component=Phoenix&bug_severity=Enhancement">Enhancement Requests</a> +</div> + +<div class="menuItem"> +<a href="for-developers-alternate-kernel.html">Alternate Kernels</a> +</div> + </div> </div> </div> @@ -72,24 +192,133 @@ <div id="bodycol"> <div class="app"> <div align="center"> -<h1>Apache Avalon project</h1> +<h1>Overview</h1> <h2></h2> </div> -<div class="h3"> - - - <div class="h3"> -<h3>Shaping up....</h3> + + + +<div class="h3"> +<h3>Introduction</h3> +</div> + +<p> + Phoenix is a micro-kernel designed and implemented on top of the Avalon + framework. + It 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. The API + defines a standard method of piecing together server components and creating a server. + </p> + + +<div class="h3"> +<h3>Documentation is coming</h3> +</div> + +<p> + Some of the information on this site is currently a bit out of date. We are + working hard to fix this. If you come across any inconsistencies or have a + problem, please don't hesitate to contact us through the mailing list. Thank + you. + </p> + + +<div class="h3"> +<h3>Guide to Avalon Phoenix</h3> </div> + +<p> + This guide starts with an architectural overview of Phoenix. Then, we identify + the different roles that typically exist in daily use of phoenix. For each of + these, we provide a basic guide. We finish with a complete example. + </p> + +<div class="h4"> +<h4>Target Audience</h4> +</div> + +<p> + This documentation is aimed towards people who: + </p> +<ul> + +<li>wish to create applications that run within phoenix</li> + +<li>wish to create components (blocks) for use within phoenix</li> + +<li>wish to setup and administer phoenix</li> + +<li>are interested in the design principles of Avalon Phoenix</li> + +<li>wish to develop code that will be incorporated into Avalon Phoenix</li> + +<li>wish to reuse Avalon Phoenix concepts in their own application</li> + +</ul> +<p> + +</p> + + +<div class="h4"> +<h4>Contents</h4> +</div> + +<ol> +<li> +<a href="guide-architecture.html">Architectural overview</a> +</li> -<p>This site is still shaping up. You need to go to - <a href="http://jakarta.apache.org/avalon/">the jakarta pages</a> - for now.</p> +<li> +<a href="guide-roles.html">Development roles</a> +</li> + +<li> +<a href="guide-administrator.html">Administrator Guide</a> +</li> + +<li> +<a href="guide-deployers.html">Application Deployer Guide</a> +</li> + +<li> +<a href="mx/index.html">JMX Management Guide</a> +</li> + +<li> +<a href="assemblers/index.html">Server Application Assembler Guide</a> +</li> + +<li> +<a href="bdg/index.html">Block Developer Guide</a> +</li> + +<li> +<a href="guide-example-configuration.html">Example Configuration.</a> +</li> +</ol> + +<div class="h3"> +<h3>Avalon Phoenix Reference Documentation</h3> +</div> + +<p> + Besides the + <a href="http://avalon.apache.org/api/index.html">Javadocs</a>, we have the + <a href="guide-architecture.html">Architectural overview</a> to look at. + </p> + + + +<div id="authors" align="right">by Phoenix Documentation Team</div> </div> </div> </div> @@ -120,7 +349,9 @@ <!--================= end Host ==================--></td><td align="right"> <!--================= start Credits ==================--> <div align="right"> -<div class="credit"></div> +<div class="credit"> +<a href="http://xml.apache.org/cocoon/"><img border="0" class="logoImage" alt="Built with Cocoon" src="skin/images/built-with-cocoon.gif" width="88" height="31"></a> +</div> </div> <!--================= end Credits ==================--> </td>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]