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 2003/06/20 21:01:39 UTC
cvs commit: avalon-sandbox/merlin/merlin-platform/xdocs/resources notebook.xml
mcconnell 2003/06/20 12:01:39
Modified: merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath
fileset.xml index.xml navigation.xml
merlin/merlin-platform/xdocs/meta/model/block/container/include
index.xml
merlin/merlin-platform/xdocs/resources notebook.xml
Added: merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/repository
index.xml navigation.xml resource.xml
Log:
Add documetation of repository directives.
Revision Changes Path
1.2 +13 -0 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/fileset.xml
Index: fileset.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/fileset.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- fileset.xml 10 Jun 2003 02:14:23 -0000 1.1
+++ fileset.xml 20 Jun 2003 19:01:39 -0000 1.2
@@ -13,6 +13,19 @@
<section name="Fileset Declarations">
+ <subsection name="Nested Elements">
+ <table>
+ <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
+ <tr>
+ <td>include</td><td>0..n</td>
+ <td>
+ Declaration of a jar file withing the filset directory to be
+ included within the classloader.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
<subsection name="Description">
<p>Declaration of a set of jar files to include.</p>
</subsection>
1.3 +50 -3 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 17 Jun 2003 20:11:19 -0000 1.2
+++ index.xml 20 Jun 2003 19:01:39 -0000 1.3
@@ -10,11 +10,30 @@
<body>
<section name="Classpath Directive">
+ <subsection name="Nested Elements">
+ <table>
+ <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
+ <tr>
+ <td><a href="fileset.html">fileset</a></td><td>n</td>
+ <td>
+ A fileset directive.
+ </td>
+ </tr>
+ <tr>
+ <td><a href="repository/index.html">repository</a></td><td>0..n</td>
+ <td>
+ A logical jar repository (repository development is in progress,
+ as such limitations may apply).
+ </td>
+ </tr>
+ </table>
+ </subsection>
+
<subsection name="Description">
-<p>A classpath declaration may occur at kernel and container scope. A kernel classpath is accessible by the root container and all subsidiary containers. A classpath declared at container scope is accessible only to the immediate container in which the classpath is defined and its subsidiary containers. An example of a classpath declaration is included below.</p>
+<p>A classpath directive qualifies the defintion of the enclosing classloader. The enclosing classloader shall be established with the jar resources declared within the classpath. The resulting classloader shall be made available to the enclosing container and subsidiary components (including subsidiary containers). An example of a classpath declaration is included below.</p>
</subsection>
- <subsection name="Sample XML">
+ <subsection name="Sample XML (using filesets)">
<source>
<classpath>
<fileset dir="<font color="darkred">lib</font>">
@@ -23,6 +42,34 @@
</fileset>
</classpath>
</source>
+ </subsection>
+
+ <subsection name="Sample XML (using a repository)">
+<p>
+The following classpath (from the James deployment directive) demonstrates the use of repository based references. A repository contains references to resources within the repository. A repository implementation is responsible for mapping resource directives to physical jar file. The default repository is a file based repository located under the Merlin installation.
+</p>
+<source><![CDATA[
+<classpath>
+ <repository>
+ <resource id="avalon-framework:avalon-framework-impl" version="4.1.5-dev"/>
+ <resource id="cornerstone-threads:cornerstone-threads-api" version="1.0"/>
+ <resource id="cornerstone-sockets:cornerstone-sockets-api" version="1.0"/>
+ <resource id="cornerstone-connection:cornerstone-connection-api" version="1.0"/>
+ <resource id="cornerstone-scheduler:cornerstone-scheduler-api" version="1.0"/>
+ <resource id="cornerstone-datasources:cornerstone-datasources-api" version="1.0"/>
+ <resource id="cornerstone-store:cornerstone-store-api" version="1.0"/>
+ <resource id="cornerstone-connection:cornerstone-connection-impl" version="1.0"/>
+ <resource id="excalibur:excalibur-collections" version="1.0"/>
+ <resource id="excalibur-thread:excalibur-thread" version="1.1.1"/>
+ <resource id="excalibur-pool:excalibur-pool" version="1.2"/>
+ <resource id="james:dnsjava" version="1.3.2"/>
+ <resource id="james:mail" version="1.3"/>
+ <resource id="james:activation" version="1.0"/>
+ <resource id="james:mailet" version="1.0"/>
+ <resource id="james:james" version="1.3"/>
+ </repository>
+</classpath>
+]]></source>
</subsection>
</section>
</body>
1.3 +1 -1 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Jun 2003 17:43:24 -0000 1.2
+++ navigation.xml 20 Jun 2003 19:01:39 -0000 1.3
@@ -27,7 +27,7 @@
<item name="Implementation" href="/meta/model/block/container/index.html">
<item name="Engine" href="/meta/model/block/container/engine/index.html">
<item name="Classpath" href="/meta/model/block/container/engine/classpath/index.html">
- <item name="Repository" href="/meta/model/block/container/engine/classpath/repository.html"/>
+ <item name="Repository" href="/meta/model/block/container/engine/classpath/repository/index.html"/>
<item name="Fileset" href="/meta/model/block/container/engine/classpath/fileset.html"/>
</item>
<item name="Library" href="/meta/model/block/container/engine/extensions.html"/>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/repository/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Repository Directive</title>
<authors>
<person name="Stephen McConnell" email="mcconnell@apache.org"/>
</authors>
</header>
<body>
<section name="Repository Directive">
<subsection name="Description">
<p>A repository is a logical source of jar files. Resource directives contained in the repository are resolved to jar files by a repository implementation. The default implementation is a file based repository located under the Melrin installation.</p>
</subsection>
<subsection name="Sample XML">
<p>
The following classpath (from the James deployment directive) demonstrates the use of repository based references.
</p>
<source><![CDATA[
<classpath>
<repository>
<resource id="avalon-framework:avalon-framework-impl" version="4.1.5-dev"/>
<resource id="cornerstone-threads:cornerstone-threads-api" version="1.0"/>
<resource id="cornerstone-sockets:cornerstone-sockets-api" version="1.0"/>
<resource id="cornerstone-connection:cornerstone-connection-api" version="1.0"/>
<resource id="cornerstone-scheduler:cornerstone-scheduler-api" version="1.0"/>
<resource id="cornerstone-datasources:cornerstone-datasources-api" version="1.0"/>
<resource id="cornerstone-store:cornerstone-store-api" version="1.0"/>
<resource id="cornerstone-connection:cornerstone-connection-impl" version="1.0"/>
<resource id="excalibur:excalibur-collections" version="1.0"/>
<resource id="excalibur-thread:excalibur-thread" version="1.1.1"/>
<resource id="excalibur-pool:excalibur-pool" version="1.2"/>
<resource id="james:dnsjava" version="1.3.2"/>
<resource id="james:mail" version="1.3"/>
<resource id="james:activation" version="1.0"/>
<resource id="james:mailet" version="1.0"/>
<resource id="james:james" version="1.3"/>
</repository>
</classpath>
]]></source>
</subsection>
</section>
</body>
</document>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/repository/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<title>Merlin</title>
<body>
<links>
<item name="Home" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/framework/"/>
<item name="Components" href="http://avalon.apache.org/components"/>
<item name="Containers" href="http://avalon.apache.org/containers/"/>
<item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
</links>
<menu name="About Merlin">
<item name="Overview" href="/about/index.html"/>
<item name="Getting Started" href="/starting/index.html"/>
<item name="Merlin System" href="/merlin/index.html"/>
<item name="Meta Model" href="/meta/index.html">
<item name="Meta Info" href="/meta/info/index.html"/>
<item name="Meta Data" href="/meta/model/index.html">
<item name="Kernel" href="/meta/model/kernel/index.html"/>
<item name="Block" href="/meta/model/block/index.html">
<item name="Info" href="/meta/model/block/info.html"/>
<item name="Services" href="/meta/model/block/export/index.html"/>
<item name="Dependencies" href="/meta/model/block/import/index.html"/>
<item name="Implementation" href="/meta/model/block/container/index.html">
<item name="Engine" href="/meta/model/block/container/engine/index.html">
<item name="Classpath" href="/meta/model/block/container/engine/classpath/index.html">
<item name="Repository" href="/meta/model/block/container/engine/classpath/repository/index.html">
<item name="Resource" href="/meta/model/block/container/engine/classpath/repository/resource.html"/>
</item>
<item name="Fileset" href="/meta/model/block/container/engine/classpath/fileset.html"/>
</item>
<item name="Library" href="/meta/model/block/container/engine/extensions.html"/>
</item>
<item name="Component" href="/meta/model/block/container/components/index.html"/>
<item name="Container" href="/meta/model/block/container/containers.html"/>
<item name="Include" href="/meta/model/block/container/include/index.html"/>
</item>
</item>
</item>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Resources" href="/resources/index.html"/>
</menu>
<menu name="Extensions">
<item name="JNDI" href="/extensions/jndi/index.html"/>
<item name="Servlet" href="/extensions/servlet/index.html"/>
</menu>
</body>
</project>
1.1 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/engine/classpath/repository/resource.xml
Index: resource.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Include Directive</title>
<authors>
<person name="Stephen McConnell" email="mcconnell@apache.org"/>
</authors>
</header>
<body>
<section name="Resource Include Directive">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>id</td><td>yes</td>
<td>
A resource artifact identifier in form [group]:[artifact-name]. The value
identifes a jar file containing a block defintition that is resolved
relative to a repository established by the Merlin Kernel.
</td>
</tr>
<tr>
<td>version</td><td>no</td>
<td>
Used in conjuction with the id attribute to qualify the artifact version.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
A resource directive is a logical reference to a jar file within the enclosing rerpository. A repository implementation is responsible for the mapping of logical directives to physical jar URL.
</p>
</subsection>
<subsection name="Sample XML">
<p>
The following example block.xml demonstrates the inclusion of three blocks within another enclosing block. In this example, the common shared API (containing service interfaces classes is declared in the containing block classloader).
</p>
<source><![CDATA[
<block>
<info>
<name>tutorial</name>
</info>
<implementation>
<include name="publisher">
<resource id="tutorial:composition-publisher" version="1.0"/>
</include>
</implementation>
</block>
]]></source>
</subsection>
</section>
</body>
</document>
1.2 +4 -3 avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/meta/model/block/container/include/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 15 Jun 2003 17:43:24 -0000 1.1
+++ index.xml 20 Jun 2003 19:01:39 -0000 1.2
@@ -16,13 +16,13 @@
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
- <td><a href="source.html">source</a></td><td>0..1</td>
+ <td><a href="source.html">source</a></td><td>1*</td>
<td>
A block.xml source include directive.
</td>
</tr>
<tr>
- <td><a href="resource.html">resource</a></td><td>0..1</td>
+ <td><a href="resource.html">resource</a></td><td>1*</td>
<td>
A repository references from which a block descriptor will be resolved.
</td>
@@ -35,7 +35,8 @@
</tr>
</table>
<p>
- NOTE: It is an error if the include directive does not contain one of
+ * NOTE: Source and resource are mutually exclusive.
+ It is also an error if the include directive does not contain one of
two possible include forms ("source" or "resource").
</p>
1.5 +1 -1 avalon-sandbox/merlin/merlin-platform/xdocs/resources/notebook.xml
Index: notebook.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/resources/notebook.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- notebook.xml 16 Jun 2003 09:39:05 -0000 1.4
+++ notebook.xml 20 Jun 2003 19:01:39 -0000 1.5
@@ -62,7 +62,7 @@
document the repository and relationship to the classloader
and include resource tags
</td>
- <td></td>
+ <td>DONE</td>
</tr>
<tr>
<td>tutorial on logging categories management</td>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org