mcconnell 2003/11/30 00:49:32
Modified: repository README.TXT
repository/site/xdocs/about/api artifact.xml classloader.xml
index.xml repository.xml
repository/site/xdocs/start/install cvs.xml
Log:
Site documentation updates.
Revision Changes Path
1.8 +0 -8 avalon-sandbox/repository/README.TXT
Index: README.TXT
===================================================================
RCS file: /home/cvs/avalon-sandbox/repository/README.TXT,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- README.TXT 30 Nov 2003 05:49:31 -0000 1.7
+++ README.TXT 30 Nov 2003 08:49:32 -0000 1.8
@@ -30,14 +30,6 @@
$ cd /avalon-sandbox/repository
$ maven avalon:setup
-The test suite in the repo package assumes that the sandbox/kernel
-suboroject has been build and installed. To do this you need to
-do the following:
-
- $ cd ../kernel/impl
- $ maven jar:install
- $ cd ../../repository
-
The following goal builds the repository project:
$ maven avalon:build
1.2 +2 -3 avalon-sandbox/repository/site/xdocs/about/api/artifact.xml
Index: artifact.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/repository/site/xdocs/about/api/artifact.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- artifact.xml 24 Nov 2003 06:06:11 -0000 1.1
+++ artifact.xml 30 Nov 2003 08:49:32 -0000 1.2
@@ -71,13 +71,12 @@
<p>
The following code fragment demonstrates the creation of an
- artifact reference. In this example we are creating a
- reference using the Maven group/name/version semantics.
+ artifact reference by suplying a "group", "name" and "version".
</p>
<source>
Artifact artifact =
- ClassicArtifact.createJarArtifact(
+ Artifact.createArtifact(
"avalon-framework", "avalon-framework-api", "4.1.5" );</source>
<p>
1.2 +1 -1 avalon-sandbox/repository/site/xdocs/about/api/classloader.xml
Index: classloader.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/repository/site/xdocs/about/api/classloader.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- classloader.xml 24 Nov 2003 06:06:11 -0000 1.1
+++ classloader.xml 30 Nov 2003 08:49:32 -0000 1.2
@@ -78,7 +78,7 @@
<source>
Artifact artifact =
- ClassicArtifact.createJarArtifact(
+ Artifact.createArtifact(
"merlin", "merlin-kernel-impl", "3.2.2" );
ClassLoader classloader =
1.2 +1 -1 avalon-sandbox/repository/site/xdocs/about/api/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/repository/site/xdocs/about/api/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Nov 2003 06:06:11 -0000 1.1
+++ index.xml 30 Nov 2003 08:49:32 -0000 1.2
@@ -70,7 +70,7 @@
<source>
Artifact artifact =
- ClassicArtifact.createJarArtifact(
+ Artifact.createArtifact(
"avalon-framework", "avalon-framework-api", "4.1.5" );
URL url = m_repository.getResource( artifact ); </source>
1.2 +80 -1 avalon-sandbox/repository/site/xdocs/about/api/repository.xml
Index: repository.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/repository/site/xdocs/about/api/repository.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- repository.xml 24 Nov 2003 06:06:12 -0000 1.1
+++ repository.xml 30 Nov 2003 08:49:32 -0000 1.2
@@ -62,9 +62,88 @@
<subsection name="Repository">
<p>
- IN PREPARATION
+ The <a
href="../../api/org/apache/avalon/repository/Repository.html">Repository</a>
+ interface provides a simple protocol independent API against which a
client can
+ retrieve physical artifacts, artifact metadata, and composite objects
derived from
+ metadata information.
</p>
+ </subsection>
+
+ <subsection name="Get an artifact.">
+ <p>The getResource( Artifact artifact ) operation provides a simple
+ protocol independent method to get a concrete url to a resource. The
+ actual url returned to the client is a function of the repository
+ implementation established at runtime.</p>
+ <source>
+ /**
+ * Get a resource url relative to the supplied artifact.
+ *
+ * @param artifact the artifact describing the resource
+ * @return the resource url
+ */
+ URL getResource( Artifact artifact ) throws RepositoryException;</source>
+
+ </subsection>
+
+ <subsection name="Artifact Attribute Retrival.">
+ <p>The getAttributes operation provides support for
+ the retrival of a set of attributes corresponding to
+ metadata about an artifact. This information is used
+ to construct higher level objecets such as classloaders
+ based on dependencies declaring in metadata.</p>
+ <source>
+ /**
+ * Return the metadata of an artifact as attributes.
+ * @param artifact the artifact
+ * @return the attributes resolved relative to the artifact address
+ * @exception RepositoryException if an error occurs while resolving
+ * artifact metadata attributes
+ */
+ Attributes getAttributes( Artifact artifact )
+ throws RepositoryException;</source>
+ </subsection>
+
+ <subsection name="Classloader creation.">
+ <p>Using matadata associated with an artifact, the repository
+ can construct a component classloader tree that can be used
+ in the subsequent deployment of compoents and applications.</p>
+ <source>
+ /**
+ * Creates a ClassLoader chain returning the lowest ClassLoader containing
+ * the jar artifact in the loader's path. The dependencies of the argument
+ * artifact jar and an api, spi and implementation attribute on the jar and
+ * its dependencies are used to construct the ClassLoaders.
+ *
+ * @param artifact the implementation artifact
+ * @return the lowest ClassLoader in a chain
+ * @throws RepositoryException if there is a problem caching and accessing
+ * repository artifacts and reading their attributes.
+ */
+ ClassLoader getClassLoader( Artifact artifact )
+ throws RepositoryException;</source>
+ </subsection>
+
+ <subsection name="Classloader creation (using a parent).">
+ <p>This function is equivalent to the basic getClassloader
+ operation except that it allows the declaration of the parent
+ classloader to be used when constructing the new classloader
+ chain.</p>
+ <source>
+ /**
+ * Creates a ClassLoader chain returning the lowest ClassLoader containing
+ * the jar artifact in the loader's path. The dependencies of the argument
+ * artifact jar and an api, spi and implementation attribute on the jar and
+ * its dependencies are used to construct the ClassLoaders.
+ *
+ * @param parent the parent classloader
+ * @param artifact the implementation artifact
+ * @return the lowest ClassLoader in a chain
+ * @throws RepositoryException if there is a problem caching and accessing
+ * repository artifacts and reading their attributes.
+ */
+ ClassLoader getClassLoader( ClassLoader parent, Artifact artifact )
+ throws RepositoryException ;</source>
</subsection>
</section>
</body>
1.4 +0 -8 avalon-sandbox/repository/site/xdocs/start/install/cvs.xml
Index: cvs.xml
===================================================================
RCS file: /home/cvs/avalon-sandbox/repository/site/xdocs/start/install/cvs.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- cvs.xml 24 Nov 2003 05:19:53 -0000 1.3
+++ cvs.xml 30 Nov 2003 08:49:32 -0000 1.4
@@ -100,14 +100,6 @@
$ cd /avalon-sandbox/repository
$ maven avalon:setup
-The test suite in the repo package assumes that the sandbox/kernel
-suboroject has been build and installed. To do this you need to
-do the following:
-
- $ cd ../kernel/impl
- $ maven jar:install
- $ cd ../../repository
-
The following goal builds the repository project:
$ maven avalon:build
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]