mcconnell 2002/07/14 05:11:20
Modified: assembly/src/etc merlin.gif merlin.html
assembly/src/java/org/apache/excalibur/merlin/model/builder
XMLContainerCreator.java XMLKernelCreator.java
Log:
more javadoc
Revision Changes Path
1.4 +151 -18 jakarta-avalon-excalibur/assembly/src/etc/merlin.gif
<<Binary file>>
1.5 +23 -2 jakarta-avalon-excalibur/assembly/src/etc/merlin.html
Index: merlin.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/assembly/src/etc/merlin.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- merlin.html 14 Jul 2002 10:42:47 -0000 1.4
+++ merlin.html 14 Jul 2002 12:11:20 -0000 1.5
@@ -13,6 +13,28 @@
</ul>
</p>
+<h3>Kernel Model</h3>
+Merlin seperates the notion of a kernel from the a root container of a container
hierachy. The kernel provides the framework for overall management including
startupoing up, shutting down, extensions management, and other system wide
facilities. The Melin implementation provides a utility class {@link
org.apache.excalibur.merlin.Main} that handles establish of a kernel based on a single
command line argument.</p>
+<p>A merlin kernel is created using a kernel model ({@link
org.apache.excalibur.merlin.model.KernelDescriptor}). The model may be defined
programatically or through an XML file. A kernel XML file contains the defintion of
kernal execution parameters and a root container.</P>
+<p><i>Minimilist kernel defintion.</i></p>
+<pre>
+ <kernel>
+ <classpath>
+ <fileset dir=<font color="darkred">"dist"</font>>
+ <include name="<font color="darkred">demo.jar</font>"/>
+ </fileset>
+ </classpath>
+ <container name="<font color="darkred">root</font>">
+ <component name="<font color="darkred">test</font>" class="<font
color="darkred">org.apache.excalibur.playground.BasicComponent</font>"/>
+ </container>
+ </kernel>
+</pre>
+
+<h3>Container Model</h3>
+<p>The Merlin system provides support for a cascading container model. This model
enables applications to better seperate classes as each container is associated with
its own classloader. Merlin will handle resolsolution of service dependecies for
component contained in containers by looking for explicitly declared solutions
commencing within the local container, and working progressively up the hierachy. If
not explict solutions are resolved, Merlin will attempt to build an implicit solution
based on components declared in the respective container classpath declarations.</p>
+<p><i>Example container hierachy.</i></p>
+<p><image src="merlin.gif" border="0"/></p>
+
<h3>Deployment Model</h3>
Components types deployed under this framework must be declared as formal component
types using a <classname>.xinfo descriptor as defined by the <a
href="{$docRoot}/../meta/index.html" target="_top">Avalon Meta Model</a>. Components
types may also deployed with default profile criteria and configuration
information.</p>
@@ -27,8 +49,7 @@
</li>
<li><classname>.xprofile
<ul>
- <li>Configuration/parameter profiles.</li>
- <li>Context creation directives.</li>
+ <li>Packaged profile containing type instantiation criteria.</li>
</ul>
</li>
<li><classname>.xconfig
1.4 +2 -2
jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/model/builder/XMLContainerCreator.java
Index: XMLContainerCreator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/model/builder/XMLContainerCreator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XMLContainerCreator.java 13 Jul 2002 21:28:18 -0000 1.3
+++ XMLContainerCreator.java 14 Jul 2002 12:11:20 -0000 1.4
@@ -30,7 +30,7 @@
import org.apache.excalibur.merlin.model.builder.TypeManager;
/**
- * Handles internalization of an XML based description of a {@link Profile}
+ * Handles internalization of an XML based description of a {@link
ContainerDescriptor}
* from a Configuration object. The format for Configuration object
* is specified in the <a href="package-summary.html#external">package summary</a>.
*
1.4 +2 -2
jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/model/builder/XMLKernelCreator.java
Index: XMLKernelCreator.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/merlin/model/builder/XMLKernelCreator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XMLKernelCreator.java 13 Jul 2002 21:28:18 -0000 1.3
+++ XMLKernelCreator.java 14 Jul 2002 12:11:20 -0000 1.4
@@ -33,7 +33,7 @@
import org.apache.excalibur.merlin.model.builder.TypeManager;
/**
- * Handles internalization of an XML based description of a {@link Profile}
+ * Handles internalization of an XML based description of a {@link KernelDescriptor}
* from a Configuration object. The format for Configuration object
* is specified in the <a href="package-summary.html#external">package summary</a>.
*
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>