avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From leosim...@apache.org
Subject cvs commit: jakarta-avalon/src/xdocs/framework guide-cop-in-avalon.xml index.xml reference-containers.xml
Date Sun, 14 Jul 2002 13:42:14 GMT
leosimons    2002/07/14 06:42:14

  Modified:    src/xdocs book.xml features.xml index.xml
               src/xdocs/framework guide-cop-in-avalon.xml index.xml
                        reference-containers.xml
  Added:       src/xdocs getting-started.xml
  Log:
  update site to reflect recent developments; added global getting-started informaton; added
more documentation on containers
  
  Revision  Changes    Path
  1.15      +9 -9      jakarta-avalon/src/xdocs/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon/src/xdocs/book.xml,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- book.xml	8 Jul 2002 18:16:57 -0000	1.14
  +++ book.xml	14 Jul 2002 13:42:14 -0000	1.15
  @@ -10,7 +10,7 @@
     <menu label="About">
       <menu-item label="Overview" href="index.html"/>
       <menu-item label="Features" href="features.html"/>
  -    <menu-item label="Getting Started" href="framework/getting-started.html" />
  +    <menu-item label="Getting Started" href="getting-started.html" />
       <menu-item label="Download Binaries" href="http://jakarta.apache.org/site/binindex.html"
/>
       <menu-item label="Download Source" href="http://jakarta.apache.org/site/sourceindex.html"
/>
       <menu-item label="Case Studies" href="case-studies.html" />
  @@ -23,20 +23,20 @@
       <menu-item label="Excalibur" href="@EXCALIBUR_BASE@/index.html"/>
       <menu-item label="Phoenix" href="@PHOENIX_BASE@/index.html"/>
       <menu-item label="Cornerstone" href="@CORNERSTONE_BASE@/index.html"/>
  +    <menu-item label="Applications" href="@APPS_BASE@/index.html"/>
       <menu-item label="LogKit" href="@LOGKIT_BASE@/index.html"/>
  -    <menu-item label="Applications" href="@APPS_BASE@/index.html"/>    
     </menu>
  -  
  -  <menu label="Developing with Avalon">
  -    <menu-item label="Prerequisites" href="developing/index.html"/>
  -    <menu-item label="Tweety, Avalon Educational Channel" href="@EXCALIBUR_BASE@/tweety/index.html"
/>    
  -    <menu-item label="Framework, Excalibur and LogKit" href="developing/index.html"
/>
  -    <menu-item label="Phoenix and Cornerstone" href="@PHOENIX_BASE@/index.html" />
  +
  +  <menu label="Guides">
  +    <menu-item label="Avalon for Beginners" href="@EXCALIBUR_BASE@/tweety/avalon-for-beginners.html"
/>
  +    <menu-item label="Developing with Avalon" href="developing/index.html" />
  +    <menu-item label="Developing with Phoenix" href="@PHOENIX_BASE@/index.html" />
  +    <menu-item label="Developing with Logkit" href="@LOGKIT_BASE@/whitepaper.html" />
     </menu>
   
     <menu label="For Developers">
       <menu-item label="Coding standards" href="code-standards.html" />
  -    <menu-item label="CVS" href="http://cvs.apache.org/viewcvs/jakarta-avalon/.html"
/>
  +    <menu-item label="CVS" href="http://cvs.apache.org/viewcvs/jakarta-avalon/" />
       <menu-item label="Mailing Lists" href="mail.html"/>
     </menu>
     
  
  
  
  1.10      +3 -2      jakarta-avalon/src/xdocs/features.xml
  
  Index: features.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon/src/xdocs/features.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- features.xml	19 May 2002 09:53:35 -0000	1.9
  +++ features.xml	14 Jul 2002 13:42:14 -0000	1.10
  @@ -5,15 +5,16 @@
   <document>
   
    <header>
  -  <title>Avalon Project - Case Studies</title>
  +  <title>Avalon Project - Features</title>
     <authors>
       <person name="Robert McIntosh" email="rmcintosh@bull-enterprises.com"/>
  +    <person name="Leo Simons" email="leosimons@apache.org"/>
     </authors>
    </header>
   
   <body>
   
  -<s1 title="Case Studies">
  +<s1 title="Introduction">
     <p>The Avalon project is so large and broad in scope that it is not easy
     to provide a simple list of features in the form of "Avalon provides
     Component X which will fulfill role Y in your project Z perfectly".</p>
  
  
  
  1.14      +29 -33    jakarta-avalon/src/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon/src/xdocs/index.xml,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- index.xml	13 Jul 2002 10:04:00 -0000	1.13
  +++ index.xml	14 Jul 2002 13:42:14 -0000	1.14
  @@ -44,7 +44,7 @@
           in software development and even more uncommon in auto-organized open
           source projects. The main goal of this project is to design a way for
           different projects to share resources avoiding as much as possible efforts
  -        duplication. 
  +        duplication.
         </p>
         <p>
           The Avalon Team are proud to announce a new whitepaper that covers how
  @@ -58,11 +58,11 @@
         <p>
           There are several distinct sub-projects that together form the Avalon project:
         </p>
  -      
  +
         <s2 title="Framework">
           <p>
  -          <link href="framework/index.html">Framework</link> provides a specification
of 
  -          design patterns and rules in the form of interfaces. Also provided are default

  +          <link href="framework/index.html">Framework</link> provides a specification
of
  +          design patterns and rules in the form of interfaces. Also provided are default
             implementations of those interfaces.
           </p>
           <p>
  @@ -70,14 +70,14 @@
             a collection of code design patterns, rules, guidelines and suggestions on how
to
             write software that "plugs" into the framework. The framework does not
             impose restrictions on the application that uses it, but rather precious guidelines
to
  -          help the developers reuse as much work they can from other solutions. 
  +          help the developers reuse as much work they can from other solutions.
           </p>
         </s2>
   
         <s2 title="Excalibur">
           <p>
  -          <link href="@EXCALIBUR_BASE@/index.html">Excalibur</link> is a collection
of 
  -          implementations and common code based on and implementing the 
  +          <link href="@EXCALIBUR_BASE@/index.html">Excalibur</link> is a collection
of
  +          implementations and common code based on and implementing the
             <link href="framework/index.html">Avalon Framework</link>.
           </p>
         </s2>
  @@ -87,55 +87,51 @@
             <link href="@PHOENIX_BASE@/index.html">Phoenix</link> is a server
oriented
             Application Server. Applications and Services that conform to the framework
             rules can be hosted in Phoenix. The Application server manages the applications
  -          classloader, security and logging needs. It also provides a JMX-based management

  +          classloader, security and logging needs. It also provides a JMX-based management
             facility.
           </p>
         </s2>
   
  -      <s2 title="LogKit">
  -        <p>
  -          <link href="@LOGKIT_BASE@/index.html">LogKit</link> is the preferred
logging toolkit 
  -          used by the Avalon subprojects.
  -        </p> 
  -      </s2>
  -
         <s2 title="Cornerstone">
           <p>
             <link href="@CORNERSTONE_BASE@/index.html">Cornerstone</link> is
a repository.
             for what we call <link href="@PHOENIX_BASE@/what-is-a-block.html">blocks</link>,
             which provide services vital to server applications. The blocks include blocks
for
  -          services such as scheduling and socket management. 
  +          services such as scheduling and socket management.
           </p>
         </s2>
   
  -      <s2 title="Testlet">
  -        <note>
  -      As of August 1, 2001 the Avalon Development Team has decided to
  -      discontinue development of <link href="@TESTLET_BASE@/index.html">Testlet</link>
in favor of the
  -      <link href="http://www.junit.org">JUnit</link> testing framework.
  -      We will continue to reference this project until all tests are
  -      converted to JUnit TestCases.
  -    </note>
  -
  -      </s2>
         <s2 title="Applications">
           <p>
  -          <link href="@APPS_BASE@/index.html">Applications</link> is a repository
of  
  +          <link href="@APPS_BASE@/index.html">Applications</link> is a repository
of
             Phoenix blocks.  Some are simple self-contained demos of Phoenix applications,
             others are complete standalone products, and a few are ambitious works in progress.
             If you are looking for a starting point for a Phoenix block or a complete server,
             then these applications could be good inspiration.
           </p>
         </s2>
  +
  +      <s2 title="LogKit">
  +        <p>
  +          <link href="@LOGKIT_BASE@/index.html">LogKit</link> is the preferred
logging toolkit
  +          used by the Avalon subprojects.
  +
  +	  <note>
  +	  It is quite possible to use the other avalon subprojects without committing to logkit.
  +	  We support log4j and JDK 1.4 logging as well.
  +	  </note>
  +        </p>
  +      </s2>
  +
       </s1>
  -      
  +
       <s1 title="Supporting Technologies">
           <p>
  -           <link href="http://krysalis.org/"><img src="skin/images/centipede-logo-small.gif"
alt="Krysalis Logo" border="0"/></link> 
  -           <link href="http://xml.apache.org/cocoon/"><img src="skin/images/built-with-cocoon.gif"
alt="Cocoon Logo" border="0"/></link> 
  -           <link href="http://jakarta.apache.org/ant/"><img src="skin/images/ant_logo_small.gif"
alt="Ant Logo" border="0"/></link> 
  +           <link href="http://krysalis.org/"><img src="skin/images/centipede-logo-small.gif"
alt="Krysalis Logo" border="0"/></link>
  +           <link href="http://xml.apache.org/cocoon/"><img src="skin/images/built-with-cocoon.gif"
alt="Cocoon Logo" border="0"/></link>
  +           <link href="http://jakarta.apache.org/ant/"><img src="skin/images/ant_logo_small.gif"
alt="Ant Logo" border="0"/></link>
           </p>
  -      
  +
       </s1>
       
     </body>
  
  
  
  1.4       +93 -83    jakarta-avalon/src/xdocs/getting-started.xml
  
  
  
  
  1.2       +26 -1     jakarta-avalon/src/xdocs/framework/guide-cop-in-avalon.xml
  
  Index: guide-cop-in-avalon.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon/src/xdocs/framework/guide-cop-in-avalon.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- guide-cop-in-avalon.xml	3 May 2002 10:19:53 -0000	1.1
  +++ guide-cop-in-avalon.xml	14 Jul 2002 13:42:14 -0000	1.2
  @@ -195,6 +195,13 @@
             instantiate objects as well.  It takes an object (a hint), and returns the
             specific Component based on that hint.
           </p>
  +
  +	<note>
  +	Discussions are currently taking place about the ComponentSelector interface and
  +	concept. It might be deprecated at some point in the future. There are indications
  +	that usage of the ComponentSelector is only required when an application is
  +	badly designed.
  +	</note>
         </s2>
         <s2 title="When you are done with the Component">
           <p>
  @@ -271,6 +278,24 @@
             Role you are looking up.  Just be consistent.
           </p>
         </s2>
  +    </s1>
  +    <s1 title="The Container">
  +    	<p>
  +		The Container is the entity that manages your Components. It handles
  +		things like loading of configuration files, resolution of dependencies,
  +		component management, component isolation, and lifecycle support.
  +	</p>
  +	<p>
  +		The Container is not formalized in the form of an interface or contract
  +		within Avalon Framework, though it might be at some point in the future.
  +		The informal contract for the container is that it has the ability to
  +		host any fully avalon-framework compliant component. Most current containers
  +		place additional requirments on the component.
  +	</p>
  +	<p>
  +		For a list of containers implementations,
  +		<link href="reference-containers.xml">look here</link>.
  +	</p>
       </s1>
     </body>
     <footer>
  
  
  
  1.12      +4 -3      jakarta-avalon/src/xdocs/framework/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon/src/xdocs/framework/index.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- index.xml	30 May 2002 16:28:17 -0000	1.11
  +++ index.xml	14 Jul 2002 13:42:14 -0000	1.12
  @@ -67,8 +67,9 @@
           <p>
              Besides the
              <link href="@AVALON_BASE@/api/index.html">Javadocs</link>, we have
  -           <link href="diagrams/">Class diagrams</link> and the
  -           <link href="reference-the-lifecycle">The Lifecycle specification</link>.
  +           <link href="diagrams/">Class diagrams</link>, the
  +           <link href="reference-the-lifecycle.html">Lifecycle specification</link>
and the
  +           <link href="reference-containers.html">List of containers</link>.
           </p>
         </s1>
     </body>
  
  
  
  1.2       +125 -62   jakarta-avalon/src/xdocs/framework/reference-containers.xml
  
  Index: reference-containers.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon/src/xdocs/framework/reference-containers.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- reference-containers.xml	9 Jun 2002 19:34:59 -0000	1.1
  +++ reference-containers.xml	14 Jul 2002 13:42:14 -0000	1.2
  @@ -1,62 +1,125 @@
  -<?xml version="1.0"?>
  -
  -<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
  -
  -<document>
  -  <header>
  -    <title>Avalon Framework - Containers</title>
  -    <authors>
  -      <person id="PH" name="Paul Hammant" email="Paul_Hammant@yahoo.com"/>
  -    </authors>
  -  </header>
  -  <body>
  -    <s1 title="Introduction">
  -      <p> 
  -        There are various container that are aware of the Avalon-Framework interfaces.
 
  -        They either support all or some of the interfaces.  They either add 
  -        <link href="guide-patterns-ioc.html">Inversion-of-Control</link> type
interfaces 
  -        of their own constituting a specialized API, or do not, making them general 
  -        containers.
  -      </p>      
  -    </s1>      
  -    <s1 title="General Containers">
  -      <p>
  -        These typically run from the command line and are launched via a legacy main()
method.
  -      </p>
  -      <s2 title="Avalon Phoenix">
  -        <p>
  -          This is a sister project to Avalon Framework.  It provides an environment 
  -          for launching of more or less unrestricted server applications as hosted 
  -          components.  These comps will be things like web-server, rdbms, EJB-server.
  -          See <link href="@PHOENIX_BASE@/index.html">Phoenix</link>.
  -        </p>
  -      </s2>
  -    </s1>
  -    <s1 title="Specialized Containers">
  -      <p>
  -        These typically run inside something else and are launched by that something else.
  -      </p>
  -      <s2 title="Excalibur Component Manager">
  -        <p>
  -          This is used by various applications like Cocoon. Cocoon is run inside the 
  -          Sun specified servlet context of a web-app.  It is designed for such 
  -          Servlet-context reuse.  See TODO.
  -        </p>
  -      </s2>
  -      <s2 title="Enterprise Object Broker (EOB)">
  -        <p>
  -          The reference implementation of the EJB-replacement container runs on top of

  -          Phoenix.  EOB supports a subset of the Avalon Framework interfaces but allows
  -          RPC publishing of arbitary interfaces apparent in a hosted components object
  -          model.  See <link href="http://eob.sourceforge.net/">EOB</link>.
  -        </p>
  -      </s2>      
  -    </s1>    
  -  </body>
  -  <footer>
  -    <legal>
  -      Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
  -      $Revision$ $Date$
  -    </legal>
  -  </footer>
  -</document>
  +<?xml version="1.0"?>
  +
  +<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
  +
  +<document>
  +  <header>
  +    <title>Avalon Framework - Containers</title>
  +    <authors>
  +      <person id="PH" name="Paul Hammant" email="Paul_Hammant@yahoo.com"/>
  +      <person name="Leo Simons" email="leosimons@apache.org"/>
  +    </authors>
  +  </header>
  +  <body>
  +    <s1 title="Introduction">
  +      <p>
  +        There are various containers that are aware of the Avalon Framework interfaces.
  +	This is a sort-of comprehensive list.
  +      </p>
  +    </s1>
  +    <s1 title="Standalone Containers">
  +      <p>
  +        These typically run from the command line and are launched via a legacy main()
method.
  +      </p>
  +      <s2 title="Avalon Phoenix">
  +        <p>
  +          This is a sister project to Avalon Framework.  It provides an environment
  +          for launching of multiple, isolate, more or less unrestricted server applications
  +	  as hosted components.  These can be applications like a web server, RDBMS or
  +	  EJB server. It provides many advanced features like automatic management, at the
  +	  cost of a bit of complexity.
  +          See <link href="@PHOENIX_BASE@/index.html">Phoenix</link>.
  +        </p>
  +
  +	<p>
  +	  Phoenix is the oldest of the Avalon Containers; it is probably the most powerful
  +	  and most widely used. While still in alpha, this hints at the fact that we find it
  +	  to be not completely future complete, rather than an infantile project.
  +	</p>
  +      </s2>
  +
  +	<s2 title="Avalon Excalibur's Tweety">
  +	<p>
  +	Tweety is almost the opposite of Phoenix. It is a recent development and written
  +	exclusively as a teaching tool. It has no features whatsoever besides basic support
  +	for the avalon lifecycle. This results in a complete distribution the size of the
  +	phoenix bootstrapper.
  +	See <link href="@AVALON_BASE@/excalibur/tweety">Tweety</link>
  +	</p>
  +	</s2>
  +
  +	<s2 title="Myrmidon">
  +	<p>
  +	Myrmidon is a proposal for the kernel of
  +	<link href="http://jakarta.apache.org/ant">Apache Ant</link> 2.
  +	See <link href="http://cvs.apache.org/viewcvs.cgi/jakarta-ant/proposal/myrmidon/">Myrmidon</link>
  +	</p>
  +	</s2>
  +    </s1>
  +    <s1 title="Embedded Containers">
  +      <p>
  +        These run inside another application (like a servlet engine) and are controlled
by it.
  +      </p>
  +      <s2 title="Excalibur Component Manager">
  +        <p>
  +          This is used by various applications like Cocoon. Cocoon is run inside the
  +          Sun specified servlet context of a web-app.  It is designed for such
  +          Servlet-context reuse. ECM is the most stable of the containers (it is the
  +	  only one with a stable release); it is also arguably the worst design.
  +	  See <link href="@AVALON_BASE@/excalibur/component/">ECM</link>.
  +        </p>
  +      </s2>
  +      <s2 title="Fortress">
  +        <p>
  +          Fortress is ment as a future replacement of ECM. It fixes several of ECMs flaws
  +	  like a mixup of concerns. It is built to be very extensible, and it includes
  +	  support for custom lifecycle extensions. Fortress is still pre-alpha.
  +	  See <link href="@AVALON_BASE@/excalibur/fortress/">Fortress</link>.
  +        </p>
  +      </s2>
  +      <s2 title="Merlin">
  +        <p>
  +          Another recent development is Merlin, which has a client API very similar to
  +	  Phoenix (applications that can run within phoenix can run within merlin as
  +	  well). Merlin is still pre-alpha.
  +	</p>
  +	<p>
  +	  See <link href="http://home.osm.net/doc/merlin/index.html">Merlin</link>.
  +        </p>
  +      </s2>
  +      <s2 title="Plexus">
  +        <p>
  +          Plexus is a container under development that will become the basis of the
  +	  services framework for a sister project to avalon,
  +	  <link href="http://jakarta.apache.org/turbine">Turbine</link>.
  +        </p>
  +	<p>
  +		See <link href="http://tambora.zenplex.org/cgi-bin/cvsweb.cgi/plexus/">Plexus</link>.
  +	</p>
  +	<note>
  +	Plexus is being developed outside of avalon itself as an external project.
  +	</note>
  +      </s2>
  +      <s2 title="Enterprise Object Broker (EOB)">
  +        <p>
  +          The reference implementation of this EJB-replacement container runs on top of
  +          Phoenix.  EOB supports a subset of the Avalon Framework interfaces but allows
  +          RPC publishing of arbitary interfaces apparent in a hosted components object
  +          model.
  +        </p>
  +	<p>
  +		  See <link href="http://eob.sourceforge.net/">EOB</link>.
  +	</p>
  +	<note>
  +	EOB is an being developed outside of avalon itself as an external project.
  +	</note>
  +      </s2>
  +     </s1>
  +  </body>
  +  <footer>
  +    <legal>
  +      Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
  +      $Revision$ $Date$
  +    </legal>
  +  </footer>
  +</document>
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message