Skip to Content.
Sympa Menu

notify-dpml - svn commit: r1500 - in development/main/central/site/src/docs: guide/quick/hello guide/transit guide/transit/plugins guide/transit/plugins/cli guide/transit/plugins/control guide/transit/plugins/simple products/magic/antlib products/magic/plugins/checkstyle products/magic/tasks products/transit/overview

notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

Chronological Thread  
  • From: mcconnell AT netcompartner.com
  • To: notify-dpml AT lists.ibiblio.org
  • Subject: svn commit: r1500 - in development/main/central/site/src/docs: guide/quick/hello guide/transit guide/transit/plugins guide/transit/plugins/cli guide/transit/plugins/control guide/transit/plugins/simple products/magic/antlib products/magic/plugins/checkstyle products/magic/tasks products/transit/overview
  • Date: Sun, 16 Jan 2005 18:50:00 +0100

Author: mcconnell
Date: Sun Jan 16 18:49:59 2005
New Revision: 1500

Modified:
development/main/central/site/src/docs/guide/quick/hello/internal.xml
development/main/central/site/src/docs/guide/transit/plugins.xml
development/main/central/site/src/docs/guide/transit/plugins/cli/index.xml

development/main/central/site/src/docs/guide/transit/plugins/control/index.xml
development/main/central/site/src/docs/guide/transit/plugins/index.xml

development/main/central/site/src/docs/guide/transit/plugins/simple/index.xml
development/main/central/site/src/docs/products/magic/antlib/plugin.xml

development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
development/main/central/site/src/docs/products/magic/tasks/plugin.xml
development/main/central/site/src/docs/products/magic/tasks/reactor.xml

development/main/central/site/src/docs/products/transit/overview/classloading.xml

development/main/central/site/src/docs/products/transit/overview/plugins.xml
Log:
Update docs to reflect change from "meta" to "plugin" as the type name for
plugin descriptors.

Modified:
development/main/central/site/src/docs/guide/quick/hello/internal.xml
==============================================================================
--- development/main/central/site/src/docs/guide/quick/hello/internal.xml
(original)
+++ development/main/central/site/src/docs/guide/quick/hello/internal.xml
Sun Jan 16 18:49:59 2005
@@ -62,8 +62,8 @@
--------------------------------------------------------------------------
[INFO ] (dpml): Metro Context
--------------------------------------------------------------------------
-${dpml.metro.system.artifact} :
artifact:meta:dpml/system/dpml-system-impl#SNAPSHOT
-${dpml.metro.main.artifact} :
artifact:meta:dpml/composition/dpml-composition-impl#SNAPSHOT
+${dpml.metro.system.artifact} :
artifact:plugin:dpml/system/dpml-system-impl#SNAPSHOT
+${dpml.metro.main.artifact} :
artifact:plugin:dpml/composition/dpml-composition-impl#SNAPSHOT
--------------------------------------------------------------------------
[INFO ] (tutorial.hello): Hello World!
]]></source>
@@ -188,8 +188,8 @@
<source><![CDATA[
$ metro -execute target\classes -debug

-[DEBUG ] (dpml) : building:
artifact:meta:dpml/logging/dpml-logging-logkit-impl#SNAPSHOT
-[DEBUG ] (dpml) : using local copy:
artifact:meta:dpml/logging/dpml-logging-logkit-impl#SNAPSHOT
+[DEBUG ] (dpml) : building:
artifact:plugin:dpml/logging/dpml-logging-logkit-impl#SNAPSHOT
+[DEBUG ] (dpml) : using local copy:
artifact:plugin:dpml/logging/dpml-logging-logkit-impl#SNAPSHOT
[DEBUG ] (dpml) : building classload stack
[DEBUG ] (dpml) : spi classloader size: 3
[DEBUG ] (dpml) : impl classloader size: 9
@@ -225,7 +225,7 @@
--------------------------------------------------------------------------
[DEBUG ] (dpml): System Context
--------------------------------------------------------------------------
-${dpml.system.logging.artifact} :
artifact:meta:dpml/logging/dpml-logging-logkit-impl#SNAPSHOT
+${dpml.system.logging.artifact} :
artifact:plugin:dpml/logging/dpml-logging-logkit-impl#SNAPSHOT
${dpml.system.logging.config} :
${dpml.system.home} : C:\system\dpml
${dpml.system.anchor} : C:\system\dpml\lib
@@ -234,9 +234,9 @@
--------------------------------------------------------------------------
[DEBUG ] (dpml) : system context initialization
[DEBUG ] (dpml): system context established
-[DEBUG ] (dpml): loading plugin:
[artifact:meta:dpml/composition/dpml-composition-impl#SNAPSHOT].
-[DEBUG ] (dpml) : building:
artifact:meta:dpml/composition/dpml-composition-impl#SNAPSHOT
-[DEBUG ] (dpml) : using local copy:
artifact:meta:dpml/composition/dpml-composition-impl#SNAPSHOT
+[DEBUG ] (dpml): loading plugin:
[artifact:plugin:dpml/composition/dpml-composition-impl#SNAPSHOT].
+[DEBUG ] (dpml) : building:
artifact:plugin:dpml/composition/dpml-composition-impl#SNAPSHOT
+[DEBUG ] (dpml) : using local copy:
artifact:plugin:dpml/composition/dpml-composition-impl#SNAPSHOT
[DEBUG ] (dpml) : building classload stack
[DEBUG ] (dpml) : api classloader size: 11
[DEBUG ] (dpml) : using local copy:
artifact:jar:dpml/extension/dpml-extension-api#SNAPSHOT
@@ -273,14 +273,14 @@
${dpml.composition.kernel} : null
${dpml.composition.secure} : false
${dpml.composition.audit} : false
-${dpml.composition.runtime} :
artifact:meta:dpml/activation/dpml-activation-impl#SNAPSHOT
+${dpml.composition.runtime} :
artifact:plugin:dpml/activation/dpml-activation-impl#SNAPSHOT
${dpml.composition.timeout} : 1000
${dpml.composition.deployment} :
file:/C:/dev/dpml/planet/tutorials/hello/target/classes/
${dpml.composition.override} : null
--------------------------------------------------------------------------
[DEBUG ] (dpml): composition context established
-[DEBUG ] (dpml) : building:
artifact:meta:dpml/activation/dpml-activation-impl#SNAPSHOT
-[DEBUG ] (dpml) : using local copy:
artifact:meta:dpml/activation/dpml-activation-impl#SNAPSHOT
+[DEBUG ] (dpml) : building:
artifact:plugin:dpml/activation/dpml-activation-impl#SNAPSHOT
+[DEBUG ] (dpml) : using local copy:
artifact:plugin:dpml/activation/dpml-activation-impl#SNAPSHOT
[DEBUG ] (dpml) : building classload stack
[DEBUG ] (dpml) : api classloader size: 14
[DEBUG ] (dpml) : using local copy:
artifact:jar:dpml/activation/dpml-activation-api#SNAPSHOT
@@ -324,8 +324,8 @@
[DEBUG ] (metro.logging): adding category [tutorial.hello]
[DEBUG ] (dpml): Metro Context
--------------------------------------------------------------------------
-${dpml.metro.system.artifact} :
artifact:meta:dpml/system/dpml-system-impl#SNAPSHOT
-${dpml.metro.main.artifact} :
artifact:meta:dpml/composition/dpml-composition-impl#SNAPSHOT
+${dpml.metro.system.artifact} :
artifact:plugin:dpml/system/dpml-system-impl#SNAPSHOT
+${dpml.metro.main.artifact} :
artifact:plugin:dpml/composition/dpml-composition-impl#SNAPSHOT
--------------------------------------------------------------------------
[DEBUG ] (): initiating assembly
[DEBUG ] (): state: assembly
@@ -335,8 +335,8 @@
[DEBUG ] (): state: deployment
[DEBUG ] (): commissioning container [tutorial]
[DEBUG ] (tutorial): commissioning component [hello]
-[DEBUG ] (dpml) : building:
artifact:meta:dpml/activation/dpml-activation-metro-provider#SNAPSHOT
-[DEBUG ] (dpml) : using local copy:
artifact:meta:dpml/activation/dpml-activation-metro-provider#SNAPSHOT
+[DEBUG ] (dpml) : building:
artifact:plugin:dpml/activation/dpml-activation-metro-provider#SNAPSHOT
+[DEBUG ] (dpml) : using local copy:
artifact:plugin:dpml/activation/dpml-activation-metro-provider#SNAPSHOT
[DEBUG ] (dpml) : building classload stack
[DEBUG ] (dpml) : api classloader size: 15
[DEBUG ] (dpml) : impl classloader size: 3

Modified: development/main/central/site/src/docs/guide/transit/plugins.xml
==============================================================================
--- development/main/central/site/src/docs/guide/transit/plugins.xml
(original)
+++ development/main/central/site/src/docs/guide/transit/plugins.xml Sun
Jan 16 18:49:59 2005
@@ -38,7 +38,7 @@
<source>
Repository repository = new StandardLoader();
ClassLoader parent = getClass().getClassLoader();
- URI uri = new URI( "artifact:meta:dpml/examples/hello/hello-world#1.0.0" );
+ URI uri = new URI( "artifact:plugin:dpml/examples/hello/hello-world#1.0.0"
);
Object[] args = new Object[] { "Hello, World!" };
Object plugin = repository.getPlugin( parent, uri, args );
</source>

Modified:
development/main/central/site/src/docs/guide/transit/plugins/cli/index.xml
==============================================================================
---
development/main/central/site/src/docs/guide/transit/plugins/cli/index.xml
(original)
+++
development/main/central/site/src/docs/guide/transit/plugins/cli/index.xml
Sun Jan 16 18:49:59 2005
@@ -131,7 +131,7 @@
we are declaring a message using the -message option that we added
to the our plugin.
</p>

- <pre>$ transit -load
artifact:meta:dpml/tutorial/dpml-transit-tutorial-plugin-cli -message
Hello</pre>
+ <pre>$ transit -load
artifact:plugin:dpml/tutorial/dpml-transit-tutorial-plugin-cli -message
Hello</pre>

<p>
The result of running the plugin is show below:

Modified:
development/main/central/site/src/docs/guide/transit/plugins/control/index.xml
==============================================================================
---
development/main/central/site/src/docs/guide/transit/plugins/control/index.xml
(original)
+++
development/main/central/site/src/docs/guide/transit/plugins/control/index.xml
Sun Jan 16 18:49:59 2005
@@ -64,7 +64,7 @@
*/
public ControllerPlugin( String[] args ) throws Exception
{
- String spec =
"artifact:meta:dpml/tutorial/dpml-transit-tutorial-plugin-cli";
+ String spec =
"artifact:plugin:dpml/tutorial/dpml-transit-tutorial-plugin-cli";
URI uri = new URI( spec );
Repository repository = new StandardLoader();
ClassLoader classloader = getClass().getClassLoader();
@@ -82,7 +82,7 @@
Execution of the above example is shown below.
</p>

-<pre>$ transit -load
artifact:meta:dpml/tutorial/dpml-transit-tutorial-plugin-controller -message
"Good Morning!"</pre>
+<pre>$ transit -load
artifact:plugin:dpml/tutorial/dpml-transit-tutorial-plugin-controller
-message "Good Morning!"</pre>

<p>
Output of the above is:

Modified:
development/main/central/site/src/docs/guide/transit/plugins/index.xml
==============================================================================
--- development/main/central/site/src/docs/guide/transit/plugins/index.xml
(original)
+++ development/main/central/site/src/docs/guide/transit/plugins/index.xml
Sun Jan 16 18:49:59 2005
@@ -39,7 +39,7 @@
<source>
Repository repository = new StandardLoader();
ClassLoader parent = getClass().getClassLoader();
- URI uri = new URI( "artifact:meta:dpml/examples/hello/hello-world#1.0.0" );
+ URI uri = new URI( "artifact:plugin:dpml/examples/hello/hello-world#1.0.0"
);
Object[] args = new Object[] { "Hello, World!" };
Object plugin = repository.getPlugin( parent, uri, args );
</source>

Modified:
development/main/central/site/src/docs/guide/transit/plugins/simple/index.xml
==============================================================================
---
development/main/central/site/src/docs/guide/transit/plugins/simple/index.xml
(original)
+++
development/main/central/site/src/docs/guide/transit/plugins/simple/index.xml
Sun Jan 16 18:49:59 2005
@@ -90,9 +90,9 @@

<p>
After executing the build (using ant) the following plugin
descriptor
- is created under the ${basedir}/target/deliverables/metas
directory. It
+ is created under the ${basedir}/target/deliverables/plugins
directory. It
contains the name of the plugin class and the names of the jar
files
- needed to construct the plugin. The meta data file is itself
registered
+ needed to construct the plugin. The plugin data file is itself
registered
in your local cache directory and can be referenced using the
Transit
artifact protocol.
</p>
@@ -139,7 +139,7 @@
the Transit CLI utility to run the plugin.
</p>

- <pre>$ transit -load
artifact:meta:dpml/tutorial/dpml-transit-tutorial-plugin-simple Hello.</pre>
+ <pre>$ transit -load
artifact:plugin:dpml/tutorial/dpml-transit-tutorial-plugin-simple Hello.</pre>

<p>
The above command simply instructs Transit to load the plugin
described by
@@ -156,7 +156,7 @@
<p>
In the <a href="../cli/index.html">next tutorial</a> we do some
implemetation
changes involving the addition of cli handling using the
commons-cli package and
- look at the impact on out plugin metadata.
+ look at the impact on our plugin metadata.
</p>

</subsection>

Modified:
development/main/central/site/src/docs/products/magic/antlib/plugin.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/antlib/plugin.xml
(original)
+++ development/main/central/site/src/docs/products/magic/antlib/plugin.xml
Sun Jan 16 18:49:59 2005
@@ -18,7 +18,7 @@
<p><i>Example of a request to load an antlib.</i></p>

<source><![CDATA[
- <magic:plugin uri="artifact:meta:dpml/magic/dpml-magic-core#SNAPSHOT"/>
+ <magic:plugin uri="artifact:plugin:dpml/magic/dpml-magic-core#SNAPSHOT"/>
]]></source>

<p><i>Example of a request to load and register a single task
definition.</i></p>

Modified:
development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
(original)
+++
development/main/central/site/src/docs/products/magic/plugins/checkstyle/index.xml
Sun Jan 16 18:49:59 2005
@@ -49,7 +49,7 @@
</p>

<pre>init:
- [x:init] loading: artifact:meta:dpml/magic/dpml-magic-checkstyle#SNAPSHOT
+ [x:init] loading:
artifact:plugin:dpml/magic/dpml-magic-checkstyle#SNAPSHOT

prepare:


Modified:
development/main/central/site/src/docs/products/magic/tasks/plugin.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/tasks/plugin.xml
(original)
+++ development/main/central/site/src/docs/products/magic/tasks/plugin.xml
Sun Jan 16 18:49:59 2005
@@ -25,12 +25,12 @@
</p>

<source><![CDATA[
-<x:plugin artifact="plugin:avalon/meta/avalon-meta-tools#1.4.0"/>
+<magic:plugin uri="artifact:plugin:dpml/metro/tools/dpml-meta-tools#1.4.0"/>
]]></source>

<pre>plugin:
- [plugin] Install "plugin:avalon/meta/avalon-meta-tools"
- [plugin] Task "plugin:avalon/meta/avalon-meta-tools:meta"</pre>
+ [plugin] Install "artifact:plugin:dpml/metro/tools/dpml-meta-tools#1.4.0"
+ [plugin] Task "plugin:dpml/metro/tools/dpml-meta-tools:meta"</pre>

<p>
The plugin meta data read by the plugin task is described under

Modified:
development/main/central/site/src/docs/products/magic/tasks/reactor.xml
==============================================================================
--- development/main/central/site/src/docs/products/magic/tasks/reactor.xml
(original)
+++ development/main/central/site/src/docs/products/magic/tasks/reactor.xml
Sun Jan 16 18:49:59 2005
@@ -130,7 +130,7 @@
[artifact:jar:dpml/test/dpml-magic-example#SNAPSHOT]
[artifact:jar:dpml/magic/dpml-magic-bar#SNAPSHOT]
[artifact:jar:dpml/magic/dpml-magic-publish#SNAPSHOT]
-[artifact:meta:dpml/test/dpml-magic-test#SNAPSHOT]
+[artifact:plugin:dpml/test/dpml-magic-test#SNAPSHOT]
[artifact:jar:dpml/metro/tools/dpml-metro-unit#SNAPSHOT]
[artifact:jar:dpml/central/dpml-tutorial-hello]
[artifact:block:dpml/http/dpml-http-hash-basic#1.0]

Modified:
development/main/central/site/src/docs/products/transit/overview/classloading.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/overview/classloading.xml
(original)
+++
development/main/central/site/src/docs/products/transit/overview/classloading.xml
Sun Jan 16 18:49:59 2005
@@ -34,9 +34,9 @@
<p>
Layered above the Transit artifact protocol handler is a system that
provides support for the creation of classloaders. Classloaders are
- described under a 'meta' file which is basically a list of dependent
+ described under a 'plugin' file which is basically a list of
dependent
artifact uris and their location in the classloader hierarchy. The
- meta file is itself normally referenced as an artifact which means
+ plugin file is itself normally referenced as an artifact which means
that the list is itself versioned, named, associated with a group,
and
dynamically resolvable.
</p>
@@ -46,15 +46,15 @@
<code>@METRO-PLUGIN-URI@</code>

<p>
- The meta file declares api, spi and implementation jar files in
- the form of artifact uris. Transit uses this infomation to
+ The plugin file declares api, spi and implementation jar files in
+ the form of artifact uris. Transit uses this information to
construct a classloader chain.
</p>

<img src="/images/transit/chain.png"/>

<p>
- Meta files use a simple property file format to declare features of
+ Plugin files use a simple property file format to declare features of
of the classloader, including information used when resolving
plugins.
This information is normally created automatically using the
<a href="/products/magic/tasks/export.html">Export Task</a> from the
@@ -62,14 +62,14 @@
</p>

<p>
- The following code fragment demonstrates the relativly simple
process of
+ The following code fragment demonstrates the relatively simple
process of
creating a new classloader using Transit.
</p>

<source>
Repository repository = new StandardLoader();
ClassLoader parent = getClass().getClassLoader();
-URI uri = new URI( "artifact:meta:dpml/examples/hello/hello-world#1.0.0" );
+URI uri = new URI( "artifact:plugin:dpml/examples/hello/hello-world#1.0.0" );
ClassLoader classloader = repository.getClassloader( parent, uri );
</source>


Modified:
development/main/central/site/src/docs/products/transit/overview/plugins.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/overview/plugins.xml
(original)
+++
development/main/central/site/src/docs/products/transit/overview/plugins.xml
Sun Jan 16 18:49:59 2005
@@ -11,19 +11,19 @@
<section name="Plugin Management">

<p>
- In addition to the structural classloader information - the meta file
- may contain the declaration of a main class or an antlib resource and
- namespace. The antlib information is a special case used within the
+ In addition to the structural classloader information - the plugin
file
+ may contain the declaration of a main class or an internal resource
and
+ namespace. The resource path information is a special case used
within the
Magic build system to support dynamic task loading. The main class
declaration is the entry point for classic plugin class loading
relative
- to the established classloader.
+ to an established classloader.
</p>

<p>
The Transit repository service provides support for class creation
and
object instantiation. Class creation is typically used by
applications
that handle a particular semantics concerning a plugin model whereas
- the Tranit object instantiation provides a simple but flexible model
+ the Transit object instantiation provides a simple but flexible model
suitable for control over selectable sub-system strategies (e.g. the
loading of a logging system or application runtime).
</p>
@@ -32,6 +32,7 @@
The following code fragments demonstrates the creation of a plugin
instance
using Transit's standard plugin loader.
</p>
+
<p>
We create a API project called hello-api, which contains the
following
interface.
@@ -77,7 +78,7 @@
<source>
Repository repository = new StandardLoader();
ClassLoader parent = getClass().getClassLoader();
- URI uri = new URI( "artifact:meta:mycompany/thisproject/hello-impl#1.4.1"
);
+ URI uri = new URI(
"artifact:plugin:mycompany/thisproject/hello-impl#1.4.1" );
Object[] args = new Object[] { "Hello, World!" };
Object plugin = repository.getPlugin( parent, uri, args );
if( plugin instanceof Hello )
@@ -94,7 +95,7 @@
m_hello.announce();
</source>
<p>
- For this to work, you will also need to create the meta information
+ For this to work, you will also need to create the plugin meta
descriptor. The easiest way is to use the DPML Magic build system,
but it can also be done manually or with other tools. The above
would need a simple descriptor like this;



  • svn commit: r1500 - in development/main/central/site/src/docs: guide/quick/hello guide/transit guide/transit/plugins guide/transit/plugins/cli guide/transit/plugins/control guide/transit/plugins/simple products/magic/antlib products/magic/plugins/checkstyle products/magic/tasks products/transit/overview, mcconnell, 01/16/2005

Archive powered by MHonArc 2.6.24.

Top of Page