Author: mcconnell
Date: Mon Jun 21 08:02:11 2004
New Revision: 21542
Modified:
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/artifact.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/declare.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/plugin.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/reactor.xml
Log:
management task docs
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/artifact.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/artifact.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/artifact.xml Mon Jun 21 08:02:11 2004
@@ -7,12 +7,93 @@
</properties>
<body>
- <section name="Artifact Task">
+ <section name="Artifact Task">
+
<p>
+ The artifact task generates a descriptor for a plugin compliant with
+ the Avalon Repository specification. This descriptor is a property file
+ containing factory information and staged classloader description.
+ Classpath references will be group relative to API, SPI and IMPL
+ runtime dependencies.
</p>
+
<source><![CDATA[
- <x:artifact/>
+<x:artifact/>
]]></source>
+<pre>package:
+[x:artifact] Creating meta directive
+</pre>
+
+ <p><i>Sample artifact descriptor:</i></p>
+
+<pre>
+#
+# Meta classifier.
+#
+meta.domain = avalon
+meta.version = 1.1
+
+#
+# Artifact descriptor.
+#
+avalon.artifact.group = avalon/merlin
+avalon.artifact.name = avalon-merlin-impl
+avalon.artifact.version = 3.3.0
+avalon.artifact.signature = 20040621.134857
+
+#
+# Factory classname.
+#
+avalon.artifact.factory = org.apache.avalon.merlin.impl.DefaultFactory
+
+#
+# API dependencies.
+#
+avalon.artifact.dependency.api.0 = artifact:jar:avalon/framework/avalon-framework-api#4.2.1
+avalon.artifact.dependency.api.1 = artifact:jar:avalon/util/avalon-util-lifecycle#1.1.1
+
+#
+# SPI dependencies.
+#
+avalon.artifact.dependency.spi.0 = artifact:jar:avalon/util/avalon-util-extension-api#1.2.0
+avalon.artifact.dependency.spi.1 = artifact:jar:avalon/merlin/avalon-merlin-api#3.3.0
+avalon.artifact.dependency.spi.2 = artifact:jar:avalon/composition/avalon-composition-api#2.0.0
+avalon.artifact.dependency.spi.3 = artifact:jar:avalon/repository/avalon-repository-api#2.0.0
+avalon.artifact.dependency.spi.4 = artifact:jar:avalon/logging/avalon-logging-api#1.0.0
+avalon.artifact.dependency.spi.5 = artifact:jar:avalon/meta/avalon-meta-api#1.4.0
+avalon.artifact.dependency.spi.6 = artifact:jar:avalon/meta/avalon-meta-spi#1.4.0
+avalon.artifact.dependency.spi.7 = artifact:jar:avalon/repository/avalon-repository-spi#2.0.0
+avalon.artifact.dependency.spi.8 = artifact:jar:avalon/logging/avalon-logging-spi#1.0.0
+avalon.artifact.dependency.spi.9 = artifact:jar:avalon/composition/avalon-composition-spi#2.0.0
+
+#
+# Implementation dependencies.
+#
+avalon.artifact.dependency.0 = artifact:jar:avalon/composition/avalon-composition-impl#2.0.1
+avalon.artifact.dependency.1 = artifact:jar:avalon/repository/avalon-repository-main#2.0.0
+avalon.artifact.dependency.2 = artifact:jar:avalon/repository/avalon-repository-util#2.0.0
+avalon.artifact.dependency.3 = artifact:jar:avalon/util/avalon-util-exception#1.0.0
+avalon.artifact.dependency.4 = artifact:jar:avalon/util/avalon-util-env#1.1.1
+avalon.artifact.dependency.5 = artifact:jar:avalon/util/avalon-util-i18n#1.0.0
+avalon.artifact.dependency.6 = artifact:jar:avalon/util/avalon-util-criteria#1.1.0
+avalon.artifact.dependency.7 = artifact:jar:avalon/util/avalon-util-defaults#1.2.1
+avalon.artifact.dependency.8 = artifact:jar:avalon/meta/avalon-meta-impl#1.4.0
+avalon.artifact.dependency.9 = artifact:jar:avalon/util/avalon-util-configuration#1.0.0
+avalon.artifact.dependency.10 = artifact:jar:avalon/framework/avalon-framework-impl#4.2.1
+avalon.artifact.dependency.11 = artifact:jar:avalon/framework/avalon-framework-legacy#4.2.1
+avalon.artifact.dependency.12 = artifact:jar:avalon/logkit/avalon-logkit#2.0.0
+avalon.artifact.dependency.13 = artifact:jar:log4j/log4j#1.2.8
+avalon.artifact.dependency.14 = artifact:jar:servletapi/servletapi#2.3
+avalon.artifact.dependency.15 = artifact:jar:avalon/tools/mailapi#1.3.1
+avalon.artifact.dependency.16 = artifact:jar:avalon/tools/jms#1.1
+avalon.artifact.dependency.17 = artifact:jar:avalon/util/avalon-util-extension-impl#1.2.0
+avalon.artifact.dependency.18 = artifact:jar:avalon/logging/avalon-logging-impl#1.0.0
+
+#
+# EOF.
+#
+
+</pre>
</section>
</body>
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/declare.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/declare.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/declare.xml Mon Jun 21 08:02:11 2004
@@ -9,10 +9,62 @@
<body>
<section name="Declare Task">
<p>
+ The declare task generates meta data about a plugin. This information
+ is used by the <a href="plugin.html">plugin</a> task to load and install
+ tasks and project listeners. The classpath is automatically generated from
+ the plugin descriptor using the RUNTIME policy combhined with the deliverable
+ jar generated by the project.
</p>
<source><![CDATA[
- <x:declare/>
+<x:declare/>
]]></source>
+
+<pre>build:
+[x:declare] creating plugin declaration
+ [mkdir] Created dir: F:\dev\avalon\runtime\meta\tools\target\deliverables\plugins</pre>
+
+ <p>
+ An example of the plugin meta data generated by the prepare
+ task is shown below.
+ </p>
+
+<pre><![CDATA[
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<plugin>
+ <info>
+ <name>avalon-meta-tools</name>
+ <group>avalon/meta</group>
+ <version>1.4.0</version>
+ <type>plugin</type>
+ </info>
+ <tasks>
+ <taskdef name="meta" class="org.apache.avalon.meta.info.ant.MetaTask"/>
+ </tasks>
+ <listeners>
+ <listener class="org.apache.avalon.meta.info.ant.MetaBuildListener"/>
+ </listeners>
+ <classpath>
+ <artifact>jar:avalon/meta/avalon-meta-impl#1.4.0</artifact>
+ <artifact>jar:avalon/meta/avalon-meta-spi#1.4.0</artifact>
+ <artifact>jar:avalon/meta/avalon-meta-api#1.4.0</artifact>
+ <artifact>jar:avalon/framework/avalon-framework-api#4.2.1</artifact>
+ <artifact>jar:avalon/util/avalon-util-i18n#1.0.0</artifact>
+ <artifact>jar:avalon/util/avalon-util-configuration#1.0.0</artifact>
+ <artifact>jar:avalon/framework/avalon-framework-impl#4.2.1</artifact>
+ <artifact>jar:avalon/framework/avalon-framework-legacy#4.2.1</artifact>
+ <artifact>jar:avalon/logkit/avalon-logkit#2.0.0</artifact>
+ <artifact>jar:log4j/log4j#1.2.8</artifact>
+ <artifact>jar:servletapi/servletapi#2.3</artifact>
+ <artifact>jar:avalon/tools/mailapi#1.3.1</artifact>
+ <artifact>jar:avalon/tools/jms#1.1</artifact>
+ <artifact>jar:qdox/qdox#1.3</artifact>
+ <artifact>jar:avalon/meta/avalon-meta-tools#1.4.0</artifact>
+ </classpath>
+</plugin>
+
+]]></pre>
+
</section>
</body>
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/plugin.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/plugin.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/plugin.xml Mon Jun 21 08:02:11 2004
@@ -7,7 +7,8 @@
</properties>
<body>
- <section name="Plugin Task">
+ <section name="Plugin Task">
+
<p>
The plugin task is to some extent an internal magic task. During
initilization of a magic project definition, any plugins declared under
@@ -15,58 +16,26 @@
the plugin task. However - the plugin task can be used outside of the
formal project structural definition.
</p>
+
<p>
The plugin task locates plugin meta-data, and from that data, creates
a classloader, loads the pluging from the repository, and declares to ant
any tasks that the plugin declares. In addition, any listeners declared
by the plugin meta are registered with the current project.
</p>
+
<source><![CDATA[
<x:plugin artifact="plugin:avalon/meta/avalon-meta-tools#1.4.0"/>
]]></source>
- <p>
- An example of the plugins meta-data generated by the
- <a href="declare.html">declare</a> and used by the plugin task
- to construct the plugin classloader, tasks and listeners is
- shown below.
- </p>
-<source><![CDATA[
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<pre>plugin:
+ [plugin] Install "plugin:avalon/meta/avalon-meta-tools"
+ [plugin] Task "plugin:avalon/meta/avalon-meta-tools:meta"</pre>
-<plugin>
- <info>
- <name>avalon-meta-tools</name>
- <group>avalon/meta</group>
- <version>1.4.0</version>
- <type>plugin</type>
- </info>
- <tasks>
- <taskdef name="meta" class="org.apache.avalon.meta.info.ant.MetaTask"/>
- </tasks>
- <listeners>
- <listener class="org.apache.avalon.meta.info.ant.MetaBuildListener"/>
- </listeners>
- <classpath>
- <jar>avalon/meta/avalon-meta-impl#1.4.0</jar>
- <jar>avalon/meta/avalon-meta-spi#1.4.0</jar>
- <jar>avalon/meta/avalon-meta-api#1.4.0</jar>
- <jar>avalon/framework/avalon-framework-api#4.2.1</jar>
- <jar>avalon/util/avalon-util-i18n#1.0.0</jar>
- <jar>avalon/util/avalon-util-configuration#1.0.0</jar>
- <jar>avalon/framework/avalon-framework-impl#4.2.1</jar>
- <jar>avalon/framework/avalon-framework-legacy#4.2.1</jar>
- <jar>avalon/logkit/avalon-logkit#2.0.0</jar>
- <jar>log4j/log4j#1.2.8</jar>
- <jar>servletapi/servletapi#2.3</jar>
- <jar>avalon/tools/mailapi#1.3.1</jar>
- <jar>avalon/tools/jms#1.1</jar>
- <jar>qdox/qdox#1.3</jar>
- <jar>avalon/meta/avalon-meta-tools#1.4.0</jar>
- </classpath>
-</plugin>
-
-]]></source>
+ <p>
+ The plugin meta data read by the plugin task is described under
+ the <a href="declare.html">declare</a> task.
+ </p>
</section>
</body>
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/reactor.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/reactor.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/management/reactor.xml Mon Jun 21 08:02:11 2004
@@ -9,11 +9,90 @@
<body>
<section name="Reactor Task">
<p>
+ The reactor task invokes an ant target on the set of project defintions
+ that declare base directories within the basedir of the reactor. This
+ allows for the building of groups of projects based on the directory
+ structure. The sequence of the project build is automatically resolved
+ relative to the dependencies defined by the respective projects.
</p>
+ <p><i>Normal usage:</i></p>
+
<source><![CDATA[
<x:reactor/>
]]></source>
-
+
+ <p><i>Supplying an explicit build target:</i></p>
+
+<source><![CDATA[
+ <x:reactor target="install"/>
+]]></source>
+
+ <p><i>
+ Example output when invoking the reactor from the root
+ avalon directory:</i></p>
+
+<pre>
+default:
+[x:reactor] Preparing build sequence.
+------------------------------------------------------------------------
+[avalon/util/avalon-util-criteria]
+[avalon/logkit/avalon-logkit]
+[avalon/util/avalon-util-env]
+[avalon/util/avalon-util-defaults]
+[avalon/util/avalon-util-i18n]
+[avalon/util/avalon-util-exception]
+[avalon/repository/avalon-repository-api]
+[avalon/repository/avalon-repository-util]
+[avalon/repository/avalon-repository-spi]
+[avalon/repository/avalon-repository-main]
+[avalon/framework/avalon-framework-api]
+[avalon/framework/avalon-framework-legacy]
+[avalon/framework/avalon-framework-impl]
+[avalon/util/avalon-util-configuration]
+[avalon/meta/avalon-meta-api]
+[avalon/meta/avalon-meta-spi]
+[avalon/meta/avalon-meta-impl]
+[avalon/meta/avalon-meta-tools]
+[avalon/util/avalon-util-lifecycle]
+[avalon/test/avalon-test-playground]
+[avalon/test/avalon-test-components]
+[avalon/repository/avalon-repository-impl]
+[avalon/repository/avalon-repository-test]
+[avalon/logging/avalon-logging-api]
+[avalon/logging/avalon-logging-spi]
+[avalon/logging/avalon-logging-impl]
+[avalon/logging/avalon-logging-logkit-api]
+[avalon/logging/avalon-logging-logkit-datagram]
+[avalon/logging/avalon-logging-logkit-socket]
+[avalon/logging/avalon-logging-logkit-syslog]
+[avalon/logging/avalon-logging-log4j]
+[avalon/logging/avalon-logging-logkit-impl]
+[avalon/logging/avalon-logging-test]
+[avalon/test/avalon-test-teste]
+[avalon/test/avalon-test-testd]
+[avalon/test/avalon-test-testc]
+[avalon/test/avalon-test-testb]
+[avalon/test/avalon-test-testa]
+[avalon/test/avalon-test-includes]
+[avalon/test/avalon-test-dynamics]
+[avalon/util/avalon-util-extension-api]
+[avalon/util/avalon-util-extension-impl]
+[avalon/composition/avalon-composition-api]
+[avalon/composition/avalon-composition-spi]
+[avalon/composition/avalon-composition-impl]
+[avalon/activation/avalon-activation-api]
+[avalon/activation/avalon-activation-impl]
+[avalon/merlin/avalon-merlin-api]
+[avalon/merlin/avalon-merlin-impl]
+[avalon/merlin/avalon-merlin-cli]
+[avalon/runtime]
+[avalon/site]
+[avalon/repository/avalon-repository-cli]
+[avalon/tools/avalon-tools-magic]
+
+....
+
+</pre>
</section>
</body>
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.