You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2004/03/28 07:48:43 UTC
cvs commit: avalon-site/xdocs/sandbox navigation.xml
mcconnell 2004/03/27 21:48:43
Modified: xdocs/community/history navigation.xml
xdocs/community navigation.xml
xdocs/community/process navigation.xml
xdocs/community/who lsimons.xml navigation.xml
xdocs cvs.xml issues.xml navigation.xml
xdocs/developing authors.xml navigation.xml
xdocs/doc index.xml navigation.xml
xdocs/news navigation.xml
xdocs/product/components navigation.xml
xdocs/product/containers history.xml index.xml
navigation.xml
xdocs/product/framework navigation.xml
xdocs/product index.xml navigation.xml
xdocs/related external.xml navigation.xml
xdocs/sandbox navigation.xml
Added: xdocs/product/containers overview.xml
Log:
Fix broken links. Move from "Containers" to "Containment" (singular). General cleaning up and housekeeping. Fix lots of broken links. Check and validate build against Maven RC2.
Revision Changes Path
1.5 +1 -1 avalon-site/xdocs/community/history/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/community/history/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:09 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.5 +1 -1 avalon-site/xdocs/community/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/community/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:09 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.5 +1 -1 avalon-site/xdocs/community/process/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/community/process/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:09 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.3 +1 -1 avalon-site/xdocs/community/who/lsimons.xml
Index: lsimons.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/community/who/lsimons.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- lsimons.xml 22 Mar 2004 15:34:27 -0000 1.2
+++ lsimons.xml 28 Mar 2004 05:48:42 -0000 1.3
@@ -23,7 +23,7 @@
</p>
<p>
He's recently moved on to work on his own IoC solution,
- <a href="http://jicarilla.org/">Jicarilla</a>. For the fun of
+ <a href="http://lsd.student.utwente.nl/jicarilla/">Jicarilla</a>. For the fun of
it. He's now an emiritus committer and emiritus PMC member.
</p>
</section>
1.8 +1 -1 avalon-site/xdocs/community/who/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/community/who/navigation.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- navigation.xml 24 Feb 2004 19:10:37 -0000 1.7
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.8
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.3 +3 -1 avalon-site/xdocs/cvs.xml
Index: cvs.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/cvs.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- cvs.xml 4 Nov 2003 21:45:17 -0000 1.2
+++ cvs.xml 28 Mar 2004 05:48:42 -0000 1.3
@@ -184,11 +184,13 @@
</section>
<section name="Using an IDE for CVS access">
+ <!--
<p>Most decent IDEs these days provide CVS integration. Apache's Jakarta Project has
an excellent section on how to configure your IDE:
<a href="http://jakarta.apache.org/site/idedevelopers.html">IDE Developer's Guide</a>
. It applies equally well to Avalon.
- </p>
+ </p> -->
+
</section>
</body>
1.2 +2 -2 avalon-site/xdocs/issues.xml
Index: issues.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/issues.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- issues.xml 13 Feb 2004 04:35:10 -0000 1.1
+++ issues.xml 28 Mar 2004 05:48:42 -0000 1.2
@@ -43,7 +43,7 @@
<th>Reports</th>
</tr>
<tr>
- <td><a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10423">Avalon</a></td>
+ <td><a href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10423">Avalon</a></td>
<td>Core Framework, Site docs, General Issues</td>
<td>
<a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10423&report=compversions">Open Issues</a> |
@@ -53,7 +53,7 @@
</td>
</tr>
<tr>
- <td><a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10420">Fortress</a></td>
+ <td><a href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10420">Fortress</a></td>
<td>All Avalon Fortress container issues</td>
<td>
<a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10420&report=compversions">Open Issues</a> |
1.5 +1 -1 avalon-site/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.4 +2 -2 avalon-site/xdocs/developing/authors.xml
Index: authors.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/developing/authors.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- authors.xml 13 Mar 2004 18:05:48 -0000 1.3
+++ authors.xml 28 Mar 2004 05:48:42 -0000 1.4
@@ -38,8 +38,8 @@
apps. He also started AvalonDB, <!-- removed the ref since it is no longer valid -->
<a href="http://www.jesktop.com">Jesktop</a>,
<a href="http://incubator.apache.org/projects/altrmi/">AltRMI</a>,
- <a href="http://www.enterpriseobjectbroker.org">Enterprise Object Broker</a>, and
- <a href="http://www.picocontainer.org">Picocontainer</a>.
+ Enterprise Object Broker, and
+ <a href="http://docs.codehaus.org/display/PICO">Picocontainer</a>.
</p>
</subsection>
<subsection name="Niclas Hedhman">
1.4 +1 -1 avalon-site/xdocs/developing/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/developing/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 14 Mar 2004 16:32:31 -0000 1.3
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.4
@@ -7,7 +7,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.4 +1 -1 avalon-site/xdocs/doc/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/doc/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 6 Dec 2003 21:45:57 -0000 1.3
+++ index.xml 28 Mar 2004 05:48:42 -0000 1.4
@@ -67,7 +67,7 @@
</tr>
<tr>
<td>
- <a href="http://avalon.apache.org/developing/index.html">
+ <a href="../developing/index.html">
Developing With Avalon</a>
</td>
<td> The Avalon Developers Guide. An excellent white paper
1.6 +1 -1 avalon-site/xdocs/doc/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/doc/navigation.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- navigation.xml 13 Feb 2004 04:35:09 -0000 1.5
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.6
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.2 +1 -1 avalon-site/xdocs/news/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/news/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 13 Mar 2004 05:11:21 -0000 1.1
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.2
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.5 +2 -2 avalon-site/xdocs/product/components/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/components/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:42 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
@@ -20,7 +20,7 @@
<item name="Community" href="/community/index.html"/>
<item name="Products" href="/product/index.html">
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
1.2 +5 -23 avalon-site/xdocs/product/containers/history.xml
Index: history.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/containers/history.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- history.xml 13 Mar 2004 13:16:21 -0000 1.1
+++ history.xml 28 Mar 2004 05:48:43 -0000 1.2
@@ -2,7 +2,7 @@
<document>
<properties>
<author email="dev@avalon.apache.org">Avalon Documentation Team</author>
- <title>Apache Avalon: Containers</title>
+ <title>Apache Avalon: Legacy</title>
</properties>
<body>
@@ -36,9 +36,10 @@
being that platform.
</p>
<p>
- Below is the previous explainations of each of the containers.
- However, Avalon recommend that new users only invest time in
- Merlin, the only sustainable solution. ECM and Fortress will be
+ Below is the list of legacy containers.
+ Avalon recommend that new users only invest time in
+ <a href="http://avalon.apache.org/merlin">Merlin</a>, the only
+ sustainable solution. ECM and Fortress will be
partially supported during a transition period, but eventually
taken out of Avalon completely. Users who are interested in Phoenix
and that can't use Merlin, can investigate if the
@@ -48,25 +49,6 @@
<table>
<tr><th>Product</th><th>Description</th></tr>
- <tr>
- <td>
- <p>
- <a name="merlin"/>
- <a href="http://avalon.apache.org/merlin/index.html">Avalon
- Merlin</a>
- </p>
- </td>
- <td>
- <p>
- The Merlin project deals with the broad area of service
- and component management. The Merlin system is a container
- that provides comprehensive support for the management of
- complex component-based systems. Merlin uses a component
- meta-model to facilitate the automated assembly and
- deployment of simple and composite components.
- </p>
- </td>
- </tr>
<tr>
<td>
<p>
1.7 +63 -226 avalon-site/xdocs/product/containers/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/containers/index.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- index.xml 28 Mar 2004 03:20:37 -0000 1.6
+++ index.xml 28 Mar 2004 05:48:43 -0000 1.7
@@ -2,237 +2,74 @@
<document>
<properties>
<author email="dev@avalon.apache.org">Avalon Documentation Team</author>
- <title>Apache Avalon: Containers</title>
+ <title>Apache Avalon: Containment</title>
</properties>
<body>
- <section name="History" >
- <p>
- For those who are interested in the past, and how we arrived with
- Merlin, can take a look at <a href="history.html">this page</a>.
- </p>
- </section>
-
- <section name="Avalon Container Management">
- <subsection name="Purpose" >
- <p>
- The purpose of the container is to manage the components under its
- care. That typically involves various creation and destruction
- stages, or what we call the LifeCycle. Part of the creation stages
- is the different needs the component has, such as it may need a
- Logger, so the container has to provide it, it may need some type
- of configuration and the container has to provide, and so on.
- </p>
- <p>
- The container is also responsible to fulfill other concerns of the
- management contract, such as LifeStyle, Security, Dependencies,
- JAR handling and so on. Basically, the container should take care
- of everything required to get the component operational.
- </p>
- </subsection>
-
- <subsection name="Container-Component Contract" >
- <p>
- Avalon Framework and associated material specifies, among other
- things a contract between the component and the container. That
- means that if the component fulfills its obligations, the container
- will provide the component with its needs. Example; If the component
- declares that it implements LogEnabled, the container will provide
- the component with an initialized and ready-to-use Logger instance.
- </p>
- </subsection>
-
- </section>
-
- <section name="Container Provisions" >
- <subsection name="Logging" >
- <p>
- If the component declares that it implements the LogEnabled inteface,
- a ready-to-use, Logger instance will be provided through the method;
- </p>
-<source>
- public void enableLogging( Logger logger )
- {
- }
-</source>
- <p>
- The Merlin container supports both LogKit and Log4J logging subsystem,
- and please look at the
- <a href="../../logging/index.html">Avalon Logging</a> subsystem for
- details.
- </p>
- </subsection>
-
- <subsection name="Dependencies" >
- <p>
- There are many ways on how to resolve dependencies between components.
- Avalon uses a method called <em>Lookup Injection</em>, which means
- that the container will hand over a ServiceManager to the component,
- if the component implements the Serviceable interface.
- </p>
-<source>
- public void service( ServiceManager manager )
- {
- }
-</source>
- <p>
- The ServiceManager will only provide the component with components
- that satisfy the <strong>dependencies</strong> declaration in the
- component's
- <a href="../../meta/meta/info/type/index.html">Type descriptor</a>
- (.xinfo). If it attempts to lookup anything outside the declared
- dependencies, the container is expected to throw a ServiceException.
- </p>
- <p>
- And Merlin is so clever that the component will never be deployed
- if the dependencies could not be satisfied, so if the component
- follows its obligations, i.e. only looking up declared dependencies,
- the container will supply the solution, always!
- </p>
- </subsection>
-
- <subsection name="Configuration" >
- <p>
- Many components are generic and can be tweaked into doing slightly
- different things, according to some settings. We call those settings
- Configuration, and is supply to the component if the component
- implements the Configurable interface.
- </p>
-<source>
- public void configure( Configuration conf )
- {
- }
-</source>
- <p>
- The above construct allow for very complex Configurations, using
- XML nested elements, but not any XML, it must follow certain rules.
- See <a href="../../framework/api/org/apache/avalon/framework/configuration/Configuration.html">
- Configuration</a> API docs for details.
- </p>
- </subsection>
-
- <subsection name="Contextualization" >
- <p>
- Contextualization is about establishing a containment context. That
- means that there must be certain container features available to the
- component for it to function properly. This is slightly different
- from normal service dependencies, as context entries can be of any
- type, such as java.io.File for the standard "urn:avalon:home"
- context entry.
- </p>
-<source>
- public void contextualize( Context context )
- {
- }
-</source>
- <p>
- It is also possible to create custom context entries.
- <a href="../../merlin/starting/advanced/context.html">Read more about it.</a>
- </p>
- </subsection>
-
- <subsection name="Repository" >
- <p>
- We have all been in <em>JAR Hell</em>, which means that it is hard
- to keep track of which Jars are required, and more importantly which
- version of each. And that is only for your build system. When you
- start deploying the applications, this grows into a nightmare.
- This has been highlighted for quite some time within
- The Apache Software Foundation, and Maven has addressed it for build
- systems, and recently (March 2004) a new more generic project called
- Depot started in the incubator, which will address this problem.
- </p>
- <p>
- Avalon has in the meantime created the
- <a href="../../repository/index.html">Avalon Repository</a> which allows
- the applications to be distributed without any Jars, and the right
- versions of the Jars will be picked up at one or many central
- repositories. This system is compatible with the Maven repositories,
- so we have instantly access to hundreds of projects at repositories,
- such as ibiblio.org.
- </p>
- </subsection>
+
+ <section name="Reference Implementation" >
+ <table>
+ <tr><th>Product</th><th>Description</th></tr>
+ <tr>
+ <td>
+ <p>
+ <a name="merlin"/>
+ <a href="http://avalon.apache.org/merlin/index.html">Avalon
+ Merlin</a>
+ </p>
+ </td>
+ <td>
+ <p>
+ Merlin is the Avalon container Reference Implementation.
+ </p>
+ <p>
+ The Merlin system is a container
+ that provides comprehensive support for the management of
+ complex component-based systems. Merlin uses a component
+ meta-model to facilitate the automated assembly and
+ deployment of simple and composite components.
+ </p>
+ </td>
+ </tr>
+ </table>
</section>
-
- <section name="Container Deployment Cases" >
- <subsection name="Stand-alone Server" >
- <p>
- The most straight forward deployment case is the stand-alone server,
- that is started from the command-line. No programming is required,
- and there are heaps of command-line arguments available. Read about
- the details <a href="../../merlin/merlin/kernel/cli.html">here</a>.
- </p>
- <p>
- Merlin even supports that it is bootstrapped, with a tiny JAR, which
- will pick up and start Merlin (or any other compliant artifact) from a
- central repository. One can on the command-line specify which version
- of Merlin one wishes to start, and provide the application block
- reference, effectively selecting which application to start.
- </p>
- <p>
- If a central repository is not desirable, Merlin's binary distribution
- contains all that is required to run, except the application block
- itself, which may either be local or online.
- </p>
- </subsection>
-
- <subsection name="Stand-alone GUI Application" >
- <p>
- There is actually no difference between a stand-alone server and a
- stand-alone GUI application. In fact, with good Component Oriented
- practices, one can completely separate the business logic in the
- application, and provide a GUI interface or a Web interface simply
- by changing the block definition file.
- </p>
- </subsection>
-
- <subsection name="Running as a Windows NT/XP Service" >
- <p>
- Merlin is capable of starting as a Windows NT/XP Service. You can
- read about how on <a href="../../merlin/merlin/kernel/nt.html">this
- page.</a>
- </p>
- </subsection>
-
- <subsection name="Embedded in generic Application" >
- <p>
- If you have an existing application that you want to complement with
- Avalon component management, without refactoring the whole application
- into components, you will need to create Merlin embedded inside your
- application. About 10-15 lines of code is currently required, where
- the InitialContext is established, the Directives are setup and a
- Kernel is created. It looks more complicated than it is, but it is
- extremely powerful, and allows the same features as the stand-alone
- server, in fact the small bootstrapper in the stand-alone case, does
- exactly the same thing.
- </p>
- </subsection>
- <subsection name="Embedded in a Servlet" >
- <p>
- If the Servlet engine allows, it is possible to embedd Merlin inside
- a Servlet. The code required to do it, can be seen
- <a href="../../merlin/extensions/servlet/index.html">here</a>.
- It is expected that this Servlet will undergo some enhancement prior
- to be officially released in the Merlin distribution. This is to
- ensure maximum usability for our users.
- </p>
- </subsection>
-
- <subsection name="Embedded in Application Server" >
- <p>
- Embedding in Application Servers can prove to be a lot more
- complicated than in generic Application, since the App Servers very
- often imposes restrictions on the parts that it hosts, such as
- security restrictions, classloading restrictions and similar. It is
- basically a case of trying to get a operating system running inside
- another operating system, both competing for the same resources.
- </p>
- <p>
- One of the objectives of the Avalon community is to work out what is
- possible, and how, and what can not be done, in this area.
- </p>
- </subsection>
+ <section name="Background" >
+ <table>
+ <tr><th>Item</th><th>Description</th></tr>
+
+ <tr>
+ <td>
+ <p>
+ <a name="overview"/>
+ <a href="overview.html">Containment Overview</a>
+ </p>
+ </td>
+ <td>
+ <p>
+ An overview of what containment means, the purpose of a
+ container, and an introduction to the container/component
+ contract.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p>
+ <a name="legacy"/>
+ <a href="history.html">History</a>
+ </p>
+ </td>
+ <td>
+ <p>
+ Within Avalon there has been a number of container solutions. This
+ reflects a historical divergence and a present convergence within
+ the area of containment technology within Avalon. This section
+ provides an historical overview and referecnes to legacy content.
+ </p>
+ </td>
+ </tr>
+ </table>
</section>
</body>
</document>
1.5 +2 -5 avalon-site/xdocs/product/containers/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/containers/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:43 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
@@ -20,10 +20,7 @@
<item name="Community" href="/community/index.html"/>
<item name="Products" href="/product/index.html">
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html">
- <item name="Merlin" href="http://avalon.apache.org/merlin"/>
- <item name="Fortress" href="http://avalon.apache.org/excalibur/fortress/"/>
- </item>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
1.1 avalon-site/xdocs/product/containers/overview.xml
Index: overview.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<document>
<properties>
<author email="dev@avalon.apache.org">Avalon Documentation Team</author>
<title>Apache Avalon: Containers</title>
</properties>
<body>
<section name="Container Overview" >
<subsection name="Purpose" >
<p>
The purpose of the container is to manage the components under its
care. That typically involves various creation and destruction
stages, or what we call the LifeCycle. Part of the creation stages
is the different needs the component has, such as it may need a
Logger, so the container has to provide it, it may need some type
of configuration and the container has to provide, and so on.
</p>
<p>
The container is also responsible to fulfill other concerns of the
management contract, such as LifeStyle, Security, Dependencies,
JAR handling and so on. Basically, the container should take care
of everything required to get the component operational.
</p>
</subsection>
<subsection name="Container-Component Contract" >
<p>
Avalon Framework and associated material specifies, among other
things a contract between the component and the container. That
means that if the component fulfills its obligations, the container
will provide the component with its needs. Example; If the component
declares that it implements LogEnabled, the container will provide
the component with an initialized and ready-to-use Logger instance.
</p>
</subsection>
</section>
<section name="Container Provisions" >
<subsection name="Logging" >
<p>
If the component declares that it implements the LogEnabled inteface,
a ready-to-use, Logger instance will be provided through the method;
</p>
<source>
public void enableLogging( Logger logger )
{
}
</source>
<p>
The Merlin container supports both LogKit and Log4J logging subsystem,
and please look at the
<a href="http://avalon.apache.org/logging/index.html">Avalon Logging</a> subsystem for
details.
</p>
</subsection>
<subsection name="Dependencies" >
<p>
There are many ways on how to resolve dependencies between components.
Avalon uses a method called <em>Lookup Injection</em>, which means
that the container will hand over a ServiceManager to the component,
if the component implements the Serviceable interface.
</p>
<source>
public void service( ServiceManager manager )
{
}
</source>
<p>
The ServiceManager will only provide the component with components
that satisfy the <strong>dependencies</strong> declaration in the
component's
<a href="../../meta/meta/info/type/index.html">Type descriptor</a>
(.xinfo). If it attempts to lookup anything outside the declared
dependencies, the container is expected to throw a ServiceException.
</p>
<p>
And Merlin is so clever that the component will never be deployed
if the dependencies could not be satisfied, so if the component
follows its obligations, i.e. only looking up declared dependencies,
the container will supply the solution, always!
</p>
</subsection>
<subsection name="Configuration" >
<p>
Many components are generic and can be tweaked into doing slightly
different things, according to some settings. We call those settings
Configuration, and is supply to the component if the component
implements the Configurable interface.
</p>
<source>
public void configure( Configuration conf )
{
}
</source>
<p>
The above construct allow for very complex Configurations, using
XML nested elements, but not any XML, it must follow certain rules.
See <a href="../../framework/api/org/apache/avalon/framework/configuration/Configuration.html">
Configuration</a> API docs for details.
</p>
</subsection>
<subsection name="Contextualization" >
<p>
Contextualization is about establishing a containment context. That
means that there must be certain container features available to the
component for it to function properly. This is slightly different
from normal service dependencies, as context entries can be of any
type, such as java.io.File for the standard "urn:avalon:home"
context entry.
</p>
<source>
public void contextualize( Context context )
{
}
</source>
<p>
It is also possible to create custom context entries.
<a href="../../merlin/starting/advanced/context.html">Read more about it.</a>
</p>
</subsection>
<subsection name="Repository" >
<p>
We have all been in <em>JAR Hell</em>, which means that it is hard
to keep track of which Jars are required, and more importantly which
version of each. And that is only for your build system. When you
start deploying the applications, this grows into a nightmare.
This has been highlighted for quite some time within
The Apache Software Foundation, and Maven has addressed it for build
systems, and recently (March 2004) a new more generic project called
Depot started in the incubator, which will address this problem.
</p>
<p>
Avalon has in the meantime created the
<a href="../../repository/index.html">Avalon Repository</a> which allows
the applications to be distributed without any Jars, and the right
versions of the Jars will be picked up at one or many central
repositories. This system is compatible with the Maven repositories,
so we have instantly access to hundreds of projects at repositories,
such as ibiblio.org.
</p>
</subsection>
</section>
<section name="Container Deployment Cases" >
<subsection name="Stand-alone Server" >
<p>
The most straight forward deployment case is the stand-alone server,
that is started from the command-line. No programming is required,
and there are heaps of command-line arguments available. Read about
the details <a href="../../merlin/merlin/kernel/cli.html">here</a>.
</p>
<p>
Merlin even supports that it is bootstrapped, with a tiny JAR, which
will pick up and start Merlin (or any other compliant artifact) from a
central repository. One can on the command-line specify which version
of Merlin one wishes to start, and provide the application block
reference, effectively selecting which application to start.
</p>
<p>
If a central repository is not desirable, Merlin's binary distribution
contains all that is required to run, except the application block
itself, which may either be local or online.
</p>
</subsection>
<subsection name="Stand-alone GUI Application" >
<p>
There is actually no difference between a stand-alone server and a
stand-alone GUI application. In fact, with good Component Oriented
practices, one can completely separate the business logic in the
application, and provide a GUI interface or a Web interface simply
by changing the block definition file.
</p>
</subsection>
<subsection name="Running as a Windows NT/XP Service" >
<p>
Merlin is capable of starting as a Windows NT/XP Service. You can
read about how on <a href="../../merlin/merlin/kernel/nt.html">this
page.</a>
</p>
</subsection>
<subsection name="Embedded in generic Application" >
<p>
If you have an existing application that you want to complement with
Avalon component management, without refactoring the whole application
into components, you will need to create Merlin embedded inside your
application. About 10-15 lines of code is currently required, where
the InitialContext is established, the Directives are setup and a
Kernel is created. It looks more complicated than it is, but it is
extremely powerful, and allows the same features as the stand-alone
server, in fact the small bootstrapper in the stand-alone case, does
exactly the same thing.
</p>
</subsection>
<subsection name="Embedded in a Servlet" >
<p>
If the Servlet engine allows, it is possible to embedd Merlin inside
a Servlet. The code required to do it, can be seen
<a href="http://avalon.apache.org/merlin/extensions/servlet/index.html">here</a>.
It is expected that this Servlet will undergo some enhancement prior
to be officially released in the Merlin distribution. This is to
ensure maximum usability for our users.
</p>
</subsection>
<subsection name="Embedded in Application Server" >
<p>
Embedding in Application Servers can prove to be a lot more
complicated than in generic Application, since the App Servers very
often imposes restrictions on the parts that it hosts, such as
security restrictions, classloading restrictions and similar. It is
basically a case of trying to get a operating system running inside
another operating system, both competing for the same resources.
</p>
<p>
One of the objectives of the Avalon community is to work out what is
possible, and how, and what can not be done, in this area.
</p>
</subsection>
</section>
</body>
</document>
1.5 +2 -2 avalon-site/xdocs/product/framework/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/framework/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:43 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
@@ -20,7 +20,7 @@
<item name="Community" href="/community/index.html"/>
<item name="Products" href="/product/index.html">
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
1.3 +4 -9 avalon-site/xdocs/product/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 13 Mar 2004 13:16:21 -0000 1.2
+++ index.xml 28 Mar 2004 05:48:43 -0000 1.3
@@ -25,18 +25,13 @@
</td>
</tr>
<tr>
- <td><a href="containers/index.html">Containers</a></td>
+ <td><a href="containers/index.html">Containment</a></td>
<td>
<p>
A container is a platform supporting the management of
- components. This page tries to explain how component
- management is done in Avalon.
- </p>
- <p>
- In March 2004, Avalon community decided to focus on a single
- reference container, which is
- <a href="../merlin/index.html">Merlin</a>, but this page
- also give some history on how we arrived where we are.
+ components. This page provides links to Avalon's reference
+ implementation, general containment theory, and references
+ to legacy products.
</p>
</td>
</tr>
1.5 +2 -2 avalon-site/xdocs/product/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/product/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:43 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
@@ -20,7 +20,7 @@
<item name="Community" href="/community/index.html"/>
<item name="Products" href="/product/index.html">
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</item>
<item name="Documentation" href="/doc/index.html"/>
1.4 +7 -5 avalon-site/xdocs/related/external.xml
Index: external.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/related/external.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- external.xml 5 Nov 2003 05:50:09 -0000 1.3
+++ external.xml 28 Mar 2004 05:48:43 -0000 1.4
@@ -42,7 +42,7 @@
</td>
</tr>
<tr>
- <td><p><a href="http://jcrontab.sf.net">Jcrontab</a></p></td>
+ <td><p><a href="http://jcrontab.sourceforge.net">Jcrontab</a></p></td>
<td>
<p>JCrontab provides a simple Java implementation of the
Unix cron service. An Avalon interface is provided.</p></td>
@@ -58,7 +58,7 @@
</td>
</tr>
<tr>
- <td><p><a href="http://xingu.sf.net/">Xingu Components</a></p></td>
+ <td><p><a href="http://xingu.sourceforge.net/">Xingu Components</a></p></td>
<td><p>
A collection of Avalon components including OJB and Hibernate
support, a business object API, ACL component, Messenging
@@ -66,20 +66,22 @@
</td>
</tr>
<tr>
- <td><p><a href="http://phoenixjms.sf.net">PhoenixJMS</a></p></td>
+ <td><p><a href="http://phoenixjms.sourceforge.net/">PhoenixJMS</a></p></td>
<td><p>An Avalon component wrapper for OpenJMS</p></td>
</tr>
+ <!--
<tr>
<td><p><a href="http://www.enterpriseobjectbroker.org/">
Enterprise Object Broker</a></p></td>
<td><p>a "post-J2EE" application server.</p></td>
</tr>
+ -->
<tr>
<td><p><a href="http://telnetd.sourceforge.net/">Telnetd</a></p></td>
<td><p>Java telnet implementation</p></td>
</tr>
<tr>
- <td><p><a href="http://spice.sf.net">Spice</a></p></td>
+ <td><p><a href="http://spice.codehaus.org">Spice</a></p></td>
<td><p>Spice is a repository of Components which support
Component Oriented Programming (COP) paradigms - in
particular, the Inversion of Control (IoC) design
@@ -106,7 +108,7 @@
<th>Description</th>
</tr>
<tr>
- <td><p><a href="http://picocontainer.org">Picocontainer</a></p></td>
+ <td><p><a href="http://docs.codehaus.org/display/PICO">Picocontainer</a></p></td>
<td><p>Picocontainer is a light weight IoC framework.</p></td>
</tr>
<tr>
1.5 +1 -1 avalon-site/xdocs/related/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/related/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:43 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
1.5 +1 -1 avalon-site/xdocs/sandbox/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-site/xdocs/sandbox/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 13 Feb 2004 04:35:10 -0000 1.4
+++ navigation.xml 28 Mar 2004 05:48:43 -0000 1.5
@@ -10,7 +10,7 @@
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="/index.html"/>
<item name="Framework" href="/product/framework/index.html"/>
- <item name="Containers" href="/product/containers/index.html"/>
+ <item name="Containment" href="/product/containers/index.html"/>
<item name="Components" href="/product/components/index.html"/>
</links>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org